Checkout Sessions - Dodo Payments Documentation

Quick Start

Create your first checkout session in under 5 minutes

API Reference

Full API documentation and interactive testing

Preview Endpoint

Calculate pricing and taxes before creating a session

Session Validity: Checkout sessions expire after 24 hours by default, or 15 minutes when confirm: true.

Single-Use Links: The checkout_url is not reusable. Generate a fresh session for each customer and payment attempt rather than sharing or reusing a link.

Prerequisites

You need:

An active Dodo Payments merchant account
API credentials from Developer → API Keys in the dashboard
At least one product created in Products

Creating Your First Checkout Session

Node.js SDK
Python SDK
REST API

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode',
});

async function createCheckoutSession() {
  const session = await client.checkoutSessions.create({
    product_cart: [
      {
        product_id: 'pdt_123',
        quantity: 1
      }
    ],
    customer: {
      email: 'customer@example.com',
      name: 'John Doe',
      phone_number: '+1234567890'
    },
    billing_address: {
      street: '123 Main St',
      city: 'San Francisco',
      state: 'CA',
      country: 'US',
      zipcode: '94102'
    },
    return_url: 'https://yoursite.com/checkout/success'
  });

  console.log('Checkout URL:', session.checkout_url);
  return session;
}

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),
    environment="test_mode",
)

def create_checkout_session():
    session = client.checkout_sessions.create(
        product_cart=[
            {
                "product_id": "pdt_123",
                "quantity": 1
            }
        ],
        customer={
            "email": "customer@example.com",
            "name": "John Doe",
            "phone_number": "+1234567890"
        },
        billing_address={
            "street": "123 Main St",
            "city": "San Francisco",
            "state": "CA",
            "country": "US",
            "zipcode": "94102"
        },
        return_url="https://yoursite.com/checkout/success"
    )

    print(f"Checkout URL: {session.checkout_url}")
    return session

curl -X POST https://test.dodopayments.com/checkouts \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_cart": [
      {
        "product_id": "pdt_123",
        "quantity": 1
      }
    ],
    "customer": {
      "email": "customer@example.com",
      "name": "John Doe",
      "phone_number": "+1234567890"
    },
    "billing_address": {
      "street": "123 Main St",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "zipcode": "94102"
    },
    "return_url": "https://yoursite.com/checkout/success"
  }'

API Response

All methods return:

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

Only session_id is guaranteed to be present. When payment_method_id is provided, the charge processes immediately and checkout_url is null. Use the returned payment_id instead. When confirm: true, the payment is created at session-creation time, and the response also includes payment_id, client_secret, and publishable_key for use with the Dodo Payments checkout SDK.

Redirect Your Customer

Extract the checkout URL

Get checkout_url from the API response.

Redirect to checkout

Send your customer to the URL:

window.location.href = session.checkout_url;

Alternatively, open in a new window:

window.open(session.checkout_url, '_blank');

Handle the return

After payment, customers are redirected to your return_url with query parameters:

Parameter	Type	Condition
`payment_id`	string	Always present for one-time payments
`subscription_id`	string	Always present for subscriptions
`status`	string	Always present
`license_key`	string	Present if the product has license keys enabled. Comma-separated if multiple keys
`email`	string	Present if the customer has an email on record

Example redirect:

https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001&email=customer%40example.com

Instead of redirecting, you can embed checkout directly in your page using Overlay Checkout (modal), Inline Checkout (embedded), or Mobile SDKs (native apps). All consume the same session URL.

セッションステータスの確認

セッションのステータスを確認するには、Get Checkout Session (GET /checkouts/{id}) を呼び出します。レスポンスには、セッションの id、created_at、customer_email、customer_nameに加えて、payment_idとpayment_statusが含まれます。顧客が詳細を入力中の場合、両方の支払いフィールドはnullです。顧客が支払いを送信すると、payment_statusに、succeeded、failed、processingなどの支払いステータスが格納されます。フルフィルメントの信頼できる情報源としてwebhookを使用してください。

リクエストボディ

必須フィールド

array

必須

チェックアウトセッションに含める商品の配列です。各商品には、ダッシュボードの有効なproduct_idが必要です。同じセッションに、単発決済商品とサブスクリプション商品を組み合わせて含めることができます。

表示 Product Cart Item Properties

string

必須

ダッシュボードにある商品の一意の識別子です。例: "pdt_123abc456def"

integer

必須

商品の数量です。例: 単一アイテムの場合は1、複数の場合は3

array

商品に追加するアドオンの配列です。サブスクリプション商品の場合のみ有効です。

表示 Addon Item Properties

string

必須

アドオンの一意の識別子です。

integer

必須

アドオンの数量です。

integer

pay-what-you-wantが商品で有効な場合に顧客が支払う金額です。通貨の最小単位（USDの場合はセントなど）で表します。たとえば、100 = $1.00です。pay-what-you-wantが無効の場合は無視されます。

array

この商品にすでに付与されているクレジットエンタイトルメントに対するセッション単位の上書きです。別の商品を作成せずに、この単一セッションに異なるクレジット数を付与するために使用します。各credit_entitlement_idは、あらかじめ商品に付与されている必要があります。このフィールドは、このセッションのフルフィルメント時に付与されるcredits_amountのみを上書きします。商品のクレジットエンタイトルメント設定（有効期限、繰り越しなど）は引き続き適用されます。

表示 Credit Entitlement Override Properties

string

必須

上書きするクレジットエンタイトルメントのIDです。あらかじめ商品に付与されている必要があります。

string

必須

このチェックアウトセッションに付与するクレジット数です。商品のcredits_amountを上書きします。0より大きい値である必要があります。

商品IDを確認する: Dodo Paymentsダッシュボードの Products → View Details で商品IDを確認できます。または、List Products APIを使用してください。

オプションフィールド

Customer Information

object

顧客情報です。IDを使用して既存の顧客を関連付けるか、チェックアウト中に新しい顧客レコードを作成できます。

Attach Existing Customer
Create New Customer

表示 Existing Customer Properties

string

必須

既存の顧客の一意の識別子です。

表示 New Customer Properties

string

必須

顧客のメールアドレスです。

string

レシートや請求書に表示する顧客の氏名です。例: "John Doe"

string

国際形式の顧客の電話番号です。一部の決済手段や不正利用防止で必要です。形式: 国番号を含めます（例: "+1234567890"）

object

正確な税計算、不正利用防止、規制遵守のための請求先住所情報です。confirm: trueの場合、請求先住所のすべてのフィールドが必須になります。

表示 Billing Address Properties

string

番地、通り名、該当する場合はアパート・部屋番号を含む完全な住所です。例: "123 Main St, Apt 4B"

string

市区町村名です。例: "San Francisco"

string

州、県、または地域名です。正式名称または標準略称を使用してください。例: "California"または"CA"

string

必須

2文字のISO国コード（ISO 3166-1 alpha-2）です。billing_addressが指定されている場合は必須です。例: "US"、"CA"、"GB"、"DE"

Country Code Reference

対応国とISOコードの完全な一覧を表示

string

国の要件に応じた郵便番号、ZIPコード、または同等の値です。例: "94102"（米国）、"M5V 3A8"（カナダ）、"SW1A 1AA"（英国）

Payment Configuration

array

チェックアウト中に顧客が利用できる決済手段を制御します。特定の市場やビジネス要件に合わせた最適化に役立ちます。一般的なオプション: credit、debit、upi_collect、apple_pay、google_pay、amazon_pay、klarna、affirm、afterpay_clearpay、cashapp、ach、multibanco、bancontact_card、eps、ideal、blik、gcash、ali_pay_hk、fps、touch_n_go、paypal完全な一覧については、Create Checkout Session API referenceを参照してください。

優先する決済手段を利用できない場合のチェックアウト失敗を防ぐため、フォールバックオプションとして常にcreditとdebitを含めてください。

例:

["apple_pay", "google_pay", "credit", "debit"]

string

デフォルトの通貨選択を固定の請求通貨で上書きします。ISO 4217通貨コードを使用します。対応通貨: USD、EUR、GBP、CAD、AUD、INRなど例: 米ドルの場合は"USD"、ユーロの場合は"EUR"このフィールドはadaptive pricingが有効な場合のみ有効です。adaptive pricingが無効の場合は、商品のデフォルト通貨が使用されます。

boolean

デフォルト:"false"

再訪顧客に以前保存した決済手段を表示し、チェックアウトの速度とユーザー体験を向上させます。

Session Management

string

支払い完了後に顧客をリダイレクトするURLです。リダイレクト時、Dodo PaymentsはURLにクエリパラメータを追加します（上記のリダイレクトテーブルを参照）。リダイレクトURLの例:

# One-time payment with license key
https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&license_key=LK-001&email=customer%40example.com

# Subscription payment with multiple license keys
https://yoursite.com/return?subscription_id=sub_xxx&status=active&license_key=LK-001,LK-002&email=customer%40example.com

# Payment without license keys
https://yoursite.com/return?payment_id=pay_xxx&status=succeeded&email=customer%40example.com

license_keyとemailのクエリパラメータを使用すると、追加のAPI呼び出しなしで、戻り先ページにライセンスキーを表示したり、確認をすぐに送信したりできます。

string

顧客が戻るボタンをクリックした場合、またはチェックアウトセッションをキャンセルした場合にリダイレクトするURLです。指定しない場合、戻るボタンは表示されません。cancel_urlを設定すると、購入を完了せずに顧客がサイトへ戻れる明確な方法を提供できます。

boolean

デフォルト:"false"

trueの場合、すべてのセッション詳細を直ちに確定します。必須データが不足している場合、APIはエラーをスローします。confirm: trueの場合:

請求先住所のすべてのフィールドが必須になります
payment_method_idを指定して、請求を直ちに処理できます
セッションの有効期限が24時間ではなく15分になります
payment_method_idを指定する場合、既存のcustomer_idが必要です

array

1つ以上の積み重ねた割引コードをチェックアウトセッションに適用します。コードは配列の順序で適用されます（最初のコードが開始価格を引き下げ、2番目のコードが割引後の価格をさらに引き下げます）。1セッションあたり最大20個のコードを指定できます。Purchasing Power Parityが有効な場合、開始価格は基本価格ではなくPPP調整後の金額です。

discount_codes: ['WELCOME10', 'BLACKFRIDAY20']

以下の単数形のdiscount_codeフィールドは非推奨ですが、引き続き完全にサポートされています。同じリクエストでdiscount_codesと組み合わせることはできません。

string

非推奨

非推奨 — 新しい統合ではdiscount_codesを使用してください。後方互換性のため引き続き機能しますが、同じリクエストでdiscount_codesと組み合わせることはできません。

object

セッションに関する追加情報を保存するカスタムのキーと値のペアです。

boolean

このセッションに対するmerchantのデフォルト3DS動作を上書きします。

boolean

デフォルト:"false"

最小限の住所収集モードを有効にします。有効にすると、チェックアウトでは以下のみを収集します:

国: 税額決定のため常に必須
ZIP/郵便番号: 売上税、VAT、GSTの計算に必要な地域でのみ必須

不要なフォームフィールドをなくすことで、チェックアウト時の負担を大幅に軽減します。

string

関連付けられた顧客に属する保存済みの決済手段です。confirm: trueと既存のcustomer.customer_idが必要です。決済手段は、支払い通貨に対する利用可否が検証されます。設定すると請求が直ちに処理され、checkout_urlはnullとして返されます。代わりに返されたpayment_idを使用してください。

boolean

デフォルト:"false"

trueの場合、完全なセッションURLではなく短縮されたチェックアウトURLを返します。

string

コレクションベースのチェックアウトフローで使用する商品コレクションIDです。設定する場合は、空のproduct_cart配列を渡してください。セッション作成時に割引コードを事前適用することはできません。Product Collectionsを参照してください。

string

顧客のTax ID（VAT番号など）です。billing_addressとcountryが必要です。

string

Tax IDに関連付けられた任意の事業名または法的名称です。最大250文字です。有効なtax_idとともに指定すると、顧客の個人名ではなく請求書に表示されます。

integer

インドのカードで使用するINR e-mandateについて、merchantレベルのmandate floor（INR paise単位）を上書きします。プロセッサに送信されるmandate金額はmax(this_floor, actual_billing_amount)です。そのため、請求額が低い場合、これは実質的に顧客向けの認証上限になります。未設定の場合はmerchant設定が適用され、それも未設定の場合はシステムデフォルトの₹15,000が適用されます。

UI Customization

object

チェックアウトインターフェースの外観と動作をカスタマイズします。

表示 Customization Properties

string

チェックアウトインターフェースのテーマです。オプション: light、dark、またはsystem。指定しない場合、ダッシュボードでビジネスに設定されたテーマが使用されます。

boolean

デフォルト:"true"

チェックアウトインターフェースに注文詳細セクションを表示します。

boolean

デフォルト:"true"

該当する商品に「on-demand」タグを表示します。

string

チェックアウトインターフェースを特定の言語で表示します。デフォルトでは、チェックアウトが顧客のブラウザ言語を自動検出します。対応言語コード: ar、ca、de、en、es、fr、he、id、it、ja、ka、ko、ms、nl、pl、pt、ro、ru、sv、th、tr、zh例: スペイン語の場合は"es"、日本語の場合は"ja"

object

ライトモードとダークモードの色、フォント、ボタンスタイルを含むカスタムテーマ設定です。非推奨のクライアント側themeConfigオプションに代わるサーバー側の設定です。

表示 Theme Config Properties

object

ライトモードの色設定です。

object

ダークモードの色設定です。

string

プライマリフォントのURLです。有効なhttps:// URLである必要があります。

string

セカンダリフォントのURLです。有効なhttps:// URLである必要があります。

string

チェックアウトUIのフォントサイズです。オプション: xs、sm、md、lg、xl、2xl。

string

チェックアウトUIのフォントウェイトです。オプション: normal、medium、bold、extraBold。

string

支払いボタンに表示するカスタムテキストです（例: "Complete Purchase"または"Subscribe Now"）。最大100文字です。

string

UI要素の角丸です。px、rem、またはemを付けた数値で指定します（例: "4px"、"0.5rem"、"1em"）。

Feature Flags

object

チェックアウトセッションの特定の機能と動作を設定します。

表示 Feature Flags Properties

boolean

デフォルト:"true"

チェックアウト中に顧客が希望する通貨を選択できるようにします。

boolean

デフォルト:"true"

チェックアウトインターフェースに割引コード入力フィールドを表示します。

boolean

デフォルト:"false"

チェックアウト中に、顧客がサブスクリプション商品にアドオンを追加または削除できるようにします。サブスクリプション商品のみに適用されます。

boolean

デフォルト:"true"

チェックアウト中に顧客の電話番号を収集します。

boolean

デフォルト:"false"

チェックアウトを完了するために顧客へ電話番号の入力を求めます。allow_phone_number_collectionもtrueである必要があります。

boolean

デフォルト:"true"

顧客がTax IDを入力できるようにします。

boolean

デフォルト:"false"

チェックアウトを完了する前に、顧客へTax ID（インドではGST番号、EUではVAT番号）の入力を求めます。有効にすると、チェックアウトページで法人として購入があらかじめ選択され、固定されます。また、法人名とTax ID番号が必須になります。チェックアウトの完全な動作については、B2B Paymentsを参照してください。allow_tax_idもtrueである必要があります。それ以外の場合、リクエストは400とfeature_flags.require_tax_id: cannot be true when allow_tax_id is falseのメッセージで拒否されます。confirm: trueの場合、リクエストには空白以外のtax_idを含める必要があります。含まれていない場合、422で拒否されます。

boolean

デフォルト:"false"

既存の顧客レコードを更新する代わりに、新しい顧客レコードを強制的に作成します。

boolean

チェックアウト中に顧客がメールアドレスを編集できるようにします。

boolean

チェックアウト中に顧客が氏名を編集できるようにします。

boolean

チェックアウト中に顧客が住所を編集できるようにします。

boolean

チェックアウト中に顧客が市区町村を編集できるようにします。

boolean

チェックアウト中に顧客が州・県を編集できるようにします。

boolean

チェックアウト中に顧客が国を編集できるようにします。

boolean

チェックアウト中に顧客が郵便番号を編集できるようにします。

boolean

チェックアウト中に顧客がTax IDを入力または編集できるようにします。

boolean

デフォルト:"false"

顧客がTax IDに関連付けられた法人名を入力または編集できるようにします。allow_customer_editing_tax_idとは独立して機能します。いずれかのフラグ（またはallow_tax_id）があれば、顧客はセッションの法人名を上書きできます。通常はallow_customer_editing_tax_idと組み合わせて設定します。

boolean

デフォルト:"false"

デフォルトの支払い成功ページをスキップし、支払い完了後すぐに顧客をreturn_urlへリダイレクトします。ユーザー体験を向上させるカスタム成功ページがある場合、またはモバイルアプリや埋め込みチェックアウトフローで使用します。

boolean

デフォルト:"false"

trueの場合、セッションは単一ページのチェックアウトフローを使用します。ページの読み込み時に支払いを初期化し、別の支払いページなしでその場で確定します。

Custom Fields

array

カスタムフォームフィールドを使用して、チェックアウト中に顧客から追加情報を収集します。1つのチェックアウトセッションにつき最大5つのカスタムフィールドを定義できます。顧客の回答はwebhookペイロードに含まれ、APIから利用できます。

表示 Custom Field Properties

string

必須

このフィールドの一意の識別子です。webhookペイロードとAPIレスポンスのキーとして使用されます。例: "company_name"、"referral_source"、"team_size"

string

必須

チェックアウトフォームで顧客に表示するラベルです。例: "Company Name"、"How did you hear about us?"、"Team Size"

string

必須

入力の検証ルールを決定するフィールドの種類です。使用可能な種類: text、number、email、url、date、dropdown、boolean

boolean

デフォルト:"false"

チェックアウトを完了する前に、このフィールドへの入力が必要かどうかです。

string

入力フィールドに表示するプレースホルダーテキストです。

array

dropdownフィールドタイプの選択肢のリストです。field_typeがdropdownの場合に必須で、それ以外のタイプでは無視されます。例: ["Google", "Twitter", "Friend referral", "Other"]

カスタムフィールドへの顧客の回答は以下に含まれます:

Webhooks: payment.succeeded、subscription.active、その他の関連イベントペイロードにcustom_field_responses配列が含まれます
API responses: Paymentおよびsubscriptionオブジェクトにcustom_field_responsesが含まれます

Subscription Configuration

object

サブスクリプション商品を含むチェックアウトセッションの追加設定です。

表示 Subscription Data Properties

integer

初回請求前のトライアル期間の日数です。0日から10000日の範囲で指定する必要があります。セッションごとに有料トライアル金額を設定することはできません。代わりに商品の定期価格でtrial_amountを設定してください。Paid Trialsを参照してください。

object

従量制またはメータリング課金のオンデマンドサブスクリプション設定です。

表示 On-Demand Properties

boolean

必須

trueに設定すると、請求を行わず、将来の利用に備えて決済手段の詳細のみを承認します。

integer

顧客への初回請求に使用する商品の価格です。指定しない場合、商品の保存済み価格が使用されます。形式: 通貨の最小単位（USDの場合はセントなど）で表します。たとえば、100 = $1.00です。

string

商品の価格の任意の通貨です。指定しない場合、商品の通貨がデフォルトになります。

string

請求および明細項目に使用する任意の商品説明の上書きです。指定しない場合、商品の保存済み説明が使用されます。

boolean

adaptive currency手数料を商品の価格に含める（true）か、上乗せする（false）かを指定します。adaptive pricingが有効でない場合は無視されます。

使用例

単一商品のシンプルなチェックアウト

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_ebook_guide',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  return_url: 'https://yoursite.com/success'
});

複数商品のカート

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_course_advanced',
      quantity: 1
    },
    {
      product_id: 'pdt_certificate',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'Jane Smith'
  },
  return_url: 'https://yoursite.com/success'
});

トライアル期間付きサブスクリプション

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_saas_pro',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  subscription_data: {
    trial_period_days: 14
  },
  return_url: 'https://yoursite.com/success'
});

事前確定済みチェックアウト

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    customer_id: 'cus_existing_customer_id'
  },
  billing_address: {
    street: '123 Main St',
    city: 'San Francisco',
    state: 'CA',
    country: 'US',
    zipcode: '94102'
  },
  confirm: true,
  return_url: 'https://yoursite.com/success'
});

通貨を上書きするチェックアウト

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  billing_currency: 'EUR',
  return_url: 'https://yoursite.com/success'
});

再訪顧客向けの保存済み決済手段

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    customer_id: 'cus_existing_customer_id'
  },
  show_saved_payment_methods: true,
  return_url: 'https://yoursite.com/success'
});

Tax ID収集を伴うB2Bチェックアウト

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_enterprise_plan',
      quantity: 1
    }
  ],
  customer: {
    email: 'procurement@company.com',
    name: 'Jane Smith'
  },
  billing_address: {
    street: '456 Business Ave',
    city: 'London',
    country: 'GB',
    zipcode: 'SW1A 1AA'
  },
  feature_flags: {
    require_tax_id: true
  },
  return_url: 'https://yoursite.com/success'
});

積み重ねた割引コードを使用するダークテーマチェックアウト

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  customization: {
    theme: 'dark'
  },
  discount_codes: ['WELCOME10', 'BLACKFRIDAY20'],
  return_url: 'https://yoursite.com/success'
});

地域別の決済手段（インド向けUPI）

UPIの設定とテストの詳細については、India Payment Methodsページを参照してください。

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  billing_address: {
    street: '123 Main St',
    city: 'Bangalore',
    state: 'KA',
    country: 'IN',
    zipcode: '560001'
  },
  billing_currency: 'INR',
  allowed_payment_method_types: ['upi_intent', 'credit', 'debit'],
  return_url: 'https://yoursite.com/success'
});

BNPL（Buy Now Pay Later）チェックアウト

BNPLの設定とテストの詳細については、Buy Now Pay Later (BNPL)ページを参照してください。

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  allowed_payment_method_types: ['klarna', 'affirm', 'afterpay_clearpay', 'credit', 'debit'],
  return_url: 'https://yoursite.com/success'
});

既存の決済手段を使用したInstant Checkout

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    customer_id: 'cus_existing_customer_id'
  },
  payment_method_id: 'pm_existing_payment_method_id',
  confirm: true,
  return_url: 'https://yoursite.com/success'
});

わかりやすい支払いURLの短縮リンク

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  short_link: true,
  return_url: 'https://yoursite.com/success'
});

支払い成功ページをスキップしてすぐにリダイレクト

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  feature_flags: {
    redirect_immediately: true
  },
  return_url: 'https://yoursite.com/success'
});

言語の強制指定

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  customization: {
    force_language: 'es'
  },
  return_url: 'https://yoursite.com/success'
});

カスタムフィールドの収集

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_123',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe'
  },
  custom_fields: [
    {
      key: 'company_name',
      label: 'Company Name',
      field_type: 'text',
      required: true
    },
    {
      key: 'referral_source',
      label: 'How did you hear about us?',
      field_type: 'dropdown',
      options: ['Google', 'Twitter', 'Friend referral', 'Other'],
      required: true
    }
  ],
  return_url: 'https://yoursite.com/success'
});

チェックアウトセッションのプレビュー

セッションを作成する前に価格、税金、合計を計算するには、Preview Checkout Sessionエンドポイントを使用します。サイトに正確な価格情報を表示する場合に便利です。

プレビューされたcurrent_breakup.subtotalには、商品に適用されるPurchasing Power ParityとCharm Pricingがすでに反映されています。

カートにサブスクリプション商品が含まれる場合、プレビューのレスポンスにはnext_billing_dateも返されます。これは、サブスクリプション作成前に表示できる次回請求日のプレビューです。現在時刻を基準に計算され、トライアルが適用される場合はnow + trial period、それ以外の場合はnow + one payment frequencyになります。単発商品のみのカートでは、このフィールドは省略されます。これはプレビュー時点を基準にした推定値です。正式なnext_billing_dateは、サブスクリプションが有効化された時点で設定されます。

プレビューにはtrial_period_days（無料または有料の実効トライアル期間）と、trial_amount（割引後の単位あたりトライアル料金。価格通貨の最小単位）も含まれます。trial_amountはpaid trialの場合のみ存在し、無料トライアルまたはトライアルなしの場合はnullです。当日に実際に支払う税込み合計にはcurrent_breakupを使用してください。

Node.js SDK
Python SDK
REST API

const preview = await client.checkoutSessions.preview({
  product_cart: [
    { product_id: 'pdt_123', quantity: 1 }
  ],
  billing_address: {
    country: 'US',
    state: 'CA',
    zipcode: '94102'
  },
  discount_codes: ['SAVE20']
});

console.log('Subtotal:', preview.current_breakup.subtotal);
console.log('Tax:', preview.current_breakup.tax);
console.log('Discount:', preview.current_breakup.discount);
console.log('Total:', preview.current_breakup.total_amount);

// Present only when the cart contains a subscription product
console.log('Next billing date:', preview.next_billing_date);

preview = client.checkout_sessions.preview(
    product_cart=[
        {"product_id": "pdt_123", "quantity": 1}
    ],
    billing_address={
        "country": "US",
        "state": "CA",
        "zipcode": "94102"
    },
    discount_codes=["SAVE20"]
)

print(f"Subtotal: {preview.current_breakup.subtotal}")
print(f"Tax: {preview.current_breakup.tax}")
print(f"Discount: {preview.current_breakup.discount}")
print(f"Total: {preview.current_breakup.total_amount}")

# Present only when the cart contains a subscription product
print(f"Next billing date: {preview.next_billing_date}")

curl -X POST https://test.dodopayments.com/checkouts/preview \
  -H "Authorization: Bearer $DODO_PAYMENTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "product_cart": [
      {
        "product_id": "pdt_123",
        "quantity": 1
      }
    ],
    "billing_address": {
      "country": "US",
      "state": "CA",
      "zipcode": "94102"
    },
    "discount_codes": ["SAVE20"]
  }'

Dynamic Linksからの移行

Dynamic Linksを使用している場合、Checkout Sessionsではより柔軟に設定できます。Dynamic Linksでは顧客の完全な請求先住所を指定する必要がありました。Checkout Sessionsでは、把握している情報だけを渡し、残りをチェックアウトフローに収集させることができます。たとえば:

顧客の請求先国だけを指定し、残りの情報をチェックアウトで収集する。
またはすべての情報を指定し、confirm: trueを設定して支払いページへ直接進む。

移行は簡単です。統合をCheckout Sessions APIまたはSDKメソッドを使用するように更新し、リクエストペイロードをCheckout Sessions形式に合わせれば完了です。追加の処理は必要ありません。

Overlay Checkout

ページ上でチェックアウトをモーダルオーバーレイとして開く

Inline Checkout

チェックアウトをページに直接埋め込む

Mobile Integration

ネイティブモバイルアプリにチェックアウトを統合する

Webhooks

支払いおよびサブスクリプションイベントをリッスンする

Payment Methods

地域別の対応決済手段

Subscriptions

継続課金とサブスクリプション管理

Quick Start

API Reference

Preview Endpoint

​Prerequisites

​Creating Your First Checkout Session

​API Response

​Redirect Your Customer

​セッションステータスの確認

​リクエストボディ

​必須フィールド

​オプションフィールド

Country Code Reference

​使用例

​単一商品のシンプルなチェックアウト

​複数商品のカート

​トライアル期間付きサブスクリプション

​事前確定済みチェックアウト

​通貨を上書きするチェックアウト

​再訪顧客向けの保存済み決済手段

​Tax ID収集を伴うB2Bチェックアウト

​積み重ねた割引コードを使用するダークテーマチェックアウト

​地域別の決済手段（インド向けUPI）

​BNPL（Buy Now Pay Later）チェックアウト

​既存の決済手段を使用したInstant Checkout

​わかりやすい支払いURLの短縮リンク

​支払い成功ページをスキップしてすぐにリダイレクト

​言語の強制指定

​カスタムフィールドの収集

​チェックアウトセッションのプレビュー

​Dynamic Linksからの移行

​関連リソース

Overlay Checkout

Inline Checkout

Mobile Integration

Webhooks

Payment Methods

Subscriptions

Prerequisites

Creating Your First Checkout Session

API Response

Redirect Your Customer

セッションステータスの確認

リクエストボディ

必須フィールド

オプションフィールド

使用例

単一商品のシンプルなチェックアウト

複数商品のカート

トライアル期間付きサブスクリプション

事前確定済みチェックアウト

通貨を上書きするチェックアウト

再訪顧客向けの保存済み決済手段

Tax ID収集を伴うB2Bチェックアウト

積み重ねた割引コードを使用するダークテーマチェックアウト

地域別の決済手段（インド向けUPI）

BNPL（Buy Now Pay Later）チェックアウト

既存の決済手段を使用したInstant Checkout

わかりやすい支払いURLの短縮リンク

支払い成功ページをスキップしてすぐにリダイレクト

言語の強制指定

カスタムフィールドの収集

チェックアウトセッションのプレビュー

Dynamic Linksからの移行

関連リソース