> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dodopayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Next.js 适配器

> 使用 @dodopayments/nextjs package 将 Dodo Payments checkout、Customer Portal 和 webhook route handlers 添加到 Next.js App Router 项目。

`@dodopayments/nextjs` package 为您的 Next.js App Router 项目提供三个 route handlers。`Checkout` 返回 checkout URLs，`CustomerPortal` 将客户发送到 Customer Portal，`Webhooks` 验证 webhook events 并将其路由到您的代码。该 package 支持 Next.js 14、15 和 16。

> **[Checkout Handler](#checkout-route-handler)**
>
> 使用 static、dynamic 和 checkout session flows 创建 checkout URLs。

> **[Customer Portal](#customer-portal-route-handler)**
>
> 让客户管理其 subscriptions 和详细信息。

> **[Webhooks](#webhook-route-handler)**
>
> 接收并处理 Dodo Payments webhook events。

## 安装

**1. Install the Package**

在项目根目录运行此命令：

```bash theme={null}
npm install @dodopayments/nextjs
```

该 package 还要求将 Zod 3.25 或 Zod 4 作为 peer dependency。

**2. Set Up Environment Variables**

在项目根目录创建一个 `.env` 文件。在 dashboard 的 **Developer → API Keys** 下创建 API key，并在 **Developer → Webhooks** 下创建 webhook secret：

```env theme={null}
DODO_PAYMENTS_API_KEY=your-api-key
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
DODO_PAYMENTS_RETURN_URL=https://yourdomain.com/checkout/success
DODO_PAYMENTS_ENVIRONMENT="test_mode" # or "live_mode"
```

`DODO_PAYMENTS_RETURN_URL` 是客户完成 checkout 后到达的位置。如果不传入 environment，handlers 会使用 `live_mode`。

> [!WARNING]
>
> 切勿将 `.env` 文件或 secrets 提交到 version control。

## Route Handler 示例

> [!NOTE]
>
> 所有示例均假设您使用 Next.js App Router。

**Checkout Handler**

> [!NOTE]
>
> 使用此 handler 将 Dodo Payments checkout 添加到您的应用。`GET` handler 提供 static checkout。`POST` handler 提供 checkout sessions；当您设置 `type: "dynamic"` 时，它也可以提供 dynamic checkout。

```typescript Next.js Route Handler expandable theme={null}
// app/checkout/route.ts
import { Checkout } from "@dodopayments/nextjs";

export const GET = Checkout({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT as "test_mode" | "live_mode",
  type: "static", // optional, defaults to 'static'
});

export const POST = Checkout({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT as "test_mode" | "live_mode",
  type: "session", // for checkout sessions, or "dynamic" for dynamic checkout
});
```

```bash Static Checkout cURL Example expandable theme={null}
curl --request GET \
--url 'https://example.com/checkout?productId=pdt_123'
```

```bash Dynamic Checkout cURL Example expandable theme={null}
curl --request POST \
--url https://example.com/checkout \
--header 'Content-Type: application/json' \
--data '{
"billing": {
  "city": "Austin",
  "country": "US",
  "state": "TX",
  "street": "123 Main St",
  "zipcode": "78701"
},
"customer": {
  "email": "customer@example.com",
  "name": "John Doe"
},
"metadata": {},
"product_id": "pdt_123",
"quantity": 1,
"billing_currency": "USD",
"discount_codes": ["IKHZ23M9GQ"],
"return_url": "https://example.com",
"trial_period_days": 10
}'
```

```bash Checkout Session cURL Example expandable theme={null}
curl --request POST \
--url https://example.com/checkout \
--header 'Content-Type: application/json' \
--data '{
"product_cart": [
  {
    "product_id": "pdt_123",
    "quantity": 1
  }
],
"customer": {
  "email": "customer@example.com",
  "name": "John Doe"
},
"return_url": "https://example.com/success"
}'
```

**Customer Portal Handler**

> [!NOTE]
>
> 使用此 handler 将客户发送到 Dodo Payments Customer Portal，在那里他们可以管理 subscriptions 和详细信息。

```typescript Next.js Route Handler expandable theme={null}
// app/customer-portal/route.ts
import { CustomerPortal } from "@dodopayments/nextjs";

export const GET = CustomerPortal({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: process.env.DODO_PAYMENTS_ENVIRONMENT as "test_mode" | "live_mode",
});
```

```bash Customer Portal cURL Example expandable theme={null}
curl --request GET \
--url 'https://example.com/customer-portal?customer_id=cus_123&send_email=true'
```

**Webhook Handler**

> [!NOTE]
>
> 使用此 handler 在您的 Next.js 应用中接收 Dodo Payments webhook events 并验证其 signatures。

```typescript Next.js Route Handler expandable theme={null}
// app/api/webhook/dodo-payments/route.ts
import { Webhooks } from "@dodopayments/nextjs";

export const POST = Webhooks({
  webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY!,
  onPayload: async (payload) => {
    // handle the payload
  },
  // ... other event handlers for granular control
});
```

## Checkout Route Handler

checkout handler 支持使用 Dodo Payments 收款的三种方式：

* **Static Payment Links：** 可分享的 URLs，无需代码即可收款。
* **Dynamic Payment Links：** 使用自定义详细信息生成的 payment links。它们使用 deprecated endpoints。
* **Checkout Sessions：** 托管式 checkout，包含 product cart、customer details 和 customization options。这是推荐的流程。

> **Static Checkout (GET)**
>
> ### 支持的 Query Parameters
>
> **productId** `string` *required*
>
> Product identifier，例如 `?productId=pdt_123`。
>
> **quantity** `integer` (default: 1)
>
> Product 的数量。
>
> **fullName** `string`
>
> Customer 的全名。如果提供了 `firstName` 或 `lastName`，则会忽略此项。
>
> **firstName** `string`
>
> Customer 的名字。
>
> **lastName** `string`
>
> Customer 的姓氏。
>
> **email** `string`
>
> Customer 的 email address。
>
> **country** `string`
>
> Customer 的国家，使用 ISO 3166-1 alpha-2 code 表示。
>
> **addressLine** `string`
>
> Customer 的地址行。
>
> **city** `string`
>
> Customer 所在的城市。
>
> **state** `string`
>
> Customer 所在的州或省。
>
> **zipCode** `string`
>
> Customer 的 ZIP 或 postal code。
>
> **disableFullName** `boolean`
>
> 设置为 `true` 可禁用 full name 字段。
>
> **disableFirstName** `boolean`
>
> 设置为 `true` 可禁用 first name 字段。
>
> **disableLastName** `boolean`
>
> 设置为 `true` 可禁用 last name 字段。
>
> **disableEmail** `boolean`
>
> 设置为 `true` 可禁用 email 字段。
>
> **disableCountry** `boolean`
>
> 设置为 `true` 可禁用 country 字段。
>
> **disableAddressLine** `boolean`
>
> 设置为 `true` 可禁用 address line 字段。
>
> **disableCity** `boolean`
>
> 设置为 `true` 可禁用 city 字段。
>
> **disableState** `boolean`
>
> 设置为 `true` 可禁用 state 字段。
>
> **disableZipCode** `boolean`
>
> 设置为 `true` 可禁用 ZIP code 字段。
>
> **paymentCurrency** `string`
>
> Payment currency，例如 `USD`。
>
> **showCurrencySelector** `boolean` (default: true)
>
> 显示或隐藏 currency selector。
>
> **paymentAmount** `number`
>
> 固定收取的金额，单位为主要货币单位，例如 `12.5` 表示 \$12.50。仅适用于 Pay What You Want products；如果低于 product 的 minimum price，则会忽略该值。
>
> **showDiscounts** `boolean` (default: true)
>
> 显示或隐藏 discounts section。
>
> **metadata\_**\* `string`
>
> 任何以 `metadata_` 开头的 query parameter 都会作为 metadata 传递。
>
> handler 会将其 config 中的 `returnUrl` 作为 `redirect_url` 添加到 link 中。
>
> > [!WARNING]
> >
> > 如果缺少 `productId`，handler 会返回 400 response。无效的 query parameters 和不存在的 product IDs 也会返回 400。
>
> ### Response Format
>
> Static checkout 返回包含 checkout URL 的 JSON response。在 test mode 中，URL 使用 `test.checkout.dodopayments.com`。
>
> ```json theme={null}
> {
>   "checkout_url": "https://checkout.dodopayments.com/..."
> }
> ```

> **Dynamic Checkout (POST)**
>
> * 在 POST request 中将 parameters 作为 JSON body 发送。
> * 支持一次性付款和 recurring payments。
> * `billing` 和 `customer` 是必需的。
> * 有关所有支持的 body fields，请参阅：
>   * [Request body for a One Time Payment Product](https://docs.dodopayments.com/api-reference/payments/post-payments.md)
>
>   * [Request body for a Subscription Product](https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions.md)
>
> > [!WARNING]
> >
> > Dynamic checkout 代理已 deprecated 的 `POST /payments` 和 `POST /subscriptions` endpoints。它会继续支持现有 integrations，但新 integrations 应使用 checkout sessions。
>
> ### Response Format
>
> Dynamic checkout 返回包含 checkout URL 的 JSON response：
>
> ```json theme={null}
> {
>   "checkout_url": "https://checkout.dodopayments.com/..."
> }
> ```

> **Checkout Sessions (POST)**
>
> Checkout sessions 为一次性购买和 subscriptions 创建 hosted checkout，并提供完整的 customization control。`product_cart` 是唯一必填字段。如果 body 不包含 `return_url`，handler 会使用其 config 中的 `returnUrl`。
>
> 有关详细信息和所有支持的 fields，请参阅 [Checkout Sessions Integration Guide](https://docs.dodopayments.com/developer-resources/checkout-session.md)。
>
> 使用 `payment_method_id` 创建的 session 不会返回 checkout URL，因此 handler 会响应 400。若要向已保存的 payment method 收费，请改用 SDK 创建 session。
>
> ### Response Format
>
> Checkout sessions 返回包含 checkout URL 的 JSON response：
>
> ```json theme={null}
> {
>   "checkout_url": "https://checkout.dodopayments.com/session/..."
> }
> ```

## Customer Portal Route Handler

Customer Portal route handler 会为您传入的 customer 创建 Customer Portal session，并将浏览器重定向到该 session。

> [!WARNING]
>
> handler 不会检查调用者的身份。任何使用 customer ID 请求它的人都可以获得该 customer 的 portal。请使用您自己的 authentication 保护该 route，并且只传入已登录用户的 customer ID。

### Query Parameters

**customer\_id** `string` *required*

portal session 的 customer ID，例如 `?customer_id=cus_123`。

**send\_email** `boolean`

如果设置为 `true`，Dodo Payments 还会将 portal link 通过 email 发送给 customer。

如果缺少 `customer_id`，handler 会返回 400；如果无法创建 portal session，则返回 500。

## Webhook Route Handler

webhook route handler 会在运行您的代码前验证每个 request：

* **Method：** 仅支持 POST requests。其他 methods 返回 405。
* **Signature Verification：** 使用 `webhookKey`，针对 `webhook-id`、`webhook-timestamp` 和 `webhook-signature` headers 验证 raw request body。验证失败时返回 401。
* **Payload Validation：** 将已验证的 body 解析为 JSON，并使用 Zod 进行验证。当解析后的 payload 与 webhook schema 不匹配时返回 400。
* **Error Handling：**
  * 401：无效 signature
  * 400：无效 payload
  * 500：意外的 verification errors、格式错误的 JSON，或您的 callbacks 抛出的 errors
* **Event Routing：** 对每个 event 调用 `onPayload`，然后调用该 event type 对应的 handler，并返回 200。

adaptor 不会捕获您的 handlers 抛出的 errors。它们会传播到 Next.js，并导致 request 失败。

### 支持的 Webhook Event Handlers

每个 handler 都会接收其 event type 对应的已验证 payload：

```typescript TypeScript expandable theme={null}
onPayload?: (payload: WebhookPayload) => Promise<void>;
onPaymentSucceeded?: (payload: WebhookPayload) => Promise<void>;
onPaymentFailed?: (payload: WebhookPayload) => Promise<void>;
onPaymentProcessing?: (payload: WebhookPayload) => Promise<void>;
onPaymentCancelled?: (payload: WebhookPayload) => Promise<void>;
onRefundSucceeded?: (payload: WebhookPayload) => Promise<void>;
onRefundFailed?: (payload: WebhookPayload) => Promise<void>;
onDisputeOpened?: (payload: WebhookPayload) => Promise<void>;
onDisputeExpired?: (payload: WebhookPayload) => Promise<void>;
onDisputeAccepted?: (payload: WebhookPayload) => Promise<void>;
onDisputeCancelled?: (payload: WebhookPayload) => Promise<void>;
onDisputeChallenged?: (payload: WebhookPayload) => Promise<void>;
onDisputeWon?: (payload: WebhookPayload) => Promise<void>;
onDisputeLost?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionActive?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionOnHold?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionRenewed?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionPlanChanged?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionCancelled?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionFailed?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionExpired?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionUpdated?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionPaused?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionUnpaused?: (payload: WebhookPayload) => Promise<void>;
onSubscriptionUpdatePaymentMethod?: (payload: WebhookPayload) => Promise<void>;
onLicenseKeyCreated?: (payload: WebhookPayload) => Promise<void>;
onAbandonedCheckoutDetected?: (payload: WebhookPayload) => Promise<void>;
onAbandonedCheckoutRecovered?: (payload: WebhookPayload) => Promise<void>;
onDunningStarted?: (payload: WebhookPayload) => Promise<void>;
onDunningRecovered?: (payload: WebhookPayload) => Promise<void>;
onCreditAdded?: (payload: WebhookPayload) => Promise<void>;
onCreditDeducted?: (payload: WebhookPayload) => Promise<void>;
onCreditExpired?: (payload: WebhookPayload) => Promise<void>;
onCreditRolledOver?: (payload: WebhookPayload) => Promise<void>;
onCreditRolloverForfeited?: (payload: WebhookPayload) => Promise<void>;
onCreditOverageCharged?: (payload: WebhookPayload) => Promise<void>;
onCreditOverageReset?: (payload: WebhookPayload) => Promise<void>;
onCreditManualAdjustment?: (payload: WebhookPayload) => Promise<void>;
onCreditBalanceLow?: (payload: WebhookPayload) => Promise<void>;
onEntitlementGrantCreated?: (payload: WebhookPayload) => Promise<void>;
onEntitlementGrantDelivered?: (payload: WebhookPayload) => Promise<void>;
onEntitlementGrantFailed?: (payload: WebhookPayload) => Promise<void>;
onEntitlementGrantRevoked?: (payload: WebhookPayload) => Promise<void>;
onPayoutCreated?: (payload: WebhookPayload) => Promise<void>;
onPayoutOnHold?: (payload: WebhookPayload) => Promise<void>;
onPayoutInProgress?: (payload: WebhookPayload) => Promise<void>;
onPayoutFailed?: (payload: WebhookPayload) => Promise<void>;
onPayoutSuccess?: (payload: WebhookPayload) => Promise<void>;
```

有关每个 event 的含义，请参阅 [Webhook Event Guide](https://docs.dodopayments.com/developer-resources/webhooks/intents/webhook-events-guide.md)。

## 面向 LLM 的 Prompt

将此 prompt 复制到您的 AI coding assistant 中，让它将 adaptor 添加到您的项目。若还希望为您的 agent 提供 Dodo Payments 文档和 skills，请安装 [Agent Plugin](https://docs.dodopayments.com/developer-resources/build-with-ai-coding-agents.md)。

```text expandable theme={null}

You are an expert Next.js developer assistant. Your task is to guide a user through integrating the @dodopayments/nextjs adapter into their existing Next.js project.

The @dodopayments/nextjs adapter provides route handlers for Dodo Payments' Checkout, Customer Portal, and Webhook functionalities, designed for the Next.js App Router.

First, install the necessary packages. Use the package manager appropriate for your project (npm, yarn, or bun) based on the presence of lock files (e.g., package-lock.json for npm, yarn.lock for yarn, bun.lockb for bun):

npm install @dodopayments/nextjs

Here's how you should structure your response:

    Ask the user which functionalities they want to integrate.

"Which parts of the @dodopayments/nextjs adapter would you like to integrate into your project? You can choose one or more of the following:

    Checkout Route Handler (for handling product checkouts)

    Customer Portal Route Handler (for managing customer subscriptions/details)

    Webhook Route Handler (for receiving Dodo Payments webhook events)

    All (integrate all three)"

    Based on the user's selection, provide detailed integration steps for each chosen functionality.

If Checkout Route Handler is selected:

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.
File Creation: Create a new file at app/checkout/route.ts in your Next.js project.

Code Snippet:

// app/checkout/route.ts
import { Checkout } from '@dodopayments/nextjs'

export const GET = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: process.env.DODO_PAYMENTS_ENVIRONMENT as "test_mode" | "live_mode",
type: "static",
});

export const POST = Checkout({
bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
environment: process.env.DODO_PAYMENTS_ENVIRONMENT as "test_mode" | "live_mode",
type: "session", // or "dynamic" for dynamic link
});

Configuration & Usage:

    bearerToken: Your Dodo Payments API key. It's recommended to set this via the DODO_PAYMENTS_API_KEY environment variable.

    returnUrl: (Optional) The URL to redirect the user to after a successful checkout.

    environment: (Optional) Set to "test_mode" for testing, or omit/set to "live_mode" for production.

    type: (Optional) Set to "static" for GET/static checkout, "dynamic" for POST/dynamic checkout, or "session" for POST/checkout sessions.

Static Checkout (GET) Query Parameters:

    productId (required): Product identifier (e.g., ?productId=pdt_123)

    quantity (optional): Quantity of the product

    Customer Fields (optional): fullName, firstName, lastName, email, country, addressLine, city, state, zipCode

    Disable Flags (optional, set to true to disable): disableFullName, disableFirstName, disableLastName, disableEmail, disableCountry, disableAddressLine, disableCity, disableState, disableZipCode

    Advanced Controls (optional): paymentCurrency, showCurrencySelector, paymentAmount, showDiscounts

    Metadata (optional): Any query parameter starting with metadata_ (e.g., ?metadata_userId=abc123)

    Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}

Dynamic Checkout (POST) - Returns JSON with checkout_url: Parameters are sent as a JSON body. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://checkout.dodopayments.com/..."}. For a complete list of supported POST body fields, refer to:

    Docs - One Time Payment Product: https://docs.dodopayments.com/api-reference/payments/post-payments

    Docs - Subscription Product: https://docs.dodopayments.com/api-reference/subscriptions/post-subscriptions

Checkout Sessions (POST) - (Recommended) A more customizable checkout experience. Returns JSON with checkout_url: Parameters are sent as a JSON body. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://checkout.dodopayments.com/session/..."}. For a complete list of supported fields, refer to:

  Checkout Sessions Integration Guide: https://docs.dodopayments.com/developer-resources/checkout-session

Error Handling: If productId is missing or other parameters are invalid, the handler will return a 400 response.

If Customer Portal Route Handler is selected:

Purpose: This handler redirects a customer to their Dodo Payments customer portal. It does not authenticate the caller, so protect the route and pass only the signed-in user's customer ID.
File Creation: Create a new file at app/customer-portal/route.ts in your Next.js project.

Code Snippet:

// app/customer-portal/route.ts
import { CustomerPortal } from '@dodopayments/nextjs'

export const GET = CustomerPortal({
bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
environment: "test_mode",
});

Query Parameters:

    customer_id (required): The customer ID for the portal session (e.g., ?customer_id=cus_123)

    send_email (optional, boolean): If set to true, sends an email to the customer with the portal link.

    Returns 400 if customer_id is missing.

If Webhook Route Handler is selected:

Purpose: This handler processes incoming webhook events from Dodo Payments, allowing your application to react to events like successful payments, refunds, or subscription changes.
File Creation: Create a new file at app/api/webhook/dodo-payments/route.ts in your Next.js project.

Code Snippet:

// app/api/webhook/dodo-payments/route.ts
import { Webhooks } from '@dodopayments/nextjs'

export const POST = Webhooks({
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY!,
onPayload: async (payload) => {
// handle the payload
},
// ... other event handlers for granular control
});

Handler Details:

    Method: Only POST requests are supported. Other methods return 405.

    Signature Verification: The handler verifies the webhook signature using the webhookKey and returns 401 if verification fails.

    Payload Validation: The payload is validated with Zod. Returns 400 for invalid payloads.

Error Handling:

    401: Invalid signature

    400: Invalid payload

    500: Internal error during verification

Event Routing: Calls the appropriate event handler based on the payload type.

Supported Webhook Event Handlers:

    onPayload?: (payload: WebhookPayload) => Promise<void>

    onPaymentSucceeded?: (payload: WebhookPayload) => Promise<void>

    onPaymentFailed?: (payload: WebhookPayload) => Promise<void>

    onPaymentProcessing?: (payload: WebhookPayload) => Promise<void>

    onPaymentCancelled?: (payload: WebhookPayload) => Promise<void>

    onRefundSucceeded?: (payload: WebhookPayload) => Promise<void>

    onRefundFailed?: (payload: WebhookPayload) => Promise<void>

    onDisputeOpened?: (payload: WebhookPayload) => Promise<void>

    onDisputeExpired?: (payload: WebhookPayload) => Promise<void>

    onDisputeAccepted?: (payload: WebhookPayload) => Promise<void>

    onDisputeCancelled?: (payload: WebhookPayload) => Promise<void>

    onDisputeChallenged?: (payload: WebhookPayload) => Promise<void>

    onDisputeWon?: (payload: WebhookPayload) => Promise<void>

    onDisputeLost?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionActive?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionOnHold?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionRenewed?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionPlanChanged?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionCancelled?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionFailed?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionExpired?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionUpdated?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionPaused?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionUnpaused?: (payload: WebhookPayload) => Promise<void>

    onSubscriptionUpdatePaymentMethod?: (payload: WebhookPayload) => Promise<void>

    onLicenseKeyCreated?: (payload: WebhookPayload) => Promise<void>

    onAbandonedCheckoutDetected?: (payload: WebhookPayload) => Promise<void>

    onAbandonedCheckoutRecovered?: (payload: WebhookPayload) => Promise<void>

    onDunningStarted?: (payload: WebhookPayload) => Promise<void>

    onDunningRecovered?: (payload: WebhookPayload) => Promise<void>

    onCreditAdded?: (payload: WebhookPayload) => Promise<void>

    onCreditDeducted?: (payload: WebhookPayload) => Promise<void>

    onCreditExpired?: (payload: WebhookPayload) => Promise<void>

    onCreditRolledOver?: (payload: WebhookPayload) => Promise<void>

    onCreditRolloverForfeited?: (payload: WebhookPayload) => Promise<void>

    onCreditOverageCharged?: (payload: WebhookPayload) => Promise<void>

    onCreditOverageReset?: (payload: WebhookPayload) => Promise<void>

    onCreditManualAdjustment?: (payload: WebhookPayload) => Promise<void>

    onCreditBalanceLow?: (payload: WebhookPayload) => Promise<void>

    onEntitlementGrantCreated?: (payload: WebhookPayload) => Promise<void>

    onEntitlementGrantDelivered?: (payload: WebhookPayload) => Promise<void>

    onEntitlementGrantFailed?: (payload: WebhookPayload) => Promise<void>

    onEntitlementGrantRevoked?: (payload: WebhookPayload) => Promise<void>

    onPayoutCreated?: (payload: WebhookPayload) => Promise<void>

    onPayoutOnHold?: (payload: WebhookPayload) => Promise<void>

    onPayoutInProgress?: (payload: WebhookPayload) => Promise<void>

    onPayoutFailed?: (payload: WebhookPayload) => Promise<void>

    onPayoutSuccess?: (payload: WebhookPayload) => Promise<void>

    Environment Variable Setup:

To ensure the adapter functions correctly, you will need to manually set up the following environment variables in your Next.js project's deployment environment (e.g., Vercel, Netlify, AWS, etc.):

    DODO_PAYMENTS_API_KEY: Your Dodo Payments API Key (required for Checkout and Customer Portal).

    DODO_PAYMENTS_RETURN_URL: (Optional) The URL to redirect to after a successful checkout (for Checkout handler).

    DODO_PAYMENTS_WEBHOOK_KEY: Your Dodo Payments Webhook Secret (required for Webhook handler).

Example .env file:

DODO_PAYMENTS_API_KEY=your-api-key
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
DODO_PAYMENTS_ENVIRONMENT="test_mode" # or "live_mode"
DODO_PAYMENTS_RETURN_URL=your-return-url

Usage in your code:

bearerToken: process.env.DODO_PAYMENTS_API_KEY!
webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY!

Important: Never commit sensitive environment variables directly into your version control. Use environment variables for all sensitive information.

If the user needs assistance setting up environment variables for their specific deployment environment, ask them what platform they are using (e.g., Vercel, Netlify, AWS, etc.), and provide guidance. You can also add comments to their PR or chat depending on the context

```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.