Astro Adaptor

@dodopayments/astro パッケージは、Astro プロジェクトに3つの endpoint handler を提供します。Checkout は checkout URL を返し、CustomerPortal は顧客を Customer Portal に移動させ、Webhooks は webhook event を検証してコードにルーティングします。

Checkout Handler

static、dynamic、checkout session のフローで checkout URL を作成します。

Customer Portal

顧客が subscription と詳細情報を管理できるようにします。

Webhooks

Dodo Payments webhook event を受信して処理します。

Installation

Install the Package

このコマンドをプロジェクトの root で実行します:

npm install @dodopayments/astro

このパッケージは、peer dependency として Astro 4 または 5、および zod 3.25 以降を指定しています。

Set Up Environment Variables

プロジェクトの root に .env ファイルを作成します。Developer → API Keys で API key を作成します。Developer → Webhooks で webhook endpoint を追加し、その Signing secret を DODO_PAYMENTS_WEBHOOK_KEY にコピーします:

DODO_PAYMENTS_API_KEY=your-api-key
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
# test_mode or live_mode
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_RETURN_URL=https://yourdomain.com/checkout/success

DODO_PAYMENTS_RETURN_URL は、checkout 後に顧客が移動する場所です。environment を渡さない場合、handler は live_mode を使用します。test mode の API key は test_mode でのみ機能します。

.env ファイルや secrets を version control に commit しないでください。

Route Handler の例

この例は src/pages/api/ にある Astro server endpoint です。Dodo Payments を呼び出す endpoint は on demand で render する必要があるため、Astro プロジェクトに server adapter を追加します。Astro のデフォルトの static output mode では endpoint が build 時に render されるため、各例では代わりに prerender = false を export して、リクエストごとに endpoint を render します。

Checkout Handler
Customer Portal Handler
Webhook Handler

この handler を使用して、Dodo Payments checkout をアプリに追加します。GET handler は static checkout を提供します。POST handler は checkout session を提供します。また、type: "dynamic" を設定した場合は dynamic checkout を提供します。endpoint file から export できる POST handler は1つだけなので、dynamic checkout の例では type: "dynamic" を設定しているものとします。

// src/pages/api/checkout.ts
import { Checkout } from "@dodopayments/astro";

export const prerender = false;

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

export const POST = Checkout({
    bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
    returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
    environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
    type: "session", // for checkout sessions, or "dynamic" for dynamic checkout
});

curl --request GET \
  --url 'https://example.com/api/checkout?productId=pdt_fqJhl7pxKWiLhwQR042rh'

curl --request POST \
  --url https://example.com/api/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": {},
  "payment_link": true,
  "product_id": "pdt_QMDuvLkbVzCRWRQjLNcs",
  "quantity": 1,
  "billing_currency": "USD",
  "discount_codes": ["IKHZ23M9GQ"],
  "return_url": "https://example.com",
  "trial_period_days": 10
}'

curl --request POST \
  --url https://example.com/api/checkout \
  --header 'Content-Type: application/json' \
  --data '{
  "product_cart": [
    {
      "product_id": "pdt_QMDuvLkbVzCRWRQjLNcs",
      "quantity": 1
    }
  ],
  "customer": {
    "email": "customer@example.com",
    "name": "John Doe"
  },
  "return_url": "https://example.com/success"
}'

この handler を使用して、顧客を Dodo Payments Customer Portal に移動させます。Customer Portal では subscription と詳細情報を管理できます。

// src/pages/api/customer-portal.ts
import { CustomerPortal } from "@dodopayments/astro";

export const prerender = false;

export const GET = CustomerPortal({
    bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
    environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
});

curl --request GET \
  --url 'https://example.com/api/customer-portal?customer_id=cus_9VuW4K7O3GHwasENg31m&send_email=true'

この handler を使用して、Astro アプリで Dodo Payments webhook event を受信し、その signature を検証します。

// src/pages/api/webhook.ts
import { Webhooks } from "@dodopayments/astro";

export const prerender = false;

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

Checkout Route Handler

checkout handler は、Dodo Payments で支払いを受け付ける次の3つの方法すべてに対応しています:

Static Payment Links: コードなしで支払いを受け付ける共有可能な URL。
Dynamic Payment Links: カスタム詳細情報を指定して生成する payment link。deprecated endpoint を使用します。
Checkout Sessions: product cart、顧客情報、カスタマイズ options を備えた hosted checkout。推奨されるフローです。

Checkout は次の options を受け取ります:

Option	Type	Description
`bearerToken`	`string`	Dodo Payments API key。
`environment`	`string`	`test_mode` または `live_mode`。デフォルトは `live_mode`。
`returnUrl`	`string`	Optional。支払い後に checkout が顧客を redirect する URL。POST body 内の `return_url` が優先されます。
`type`	`string`	checkout flow: `static`、`dynamic`、または `session`。デフォルトは `static`。

この handler は GET request に対して static checkout を提供します。POST request に対しては、type が dynamic の場合に dynamic payment link を作成し、それ以外の場合は checkout session を作成します。

Static Checkout (GET)

Supported Query Parameters

string

必須

Product identifier。例: ?productId=pdt_nZuwz45WAs64n3l07zpQR。

integer

デフォルト:"1"

product の数量。

string

顧客の氏名。firstName または lastName が指定されている場合は無視されます。

string

顧客の名。

string

顧客の姓。

string

顧客の email address。

string

顧客の国（ISO 3166-1 alpha-2 code）。

string

顧客の住所。

string

顧客の市区町村。

string

顧客の州または都道府県。

string

顧客の ZIP または postal code。

boolean

true に設定すると、氏名 field を無効にします。

boolean

true に設定すると、名 field を無効にします。

boolean

true に設定すると、姓 field を無効にします。

boolean

true に設定すると、email field を無効にします。

boolean

true に設定すると、country field を無効にします。

boolean

true に設定すると、address line field を無効にします。

boolean

true に設定すると、city field を無効にします。

boolean

true に設定すると、state field を無効にします。

boolean

true に設定すると、ZIP code field を無効にします。

string

Payment currency。例: USD。

boolean

デフォルト:"true"

currency selector を表示または非表示にします。

number

請求額を major currency unit で固定します。例: $12.50 の場合は 12.5。Pay What You Want product でのみ機能し、product の minimum price 未満の場合は無視されます。

boolean

デフォルト:"true"

discounts section を表示または非表示にします。

string

metadata_ で始まる query parameter は、metadata として checkout に渡されます。例: metadata_orderId=123。

disable flag は、対応する field に値がある場合にのみ有効になります。例: disableEmail=true と組み合わせた email。handler は config の returnUrl を redirect_url として link に追加します。

productId がない場合、handler は 400 response を返します。無効な query parameter や、account に存在しない product の場合も 400 を返します。

Response Format

static checkout は checkout URL を含む JSON response を返します。test mode では、URL は test.checkout.dodopayments.com を使用します:

{
  "checkout_url": "https://test.checkout.dodopayments.com/buy/pdt_fqJhl7pxKWiLhwQR042rh?quantity=1&redirect_url=https%3A%2F%2Fyourdomain.com%2Fcheckout%2Fsuccess"
}

Dynamic Checkout (POST)

parameter を JSON body として POST request で送信します。
one-time payment と recurring payment の両方に対応します。handler は product を取得し、recurring product の場合は subscription を、それ以外の場合は one-time payment を作成します。
body には billing（street、city、state、country、zipcode を含む）と customer、さらに product_id または product_cart が必要です。subscription には product_id が必要です。
対応するすべての body field については、以下を参照してください:
- One Time Payment Product の Request body
- Subscription Product の Request body

Dynamic checkout は deprecated な POST /payments および POST /subscriptions endpoint の proxy です。既存の integration では引き続き動作しますが、新しい integration では checkout session を使用してください。

Response Format

Dynamic checkout は、payment link を checkout URL として含む JSON response を返します:

{
  "checkout_url": "https://test.checkout.dodopayments.com/cbq"
}

Checkout Sessions (POST)

Checkout session は、カスタマイズを完全に制御しながら、one-time purchase と subscription 用の hosted checkout を作成します。product_cart が唯一の必須 field で、少なくとも1つの product が必要です。body に return_url がない場合、handler は config の returnUrl を使用します。各 checkout_url は1回だけ使用でき、24時間後に expire します。confirm: true を渡した場合は15分後に expire します。payment_method_id で作成した session は checkout_url を返さないため、handler は 400 で応答します。詳細と対応するすべての field については、Checkout Sessions Integration Guide を参照してください。

Response Format

Checkout session は checkout URL を含む JSON response を返します:

{
  "checkout_url": "https://test.checkout.dodopayments.com/session/cks_Gi6KGJ2zFJo9rq9Ukifwa"
}

Customer Portal Route Handler

Customer Portal route handler は、指定された顧客の Customer Portal session を作成し、browser をそこへ redirect します。CustomerPortal は、Checkout と同じ bearerToken および environment options を受け取ります。

handler は、誰が呼び出しているかを確認しません。customer ID を指定してリクエストした人は誰でも、その顧客の portal を取得できます。独自の authentication で route を保護し、ログイン中のユーザーの customer ID のみを渡してください。

Query Parameters

string

必須

portal session の customer ID。例: ?customer_id=cus_123。

boolean

true に設定すると、Dodo Payments は portal link も顧客に email で送信します。

customer_id がない場合、handler は 400 を返し、portal session を作成できない場合は 500 を返します。

Webhook Route Handler

webhook route handler は、コードを実行する前に webhookKey として渡された webhook secret を使用して各 request を検証します:

Method: POST request のみ対応します。他の method は 405 を返します。
Signature Verification: Standard Webhooks specification に従い、webhookKey を使用して webhook-id、webhook-timestamp、webhook-signature header を検証します。検証に失敗すると 401 を返します。
Payload Validation: payload を Zod で検証します。無効な payload には 400 を返します。
Error Handling:
- 401: 無効な signature
- 400: 無効な payload
- 500: 検証中の internal error
Event Routing: すべての event に対して onPayload を呼び出し、その後 event の type に対応する handler を呼び出して 200 を返します。

adaptor は handler で throw された error を捕捉しません。error は Astro に伝播し、request は失敗します。

Supported Webhook Event Handlers

各 handler は optional かつ async で、対応する event type の検証済み payload を受け取ります:

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 を参照してください。

LLM 用 prompt

この prompt を AI coding assistant にコピーすると、adaptor をプロジェクトに追加できます。agent に Dodo Payments の docs と skills も提供するには、Agent Plugin を install してください。

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

The @dodopayments/astro adapter provides route handlers for Dodo Payments' Checkout, Customer Portal, and Webhook functionalities, designed for Astro server endpoints in src/pages/api/.

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/astro

The endpoints must render on demand. Make sure the project has an Astro server adapter, and export prerender = false from each endpoint file unless the project uses output: 'server'.

Here's how you should structure your response:

    Ask the user which functionalities they want to integrate.

"Which parts of the @dodopayments/astro 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 src/pages/api/checkout.ts in your Astro project.

Code Snippet:

// src/pages/api/checkout.ts
import { Checkout } from "@dodopayments/astro";

export const prerender = false;

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

export const POST = Checkout({
  bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
  returnUrl: import.meta.env.DODO_PAYMENTS_RETURN_URL,
  environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
  type: "session", // for checkout sessions, or "dynamic" for dynamic checkout
});

A file can export only one POST handler. To serve both dynamic checkout and checkout sessions, create a second endpoint file.

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. A return_url in the POST body takes precedence.

    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_nZuwz45WAs64n3l07zpQR)

    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://test.checkout.dodopayments.com/buy/pdt_nZuwz45WAs64n3l07zpQR?quantity=1"}

Dynamic Checkout (POST) - Returns JSON with checkout_url: Parameters are sent as a JSON body. It requires billing and customer, plus product_id or product_cart. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://test.checkout.dodopayments.com/cbq"}. 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, and product_cart is required. Supports both one-time and recurring payments. Returns: {"checkout_url": "https://test.checkout.dodopayments.com/session/cks_Gi6KGJ2zFJo9rq9Ukifwa"}. 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 query 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 src/pages/api/customer-portal.ts in your Astro project.

Code Snippet:

// src/pages/api/customer-portal.ts
import { CustomerPortal } from "@dodopayments/astro";

export const prerender = false;

export const GET = CustomerPortal({
  bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY,
  environment: import.meta.env.DODO_PAYMENTS_ENVIRONMENT,
});

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 src/pages/api/webhook.ts in your Astro project.

Code Snippet:

// src/pages/api/webhook.ts
import { Webhooks } from "@dodopayments/astro";

export const prerender = false;

export const POST = Webhooks({
  webhookKey: import.meta.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 onPayload for every event, then the event handler that matches 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 Astro 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).

    DODO_PAYMENTS_ENVIRONMENT: test_mode or live_mode. The handlers default to live_mode.

Example .env file:

DODO_PAYMENTS_API_KEY=your-api-key
DODO_PAYMENTS_WEBHOOK_KEY=your-webhook-secret
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_RETURN_URL=your-return-url

Usage in your code:

bearerToken: import.meta.env.DODO_PAYMENTS_API_KEY
webhookKey: import.meta.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

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Checkout Handler

Customer Portal

Webhooks

Installation

Route Handler の例

Checkout Route Handler

Supported Query Parameters

Response Format

Response Format

Response Format

Customer Portal Route Handler

Query Parameters

Webhook Route Handler

Supported Webhook Event Handlers

LLM 用 prompt