@dodopayments/express 0.1.2 → 0.1.4

package/README.md

@@ -18,25 +18,40 @@ npm install @dodopayments/express
 
 ## Quick Start
 
-
 ### 1. Checkout
 
 ```typescript
-import { checkoutHandler } from '@dodopayments/express';
-
-app.get('/api/checkout', checkoutHandler({
-  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
-  returnUrl: process.env.RETURN_URL!,
-  environment: "test_mode",
-  type: "static"
-}))
-
-app.post('/api/checkout', checkoutHandler({
-  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
-  returnUrl: process.env.RETURN_URL!,
-  environment: "test_mode",
-  type: "dynamic"
-}))
+import { checkoutHandler } from "@dodopayments/express";
+
+app.get(
+  "/api/checkout",
+  checkoutHandler({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    type: "static",
+  }),
+);
+
+app.post(
+  "/api/checkout",
+  checkoutHandler({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    type: "dynamic",
+  }),
+);
+
+app.post(
+  "/api/checkout",
+  checkoutHandler({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+    type: "session",
+  }),
+);
 ```
 
 ---
@@ -46,11 +61,13 @@ app.post('/api/checkout', checkoutHandler({
 ```typescript
 import { CustomerPortal } from "@dodopayments/express";
 
-app.get('/api/customer-portal', CustomerPortal({
-  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
-  environment: "test_mode",
-}))
-
+app.get(
+  "/api/customer-portal",
+  CustomerPortal({
+    bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
+    environment: "test_mode",
+  }),
+);
 ```
 
 #### Query Parameters
@@ -68,14 +85,16 @@ Returns 400 if `customer_id` is missing.
 // app/api/webhook/dodo-payments/route.ts
 import { Webhooks } from "@dodopayments/express";
 
-app.post('/api/webhook',
+app.post(
+  "/api/webhook",
   Webhooks({
-  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_SECRET!,
-  onPayload: async (payload) => {
-    // handle the payload
-  },
-  // ... other event handlers for granular control
-}))
+    webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_SECRET!,
+    onPayload: async (payload) => {
+      // handle the payload
+    },
+    // ... other event handlers for granular control
+  }),
+);
 ```
 
 ---
@@ -112,28 +131,36 @@ Here's how you should structure your response:
 
 **If Checkout Route Handler is selected:**
 
-**Purpose**: This handler redirects users to the Dodo Payments checkout page.
+**Purpose**: This handler manages different types of checkout flows. All checkout types (static, dynamic, and sessions) return JSON responses with checkout URLs for programmatic handling.
 
 **Integration**:
-Create two routes in your Express app — one for static (GET) and one for dynamic (POST) checkout.
+Create routes in your Express app for static (GET), dynamic (POST), and checkout sessions (POST).
 
 
 import { checkoutHandler } from '@dodopayments/express';
 
 app.get('/api/checkout', checkoutHandler({
-  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
-  returnUrl: process.env.RETURN_URL!,
-  environment: "test_mode",
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
   type: "static"
 }));
 
 app.post('/api/checkout', checkoutHandler({
-  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
-  returnUrl: process.env.RETURN_URL!,
-  environment: "test_mode",
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
   type: "dynamic"
 }));
 
+// For checkout sessions
+app.post('/api/checkout', checkoutHandler({
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
+  type: "session"
+}));
+
 Config Options:
 
     bearerToken: Your Dodo Payments API key (recommended to be stored in DODO_PAYMENTS_API_KEY env variable).
@@ -142,7 +169,7 @@ Config Options:
 
     environment: "test_mode" or "live_mode"
 
-    type: "static" (GET) or "dynamic" (POST)
+    type: "static" (GET), "dynamic" (POST), or "session" (POST)
 
 GET (static checkout) expects query parameters:
 
@@ -150,12 +177,29 @@ GET (static checkout) expects query parameters:
 
     quantity, customer fields (fullName, email, etc.), and metadata (metadata_*) are optional.
 
+    Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}
+
 POST (dynamic checkout) expects a JSON body with payment details (one-time or subscription). Reference the docs for the full POST schema:
 
     One-time payments: https://docs.dodopayments.com/api-reference/payments/post-payments
 
     Subscriptions: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions
 
+    Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}
+
+POST (checkout sessions) - (Recommended) A more customizable checkout experience:
+
+    Expects a JSON body with product_cart array and customer details.
+
+    One-time payments: https://docs.dodopayments.com/api-reference/payments/post-payments
+
+    Subscriptions: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions
+
+    Required fields for checkout sessions:
+        product_cart (array): Array of products with product_id and quantity
+
+    Returns: {"checkout_url": "https://checkout.dodopayments.com/session/..."}
+
 If Customer Portal Route Handler is selected:
 
 Purpose: This route allows customers to manage their subscriptions via the Dodo Payments portal.
@@ -165,8 +209,8 @@ Integration:
 import { CustomerPortal } from "@dodopayments/express";
 
 app.get('/api/customer-portal', CustomerPortal({
-  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
-  environment: "test_mode",
+  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
+  environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
 }));
 
 Query Parameters:
@@ -186,7 +230,7 @@ Integration:
 import { Webhooks } from "@dodopayments/express";
 
 app.post('/api/webhook', Webhooks({
-  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_SECRET!,
+  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
   onPayload: async (payload) => {
     // Handle generic payload
   },
@@ -223,7 +267,7 @@ You may pass in any of the following handlers:
 
     onDisputeOpened, onDisputeExpired, onDisputeAccepted, onDisputeCancelled, onDisputeChallenged, onDisputeWon, onDisputeLost
 
-    onSubscriptionActive, onSubscriptionOnHold, onSubscriptionRenewed, onSubscriptionPaused, onSubscriptionPlanChanged, onSubscriptionCancelled, onSubscriptionFailed, onSubscriptionExpired
+    onSubscriptionActive, onSubscriptionOnHold, onSubscriptionRenewed, onSubscriptionPlanChanged, onSubscriptionCancelled, onSubscriptionFailed, onSubscriptionExpired
 
     onLicenseKeyCreated
 
@@ -232,12 +276,14 @@ Environment Variable Setup:
 Make sure to define these environment variables in your project:
 
 DODO_PAYMENTS_API_KEY=your-api-key
-RETURN_URL=https://yourapp.com/success
-DODO_PAYMENTS_WEBHOOK_SECRET=your-webhook-secret
+DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
+DODO_PAYMENTS_ENVIRONMENT="test_mode" or "live_mode"
+DODO_PAYMENTS_RETURN_URL=your-return-url
 
 Use these inside your code as:
 
-process.env.DODO_PAYMENTS_API_KEY!
-process.env.DODO_PAYMENTS_WEBHOOK_SECRET!
+process.env.DODO_PAYMENTS_API_KEY
+process.env.DODO_PAYMENTS_WEBHOOK_SECRET
 
-Security Note: Do NOT commit secrets to version control. Use .env files locally and secrets managers in deployment environments (e.g., AWS, Vercel, Heroku, etc.).
+Security Note: Do NOT commit secrets to version control. Use .env files locally and secrets managers in deployment environments (e.g., AWS, Vercel, Heroku, etc.).
+```

package/dist/checkout/checkout.d.ts

@@ -1,3 +1,3 @@
 import type { Request, Response } from "express";
 import { CheckoutHandlerConfig } from "@dodopayments/core/checkout";
-export declare function checkoutHandler(config: CheckoutHandlerConfig): (req: Request, res: Response) => Response<any, Record<string, any>> | Promise<void | Response<any, Record<string, any>>>;
+export declare function checkoutHandler(config: CheckoutHandlerConfig): (req: Request, res: Response) => Response<any, Record<string, any>> | Promise<Response<any, Record<string, any>>>;