Honoアダプタ

@dodopayments/hono adaptor は、Hono アプリに3つの route handler を提供します。Checkout は checkout URL を返し、CustomerPortal は Customer Portal に顧客を誘導し、Webhooks は webhook request を検証してイベント handler を呼び出します。

Checkout Handler

Hono アプリから payment link と checkout session を作成します。

Customer Portal

顧客がサブスクリプションと詳細情報を管理できるようにします。

Webhooks

Dodo Payments webhook event を検証して処理します。

インストール

Install the Package

プロジェクトのルートで次のコマンドを実行します:

npm install @dodopayments/hono

このパッケージには Hono 4.8.9 以降が必要です。

Set Up Environment Variables

プロジェクトのルートに .env ファイルを作成します:

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://yourapp.com/success

Developer → API Keys で API key を作成します。Developer → Webhooks で webhook endpoint を追加し、その signing secret を DODO_PAYMENTS_WEBHOOK_KEY にコピーします。開発中は DODO_PAYMENTS_ENVIRONMENT=test_mode を指定した test mode API key を使用してください。test mode key は test mode に対してのみ機能します。DODO_PAYMENTS_RETURN_URL は任意です。

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

Route Handler の例

この例では、new Hono() で作成した Hono アプリに route を登録します。handler 自身が request body を読み取るため、body-parsing middleware は必要ありません。

Checkout Handler
Customer Portal Handler
Webhook Handler

この handler を使用して、Dodo Payments checkout を Hono アプリに統合します。static (GET)、dynamic (POST)、session (POST) の flow をサポートします。Hono は request に対して実行された最初の handler で停止するため、各 POST flow はそれぞれ異なる path に登録してください。

// route.ts
import { Hono } from 'hono'
import { Checkout } from '@dodopayments/hono'

const app = new Hono()

app.get(
  "/api/checkout",
  Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    type: 'static'
  })
);

app.post(
  "/api/checkout",
  Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    type: 'dynamic'
  })
);

app.post(
  "/api/checkout-session",
  Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    type: 'session'
  })
);

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": "San Francisco",
    "country": "US",
    "state": "CA",
    "street": "123 Main St",
    "zipcode": "94102"
  },
  "customer": {
    "email": "test@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-session \
  --header 'Content-Type: application/json' \
  --data '{
  "product_cart": [
    {
      "product_id": "pdt_QMDuvLkbVzCRWRQjLNcs",
      "quantity": 1
    }
  ],
  "customer": {
    "email": "test@example.com",
    "name": "John Doe"
  },
  "return_url": "https://example.com/success"
}'

この handler を使用して、顧客が Dodo Payments Customer Portal でサブスクリプションと詳細情報を管理できるようにします。

// route.ts
import { Hono } from 'hono'
import { CustomerPortal } from '@dodopayments/hono'

const app = new Hono()
app.get(
  "/api/customer-portal",
  CustomerPortal({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT
  })
);

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

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

// route.ts
import { Hono } from 'hono'
import { Webhooks } from '@dodopayments/hono'

const app = new Hono()
app.post(
  "/api/webhooks",
  Webhooks({
    webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
    onPayload: async (payload) => {
      // Handle Payload Here
      console.log(payload)
    }
  })
);

Checkout Route Handler

adaptor は3つすべての Dodo Payments checkout flow をサポートします。handler config で type を設定し、その route が提供する flow を選択します。すべての flow は、顧客が開く checkout_url を含む JSON を返します。

Static Payment Links: type: "static"、GET。query parameter を使用して1つの product の payment link を作成します。作成前に product の存在を確認します。
Dynamic Payment Links: type: "dynamic"、POST。product が recurring かどうかに応じて、payment link 付きの one-time payment または subscription を作成します。
Checkout Sessions: type: "session"、POST。product cart と顧客情報から checkout session を作成します。新しい統合にはこの flow を使用してください。

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

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

type が static の場合は GET に、dynamic または session の場合は POST に handler を登録します。handler は POST 以外のすべての request を static checkout request として扱います。

Static Checkout (GET)

サポートされる Query Parameter

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

顧客の street address。

string

顧客の city。

string

顧客の state または province。

string

顧客の postal code または ZIP code。

boolean

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

boolean

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

boolean

true に設定すると、last name 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 は、true であり、対応する field に値がある場合にのみ有効になります。例: disableEmail を持つ email。handler はこれらの parameter を static payment link に渡します。

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

Response Format

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

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

Dynamic Checkout (POST)

parameter は POST request の JSON body として送信します。
one-time payment と recurring payment の両方をサポートします。handler は product を取得し、product が recurring の場合は subscription を、それ以外の場合は one-time payment を作成します。
body には billing（street、city、state、country、zipcode を含む）と customer、および product_id（任意の quantity を含む）または product_cart が必要です。Subscription には product_id が必要です。
handler は metadata、allowed_payment_method_types、billing_currency、discount_codes（または deprecated な discount_code）、return_url、show_saved_payment_methods、tax_id も転送します。Subscription の場合は addons、on_demand、trial_period_days も転送します。その他の field は無視します。
field の詳細については、次を参照してください:
- One Time Payment Product の Request body
- Subscription Product の Request body

Dynamic Checkout は deprecated な POST /payments と POST /subscriptions endpoint を呼び出します。新しい統合には Checkout Sessions を使用してください。

Response Format

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

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

Checkout Sessions (POST)

Checkout session payload を JSON body として送信します。handler は checkout session を作成します。これにより one-time purchase と subscription の完全な payment flow が処理され、その checkout_url が返されます。product_cart は必須で、少なくとも1つの product を含める必要があります。各 checkout_url は1回だけ使用でき、24時間後に期限切れになります。confirm: true を渡した場合は15分後に期限切れになります。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_id の顧客用に Customer Portal session を作成し、request を portal link に redirect します。CustomerPortal は、Checkout と同じ bearerToken および environment options を受け取ります。Dodo Payments が session を作成できない場合、handler は 500 を返します。

Query Parameters

string

必須

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

boolean

true に設定すると、顧客に portal link を email で送信します。

customer_id がない場合は 400 を返します。handler は request を認証せず、受け取った任意の customer_id に対して portal を開くため、route を独自の authentication の背後に置き、サインイン済みユーザーの customer ID のみを渡してください。

Webhook Route Handler

Webhook handler は、webhookKey として渡された webhook secret を使用して各 request を検証し、その後 event handler を呼び出します。raw request body 自身を読み取るため、route に body-parsing middleware は必要ありません。

Method: POST request のみサポートされます。その他の method は 405 を返します。
Signature Verification: webhook-id、webhook-timestamp、webhook-signature header を webhookKey で検証します。Standard Webhooks specification に従います。検証に失敗すると 401 を返します。
Payload Validation: Zod で検証します。無効な payload の場合は 400 を返します。
Error Handling:
- 401: Invalid signature
- 400: Invalid payload
- 500: 検証中の Internal error
Event Routing: すべての event に対して onPayload を呼び出し、その後 event type 用の handler を呼び出します。処理が完了すると 200 を返します。handler は event handler が throw した error を catch しません。

サポートされる Webhook Event Handler

すべての handler は任意で、async です。各 event の payload については、Webhook Event Guide を参照してください。

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>;

LLM 向け Prompt

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

The @dodopayments/hono adapter provides route handlers for Dodo Payments' Checkout, Customer Portal, and Webhook functionalities, designed to plug directly into a Hono app.

First, install the necessary package. Use the package manager appropriate for the user's project (npm, yarn, or bun):

npm install @dodopayments/hono

The package requires Hono 4.8.9 or later.

---

Here's how you should structure your response:

1. Ask the user which functionalities they want to integrate.

"Which parts of the @dodopayments/hono 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)"

---

2. 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.

**Integration**:
Create routes in your Hono app for static (GET), dynamic (POST), and checkout sessions (POST). Give each POST flow its own path, because Hono stops at the first handler that runs for a request.

import { Hono } from 'hono'
import { Checkout } from '@dodopayments/hono'

const app = new Hono()

app.get(
  "/api/checkout",
  Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    type: 'static'
  })
);

app.post(
  "/api/checkout",
  Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    type: 'dynamic'
  })
);

// For checkout sessions
app.post(
  "/api/checkout-session",
  Checkout({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT,
    returnUrl: process.env.DODO_PAYMENTS_RETURN_URL,
    type: 'session'
  })
);

Config Options:

    bearerToken: Your Dodo Payments API key (recommended to be stored in DODO_PAYMENTS_API_KEY env variable).

    returnUrl (optional): URL to redirect the user after successful checkout. A return_url in the POST body takes precedence.

    environment: "test_mode" or "live_mode" (defaults to "live_mode")

    type: "static" (GET) or "dynamic" (POST) or "session" (POST)

GET (static checkout) expects query parameters:

    productId (required)

    quantity, customer fields (fullName, email, etc.), and metadata (metadata_*) are optional.

    Returns: {"checkout_url": "https://test.checkout.dodopayments.com/buy/pdt_fqJhl7pxKWiLhwQR042rh?quantity=1"}

POST (dynamic checkout) expects a JSON body with payment details (one-time or subscription). It requires billing and customer, plus product_id or product_cart. 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://test.checkout.dodopayments.com/cbq"}

POST (checkout sessions) - (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

If Customer Portal Route Handler is selected:

Purpose: This route allows customers to manage their subscriptions via the Dodo Payments portal. It redirects the request to the portal link.

Integration:

import { Hono } from 'hono'
import { CustomerPortal } from '@dodopayments/hono'

const app = new Hono()
app.get(
  "/api/customer-portal",
  CustomerPortal({
    bearerToken: process.env.DODO_PAYMENTS_API_KEY,
    environment: process.env.DODO_PAYMENTS_ENVIRONMENT
  })
);

Query Parameters:

    customer_id (required): e.g., ?customer_id=cus_123

    send_email (optional): if true, customer is emailed the portal link

Returns 400 if customer_id is missing. The handler does not authenticate the request, so protect the route with the app's own authentication and pass only the signed-in user's customer ID.

If Webhook Route Handler is selected:

Purpose: Processes incoming webhook events from Dodo Payments to trigger events in your app.

Integration:

import { Hono } from 'hono'
import { Webhooks } from '@dodopayments/hono'

const app = new Hono()
app.post(
  "/api/webhooks",
  Webhooks({
    webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_KEY,
    onPayload: async (payload) => {
      // Handle Payload Here
      console.log(payload)
    }
  })
);

Features:

    Only POST method is allowed — others return 405

    Signature verification is performed using webhookKey. Returns 401 if invalid.

    Zod-based payload validation. Returns 400 if invalid schema.

    All handlers are async functions. onPayload runs for every event, before the event-specific handler.

Supported Webhook Event Handlers:

You may pass in any of the following handlers:

    onPayload

    onPaymentSucceeded

    onPaymentFailed

    onPaymentProcessing

    onPaymentCancelled

    onRefundSucceeded

    onRefundFailed

    onDisputeOpened, onDisputeExpired, onDisputeAccepted, onDisputeCancelled, onDisputeChallenged, onDisputeWon, onDisputeLost

    onSubscriptionActive, onSubscriptionOnHold, onSubscriptionRenewed, onSubscriptionPlanChanged, onSubscriptionCancelled, onSubscriptionFailed, onSubscriptionExpired, onSubscriptionUpdated, onSubscriptionPaused, onSubscriptionUnpaused, onSubscriptionUpdatePaymentMethod

    onLicenseKeyCreated

    onAbandonedCheckoutDetected, onAbandonedCheckoutRecovered

    onDunningStarted, onDunningRecovered

    onCreditAdded, onCreditDeducted, onCreditExpired, onCreditRolledOver, onCreditRolloverForfeited, onCreditOverageCharged, onCreditOverageReset, onCreditManualAdjustment, onCreditBalanceLow

    onEntitlementGrantCreated, onEntitlementGrantDelivered, onEntitlementGrantFailed, onEntitlementGrantRevoked

    onPayoutCreated, onPayoutOnHold, onPayoutInProgress, onPayoutFailed, onPayoutSuccess

Environment Variable Setup:

Make sure to define these environment variables in your project:

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=https://yourapp.com/success

Use these inside your code as:

process.env.DODO_PAYMENTS_API_KEY
process.env.DODO_PAYMENTS_WEBHOOK_KEY

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

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Checkout Handler

Customer Portal

Webhooks

インストール

Route Handler の例

Checkout Route Handler

サポートされる Query Parameter

Response Format

Response Format

Response Format

Customer Portal Route Handler

Query Parameters

Webhook Route Handler

サポートされる Webhook Event Handler

LLM 向け Prompt