Checkout Sessions - Dodo Payments Documentation

Quick Start Guide

Get your first checkout session running in under 5 minutes

API Reference & Live Testing

Explore the full API documentation and interactively test Checkout Session requests and responses.

Preview Checkout

Calculate pricing, taxes, and totals before creating a session.

Session Validity: Checkout sessions are valid for 24 hours by default. If you pass confirm=true in your request, the session will only be valid for 15 minutes.

Prerequisites

Dodo Payments Account

You’ll need an active Dodo Payments merchant account with API access.

API Credentials

Generate your API credentials from the Dodo Payments dashboard:

Products Setup

Create your products in the Dodo Payments dashboard before implementing checkout sessions.

Creating Your First Checkout Session

Node.js SDK
Python SDK
REST API

import DodoPayments from 'dodopayments';

// Initialize the Dodo Payments client
const client = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY,
  environment: 'test_mode', // defaults to 'live_mode'
});

async function createCheckoutSession() {
  try {
    const session = await client.checkoutSessions.create({
      // Products to sell - use IDs from your Dodo Payments dashboard
      product_cart: [
        {
          product_id: 'prod_123', // Replace with your actual product ID
          quantity: 1
        }
      ],
      
      // Pre-fill customer information to reduce friction
      customer: {
        email: 'customer@example.com',
        name: 'John Doe',
        phone_number: '+1234567890'
      },
      
      // Billing address for tax calculation and compliance
      billing_address: {
        street: '123 Main St',
        city: 'San Francisco',
        state: 'CA',
        country: 'US', // Required: ISO 3166-1 alpha-2 country code
        zipcode: '94102'
      },
      
      // Where to redirect after successful payment
      return_url: 'https://yoursite.com/checkout/success',
      
      // Custom data for your internal tracking
      metadata: {
        order_id: 'order_123',
        source: 'web_app'
      }
    });

    // Redirect your customer to this URL to complete payment
    console.log('Checkout URL:', session.checkout_url);
    console.log('Session ID:', session.session_id);
    
    return session;
    
  } catch (error) {
    console.error('Failed to create checkout session:', error);
    throw error;
  }
}

// Example usage in an Express.js route
app.post('/create-checkout', async (req, res) => {
  try {
    const session = await createCheckoutSession();
    res.json({ checkout_url: session.checkout_url });
  } catch (error) {
    res.status(500).json({ error: 'Failed to create checkout session' });
  }
});

import os
from dodopayments import DodoPayments

# Initialize the Dodo Payments client
client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
    environment="test_mode",  # defaults to "live_mode"
)

def create_checkout_session():
    """
    Create a checkout session for a single product with customer data pre-filled.
    Returns the session object containing checkout_url for customer redirection.
    """
    try:
        session = client.checkout_sessions.create(
            # Products to sell - use IDs from your Dodo Payments dashboard
            product_cart=[
                {
                    "product_id": "prod_123",  # Replace with your actual product ID
                    "quantity": 1
                }
            ],
            
            # Pre-fill customer information to reduce checkout friction
            customer={
                "email": "customer@example.com",
                "name": "John Doe",
                "phone_number": "+1234567890"
            },
            
            # Billing address for tax calculation and compliance
            billing_address={
                "street": "123 Main St",
                "city": "San Francisco", 
                "state": "CA",
                "country": "US",  # Required: ISO 3166-1 alpha-2 country code
                "zipcode": "94102"
            },
            
            # Where to redirect after successful payment
            return_url="https://yoursite.com/checkout/success",
            
            # Custom data for your internal tracking
            metadata={
                "order_id": "order_123",
                "source": "web_app"
            }
        )
        
        # Redirect your customer to this URL to complete payment
        print(f"Checkout URL: {session.checkout_url}")
        print(f"Session ID: {session.session_id}")
        
        return session
        
    except Exception as error:
        print(f"Failed to create checkout session: {error}")
        raise error

# Example usage in a Flask route
from flask import Flask, jsonify, request

app = Flask(__name__)

@app.route('/create-checkout', methods=['POST'])
def create_checkout():
    try:
        session = create_checkout_session()
        return jsonify({"checkout_url": session.checkout_url})
    except Exception as error:
        return jsonify({"error": "Failed to create checkout session"}), 500

// Direct API call using fetch - useful for any JavaScript environment
async function createCheckoutSession() {
  try {
    const response = await fetch('https://test.dodopayments.com/checkouts', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${process.env.DODO_PAYMENTS_API_KEY}`
      },
      body: JSON.stringify({
        // Products to sell - use IDs from your Dodo Payments dashboard
        product_cart: [
          {
            product_id: 'prod_123', // Replace with your actual product ID
            quantity: 1
          }
        ],
        
        // Pre-fill customer information to reduce checkout friction
        customer: {
          email: 'customer@example.com',
          name: 'John Doe',
          phone_number: '+1234567890'
        },
        
        // Billing address for tax calculation and compliance
        billing_address: {
          street: '123 Main St',
          city: 'San Francisco',
          state: 'CA', 
          country: 'US', // Required: ISO 3166-1 alpha-2 country code
          zipcode: '94102'
        },
        
        // Where to redirect after successful payment
        return_url: 'https://yoursite.com/checkout/success',
        
        // Custom data for your internal tracking
        metadata: {
          order_id: 'order_123',
          source: 'web_app'
        }
      })
    });

    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }

    const session = await response.json();
    
    // Redirect your customer to this URL to complete payment
    console.log('Checkout URL:', session.checkout_url);
    console.log('Session ID:', session.session_id);
    
    return session;
    
  } catch (error) {
    console.error('Failed to create checkout session:', error);
    throw error;
  }
}

// Example: Redirect user to checkout
createCheckoutSession().then(session => {
  window.location.href = session.checkout_url;
});

API Response

All methods above return the same response structure:

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

Get the checkout URL

Extract the checkout_url from the API response.

Redirect your customer

Direct your customer to the checkout URL to complete their purchase.

// Redirect immediately
window.location.href = session.checkout_url;

// Or open in new window
window.open(session.checkout_url, '_blank');

Alternative Integration Options: Instead of redirecting, you can embed the checkout directly in your page using Overlay Checkout (modal overlay) or Inline Checkout (fully embedded). Both options use the same checkout session URL.

Handle the return

After payment, customers are redirected to your return_url with query parameters including payment/subscription ID, status, customer email, and any license keys. See the return_url parameter docs for the full list.

Request Body

Required Fields

Essential fields needed for every checkout session

Optional Fields

Additional configuration to customize your checkout experience

Required Fields

product_cart

array

wajib

Array of products to include in the checkout session. Each product must have a valid product_id from your Dodo Payments dashboard.

Mixed Checkout: You can combine one-time payment products and subscription products in the same checkout session. This enables powerful use cases like setup fees with subscriptions, hardware bundles with SaaS, and more.

Tampilkan Product Cart Item Properties

product_id

string

wajib

The unique identifier of the product from your Dodo Payments dashboard.Example: "prod_123abc456def"

quantity

integer

wajib

Quantity of the product.Example: 1 for single item, 3 for multiple quantities

addons

array

Array of addons to attach to the product. Only valid if the product is a subscription.

Tampilkan Addon item properties

addon_id

string

wajib

quantity

integer

wajib

amount

integer

Amount the customer pays if pay_what_you_want is enabled. If disabled, this field will be ignored.Format: Represented in the lowest denomination of the currency (e.g., cents for USD). For example, to charge $1.00, pass 100.

credit_entitlements

array

Per-checkout-session overrides for credit entitlements already attached to this product. Use this to grant a different number of credits for this single session — e.g., a promotional bundle that grants 1,000 API credits instead of the product-default 500 — without creating a separate product.

Each credit_entitlement_id must already be attached to the product. This field overrides only the credits_amount granted when this session is fulfilled; product-level credit entitlement settings (expiration, rollover, etc.) still apply.

Tampilkan Credit entitlement override properties

credit_entitlement_id

string

wajib

ID of the credit entitlement to override. Must already be attached to the product.

credits_amount

string

wajib

Number of credits to grant for this checkout session, overriding the product-level credits_amount. Must be greater than zero.

Find Your Product IDs: You can find product IDs in your Dodo Payments dashboard under Products → View Details, or by using the List Products API.

Optional Fields

Configure these fields to customize the checkout experience and add business logic to your payment flow.

Customer Information

customer

object

Customer information. You can either attach an existing customer using their ID or create a new customer record during checkout.

Attach Existing Customer
New Customer

Attach an existing customer to the checkout session using their ID.

Tampilkan Existing Customer Properties

customer_id

string

wajib

The unique identifier of an existing customer. Use this to attach the checkout session to an existing customer instead of creating a new one.

Create a new customer record during checkout.

Tampilkan New Customer Properties

string

wajib

Customer’s email address. Required when creating a new customer.

name

string

Customer’s full name as it should appear on receipts and invoices.Example: "John Doe" or "Jane Smith"

phone_number

string

Customer’s phone number in international format. Required for some payment methods and fraud prevention.Format: Include country code, e.g., "+1234567890" for US numbers

billing_address

object

Billing address information for accurate tax calculation, fraud prevention, and regulatory compliance.

When confirm is set to true, all billing address fields become required for successful session creation.

Tampilkan Billing address object properties

street

string

Complete street address including house number, street name, and apartment/unit number if applicable.Example: "123 Main St, Apt 4B" or "456 Oak Avenue"

city

string

City or municipality name.Example: "San Francisco", "New York", "London"

state

string

State, province, or region name. Use full names or standard abbreviations.Example: "California" or "CA", "Ontario" or "ON"

country

string

wajib

Two-letter ISO country code (ISO 3166-1 alpha-2). This field is always required when billing_address is provided.Examples: "US" (United States), "CA" (Canada), "GB" (United Kingdom), "DE" (Germany)

Country Code Reference

View complete list of supported countries and their ISO codes

zipcode

string

Postal code, ZIP code, or equivalent based on country requirements.Examples: "94102" (US), "M5V 3A8" (Canada), "SW1A 1AA" (UK)

Payment Configuration

allowed_payment_method_types

array

Control which payment methods are available to customers during checkout. This helps optimize for specific markets or business requirements.Available Options: credit, debit, upi_collect, apple_pay, google_pay, amazon_pay, klarna, affirm, afterpay_clearpay, cashapp, multibanco, bancontact_card, eps, ideal, przelewy24, paypal, sunbit

Critical: Always include credit and debit as fallback options to prevent checkout failures when preferred payment methods are unavailable.

Example:

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

billing_currency

string

Override the default currency selection with a fixed billing currency. Uses ISO 4217 currency codes.Supported Currencies: USD, EUR, GBP, CAD, AUD, INR, and moreExample: "USD" for US Dollars, "EUR" for Euros

This field is only effective when adaptive pricing is enabled. If adaptive pricing is disabled, the product’s default currency will be used.

show_saved_payment_methods

boolean

default:"false"

Display previously saved payment methods for returning customers, improving checkout speed and user experience.

Session Management

return_url

string

URL to redirect customers after payment completion. Dodo Payments appends the following query parameters to your URL on redirect:

Parameter	Type	Condition
`payment_id`	`string`	Always present for one-time payments
`subscription_id`	`string`	Always present for subscription payments
`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 URLs:

# 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

Use the license_key and email query parameters to display license keys or send a confirmation immediately on your return page, without needing an extra API call.

cancel_url

string

URL to redirect customers when they click the back button or cancel the checkout session. If not provided, the back button will not be displayed.

Set a cancel_url to give customers a clear way to return to your site without completing the purchase. This improves the checkout experience and reduces friction.

confirm

boolean

default:"false"

If true, finalizes all session details immediately. API will throw an error if required data is missing.

discount_codes

array

Apply one or more stacked discount codes to the checkout session. Codes are applied in array order (the first code reduces the base price, the second reduces the already-discounted price, and so on), up to a maximum of 20 codes per session.

discount_codes: ['WELCOME10', 'BLACKFRIDAY20']

The singular discount_code field below is deprecated but still fully supported — existing integrations continue to work without changes. It cannot be combined with discount_codes in the same request. Migrate to discount_codes when convenient to take advantage of stacking.

discount_code

string

usang

Deprecated — prefer discount_codes for new integrations. This field still works for backward compatibility, but cannot be combined with discount_codes in the same request.

metadata

object

Custom key-value pairs to store additional information about the session.

force_3ds

boolean

Override merchant default 3DS behaviour for this session.

minimal_address

boolean

default:"false"

Enable minimal address collection mode. When enabled, the checkout only collects:

Country: Always required for tax determination
ZIP/Postal code: Only in regions where it’s necessary for sales tax, VAT, or GST calculation

This significantly reduces checkout friction by eliminating unnecessary form fields.

Enable minimal address for faster checkout completion. Full address collection remains available for businesses that require complete billing details.

UI Customization & Features

customization

object

Customize the appearance and behavior of the checkout interface.

Tampilkan Customization object properties

theme

string

default:"system"

Theme for the checkout interface. Options: light, dark, or system.

show_order_details

boolean

default:"true"

Display order details section in the checkout interface.

show_on_demand_tag

boolean

default:"true"

Show the “on-demand” tag for applicable products.

force_language

string

Force the checkout interface to render in a specific language. By default, the checkout auto-detects the customer’s browser language.Supported language codes: ar (Arabic), ca (Catalan), de (German), en (English), es (Spanish), fr (French), he (Hebrew), id (Indonesian), it (Italian), ja (Japanese), ko (Korean), ms (Malay), nl (Dutch), pl (Polish), pt (Portuguese), ro (Romanian), ru (Russian), sv (Swedish), th (Thai), tr (Turkish), zh (Chinese)Example: "es" for Spanish, "ja" for Japanese

feature_flags

object

Configure specific features and behaviors for the checkout session.

Tampilkan Feature flags object properties

allow_currency_selection

boolean

default:"true"

Allow customers to select their preferred currency during checkout.

allow_discount_code

boolean

default:"true"

Show discount code input field in the checkout interface.

allow_editing_addons

boolean

default:"false"

Izinkan pelanggan untuk menambahkan atau menghapus addon pada produk berlangganan selama checkout. Hanya berlaku untuk produk berlangganan.

allow_phone_number_collection

boolean

default:"true"

Kumpulkan nomor telepon pelanggan selama checkout.

allow_tax_id

boolean

default:"true"

Izinkan pelanggan untuk memasukkan nomor identifikasi pajak.

always_create_new_customer

boolean

default:"false"

Paksa pembuatan catatan pelanggan baru alih-alih memperbarui yang sudah ada.

allow_customer_editing_email

boolean

Izinkan pelanggan untuk mengedit alamat email mereka selama checkout.

allow_customer_editing_name

boolean

Izinkan pelanggan untuk mengedit nama mereka selama checkout.

allow_customer_editing_street

boolean

Izinkan pelanggan untuk mengedit alamat jalan selama checkout.

allow_customer_editing_city

boolean

Izinkan pelanggan untuk mengedit kota selama checkout.

allow_customer_editing_state

boolean

Izinkan pelanggan untuk mengedit negara bagian selama checkout.

allow_customer_editing_country

boolean

Izinkan pelanggan untuk mengedit negara selama checkout.

allow_customer_editing_zipcode

boolean

Izinkan pelanggan untuk mengedit kode pos selama checkout.

redirect_immediately

boolean

default:"false"

Lewati halaman sukses pembayaran default dan alihkan pelanggan segera ke return_url setelah penyelesaian pembayaran.

Gunakan ini ketika Anda memiliki halaman sukses kustom yang memberikan pengalaman pengguna lebih baik, atau untuk aplikasi seluler dan alur checkout tertanam.

Custom Fields

custom_fields

array

Kumpulkan informasi tambahan dari pelanggan selama checkout dengan bidang formulir kustom. Anda dapat mendefinisikan hingga 5 bidang kustom per sesi checkout. Respon pelanggan disertakan dalam payload webhook dan tersedia melalui API.

Tampilkan Custom field object properties

key

string

wajib

Pengenal unik untuk bidang ini. Digunakan sebagai kunci dalam payload webhook dan respons API.Contoh: "company_name", "referral_source", "team_size"

label

string

wajib

Label tampilan ditampilkan kepada pelanggan pada formulir checkout.Contoh: "Company Name", "How did you hear about us?", "Team Size"

field_type

string

wajib

Tipe bidang menentukan aturan validasi input.Jenis yang Tersedia:

text - Masukan teks satu baris
number - Masukan numerik
email - Alamat email dengan validasi
url - URL dengan validasi
date - Pemilih tanggal
dropdown - Pilih dari opsi yang telah ditentukan
boolean - Toggle Ya/Tidak

required

boolean

default:"false"

Apakah bidang ini harus diisi sebelum checkout dapat diselesaikan.

placeholder

string

Teks placeholder ditampilkan di bidang input.

options

array

Daftar opsi untuk tipe bidang dropdown. Diperlukan saat field_type adalah dropdown, diabaikan untuk jenis lain.Contoh: ["Google", "Twitter", "Friend referral", "Other"]

Respon pelanggan terhadap bidang kustom disertakan dalam:

Webhooks: payment.succeeded, subscription.active, dan payload acara relevan lainnya mengandung array custom_field_responses
Respons API: Objek pembayaran dan langganan mencakup custom_field_responses

Subscription Configuration

subscription_data

object

Konfigurasi tambahan untuk sesi checkout yang berisi produk berlangganan.

Tampilkan Subscription data object properties

trial_period_days

integer

Jumlah hari untuk periode percobaan sebelum biaya pertama. Harus antara 0 dan 10000 hari.

on_demand

object

Konfigurasi langganan on-demand untuk penagihan berdasarkan penggunaan atau penghitungan.

Tampilkan On-demand object properties

mandate_only

boolean

wajib

Jika diatur ke true, tidak melakukan biaya apa pun dan hanya mengotorisasikan rincian metode pembayaran untuk penggunaan di masa depan.

product_price

integer

Harga produk untuk biaya awal kepada pelanggan. Jika tidak ditentukan, harga produk yang disimpan akan digunakan.Format: Dinyatakan dalam nilai terendah mata uang (misalnya, sen untuk USD). Misalnya, untuk biaya $ 1,00, masukkan 100.

product_currency

string

Mata uang produk opsional. Jika tidak ditentukan, akan menggunakan mata uang produk.

product_description

string

Deskripsi produk opsional yang dapat diganti untuk penagihan dan item baris. Jika tidak ditentukan, deskripsi produk yang disimpan akan digunakan.

adaptive_currency_fees_inclusive

boolean

Apakah biaya mata uang adaptif harus dimasukkan dalam harga produk (true) atau ditambahkan di atasnya (false). Diabaikan jika harga adaptif tidak diaktifkan.

Contoh Penggunaan

Berikut adalah 10 contoh komprehensif yang menunjukkan berbagai konfigurasi sesi checkout untuk berbagai skenario bisnis:

1. Checkout Produk Tunggal Sederhana

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

2. Keranjang Multi-Produk

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_laptop',
      quantity: 1
    },
    {
      product_id: 'prod_mouse',
      quantity: 2
    },
    {
      product_id: 'prod_warranty',
      quantity: 1
    }
  ],
  customer: {
    email: 'customer@example.com',
    name: 'John Doe',
    phone_number: '+1234567890'
  },
  billing_address: {
    street: '123 Tech Street',
    city: 'San Francisco',
    state: 'CA',
    country: 'US',
    zipcode: '94102'
  },
  return_url: 'https://electronics-store.com/order-confirmation'
});

3. Langganan dengan Periode Percobaan

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_monthly_plan',
      quantity: 1
    }
  ],
  subscription_data: {
    trial_period_days: 14
  },
  customer: {
    email: 'user@startup.com',
    name: 'Jane Smith'
  },
  return_url: 'https://saas-app.com/onboarding',
  metadata: {
    plan_type: 'professional',
    referral_source: 'google_ads'
  }
});

4. Checkout yang Dikonfirmasi Sebelumnya

Ketika confirm diatur ke true, pelanggan akan langsung dibawa ke halaman checkout, melewati langkah konfirmasi.

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_premium_course',
      quantity: 1
    }
  ],
  customer: {
    email: 'student@university.edu',
    name: 'Alex Johnson',
    phone_number: '+1555123456'
  },
  billing_address: {
    street: '456 University Ave',
    city: 'Boston',
    state: 'MA',
    country: 'US',
    zipcode: '02134'
  },
  confirm: true,
  return_url: 'https://learning-platform.com/course-access',
  metadata: {
    course_category: 'programming',
    enrollment_date: '2024-01-15'
  }
});

5. Checkout dengan Override Mata Uang

Override billing_currency hanya berlaku ketika mata uang adaptif diaktifkan di pengaturan akun Anda. Jika mata uang adaptif dinonaktifkan, parameter ini tidak akan berpengaruh.

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_consulting_service',
      quantity: 1
    }
  ],
  customer: {
    email: 'client@company.co.uk',
    name: 'Oliver Williams'
  },
  billing_address: {
    street: '789 Business Park',
    city: 'London',
    state: 'England',
    country: 'GB',
    zipcode: 'SW1A 1AA'
  },
  billing_currency: 'GBP',
  feature_flags: {
    allow_currency_selection: true,
    allow_tax_id: true
  },
  return_url: 'https://consulting-firm.com/service-confirmation'
});

6. Metode Pembayaran Tersimpan untuk Pelanggan yang Kembali

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_monthly_subscription',
      quantity: 1
    }
  ],
  customer: {
    email: 'returning.customer@example.com',
    name: 'Robert Johnson',
    phone_number: '+1555987654'
  },
  show_saved_payment_methods: true,
  feature_flags: {
    allow_phone_number_collection: true,
    always_create_new_customer: false
  },
  return_url: 'https://subscription-service.com/welcome-back',
  metadata: {
    customer_tier: 'premium',
    account_age: 'returning'
  }
});

7. Checkout B2B dengan Pengumpulan ID Pajak

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_enterprise_license',
      quantity: 5
    }
  ],
  customer: {
    email: 'procurement@enterprise.com',
    name: 'Sarah Davis',
    phone_number: '+1800555000'
  },
  billing_address: {
    street: '1000 Corporate Blvd',
    city: 'New York',
    state: 'NY',
    country: 'US',
    zipcode: '10001'
  },
  feature_flags: {
    allow_tax_id: true,
    allow_phone_number_collection: true,
    always_create_new_customer: false
  },
  return_url: 'https://enterprise-software.com/license-delivery',
  metadata: {
    customer_type: 'enterprise',
    contract_id: 'ENT-2024-001',
    sales_rep: 'john.sales@company.com'
  }
});

8. Checkout Tema Gelap dengan Kode Diskon Tumpuk

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_gaming_chair',
      quantity: 1
    }
  ],
  discount_codes: ['BLACKFRIDAY2024'],
  customization: {
    theme: 'dark',
    show_order_details: true,
    show_on_demand_tag: false
  },
  feature_flags: {
    allow_discount_code: true
  },
  customer: {
    email: 'gamer@example.com',
    name: 'Mike Chen'
  },
  return_url: 'https://gaming-store.com/order-complete'
});

9. Metode Pembayaran Regional (UPI untuk India)

Untuk informasi mendetail tentang konfigurasi dan pengujian UPI, lihat halaman Metode Pembayaran India.

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_online_course_hindi',
      quantity: 1
    }
  ],
  allowed_payment_method_types: [
    'upi_collect',
    'credit',
    'debit'
  ],
  customer: {
    email: 'student@example.in',
    name: 'Priya Sharma',
    phone_number: '+919876543210'
  },
  billing_address: {
    street: 'MG Road',
    city: 'Bangalore',
    state: 'Karnataka',
    country: 'IN',
    zipcode: '560001'
  },
  billing_currency: 'INR',
  return_url: 'https://education-platform.in/course-access',
  metadata: {
    region: 'south_india',
    language: 'hindi'
  }
});

10. BNPL (Beli Sekarang Bayar Nanti) Checkout

Untuk informasi mendetail tentang configurasi dan pengujian BNPL, lihat halaman Beli Sekarang Bayar Nanti (BNPL).

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_luxury_watch',
      quantity: 1
    }
  ],
  allowed_payment_method_types: [
    'klarna',
    'afterpay_clearpay',
    'credit',
    'debit'
  ],
  customer: {
    email: 'fashion.lover@example.com',
    name: 'Emma Thompson',
    phone_number: '+1234567890'
  },
  billing_address: {
    street: '555 Fashion Ave',
    city: 'Los Angeles',
    state: 'CA',
    country: 'US',
    zipcode: '90210'
  },
  feature_flags: {
    allow_phone_number_collection: true
  },
  return_url: 'https://luxury-store.com/purchase-confirmation',
  metadata: {
    product_category: 'luxury',
    price_range: 'high_value'
  }
});

11. Menggunakan Metode Pembayaran yang Ada untuk Checkout Instan

Gunakan metode pembayaran yang disimpan pelanggan untuk membuat sesi checkout yang diproses segera, melewati pengumpulan metode pembayaran:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_premium_plan',
      quantity: 1
    }
  ],
  customer: {
    customer_id: 'cus_123'  // Required when using payment_method_id
  },
  payment_method_id: 'pm_abc123',  // Use customer's saved payment method
  confirm: true,  // Required when using payment_method_id
  return_url: 'https://yourapp.com/success'
});

Ketika menggunakan payment_method_id, confirm harus diatur ke true dan customer_id yang sudah ada harus disediakan. Metode pembayaran akan divalidasi untuk kelayakan dengan mata uang pembayaran.

Metode pembayaran harus menjadi milik pelanggan dan kompatibel dengan mata uang pembayaran. Ini memungkinkan pembelian satu klik untuk pelanggan yang kembali.

12. Tautan Pendek untuk URL Pembayaran yang Lebih Bersih

Buat tautan pembayaran pendek yang dapat dibagikan dengan slug kustom:

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

// The checkout_url will be a shortened, cleaner link
console.log(session.checkout_url);  // e.g., https://checkout.dodopayments.com/buy/abc123

Tautan pendek sangat cocok untuk berbagi melalui SMS, email, atau media sosial. Mereka lebih mudah diingat dan membangun kepercayaan pelanggan lebih baik daripada URL panjang.

13. Lewati Halaman Sukses Pembayaran dengan Pengalihan Langsung

Alihkan pelanggan segera setelah penyelesaian pembayaran, melewati halaman sukses default:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_digital_product',
      quantity: 1
    }
  ],
  feature_flags: {
    redirect_immediately: true  // Skip success page, redirect immediately
  },
  return_url: 'https://yourapp.com/success',
  customer: {
    email: 'customer@example.com',
    name: 'Jane Smith'
  }
});

Gunakan redirect_immediately: true saat Anda memiliki halaman sukses kustom yang memberikan pengalaman pengguna lebih baik daripada halaman sukses pembayaran default. Ini sangat berguna untuk aplikasi seluler dan alur checkout tertanam.

Saat redirect_immediately diaktifkan, pelanggan dialihkan ke return_url segera setelah penyelesaian pembayaran, melewati halaman sukses default sepenuhnya.

14. Memaksa Bahasa

Paksakan checkout untuk ditampilkan dalam bahasa tertentu, menggantikan deteksi bahasa browser pelanggan:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_subscription',
      quantity: 1
    }
  ],
  customization: {
    force_language: 'ja'  // Force Japanese language
  },
  customer: {
    email: 'customer@example.jp',
    name: 'Tanaka Yuki'
  },
  return_url: 'https://yourapp.com/success'
});

Gunakan force_language saat Anda tahu bahasa pilihan pelanggan (misalnya, dari pengaturan akun mereka) atau saat menargetkan pasar regional tertentu.

Bahasa yang Didukung: Arabic (ar), Catalan (ca), Chinese (zh), Dutch (nl), English (en), French (fr), German (de), Hebrew (he), Indonesian (id), Italian (it), Japanese (ja), Korean (ko), Malay (ms), Polish (pl), Portuguese (pt), Romanian (ro), Russian (ru), Spanish (es), Swedish (sv), Thai (th), Turkish (tr)

15. Mengumpulkan Bidang Kustom

Kumpulkan informasi tambahan dari pelanggan selama checkout menggunakan bidang kustom:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'prod_saas_plan',
      quantity: 1
    }
  ],
  custom_fields: [
    {
      key: 'company_name',
      label: 'Company Name',
      field_type: 'text',
      required: true,
      placeholder: 'Acme Inc.'
    },
    {
      key: 'team_size',
      label: 'Team Size',
      field_type: 'dropdown',
      required: true,
      options: ['1-10', '11-50', '51-200', '201-500', '500+']
    },
    {
      key: 'referral_source',
      label: 'How did you hear about us?',
      field_type: 'dropdown',
      required: false,
      options: ['Google', 'Twitter', 'Friend referral', 'Blog post', 'Other']
    },
    {
      key: 'website',
      label: 'Company Website',
      field_type: 'url',
      required: false,
      placeholder: 'https://example.com'
    }
  ],
  customer: {
    email: 'buyer@company.com',
    name: 'Jane Doe'
  },
  return_url: 'https://yourapp.com/success'
});

Respon bidang kustom otomatis disertakan dalam payload webhook (payment.succeeded, subscription.active, dll.) dan dapat diambil melalui API. Gunakan mereka untuk memperkaya CRM Anda, memicu alur onboarding, atau menyesuaikan pengalaman pelanggan.

Jenis bidang tersedia: text, number, email, url, date, dropdown, boolean

Pratinjau Sesi Checkout

Sebelum membuat sesi checkout, Anda dapat mempratinjau rincian harga termasuk pajak, diskon, dan total. Ini berguna untuk menampilkan harga yang akurat kepada pelanggan sebelum mereka melanjutkan ke checkout.

Node.js SDK
Python SDK

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

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

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

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

Preview API Reference

Lihat dokumentasi endpoint pratinjau lengkap.

Berpindah dari Tautan Dinamis ke Sesi Checkout

Perbedaan Kunci

Sebelumnya, saat membuat tautan pembayaran dengan Tautan Dinamis, Anda diharuskan menyediakan alamat penagihan lengkap pelanggan. Dengan Sesi Checkout, hal ini tidak lagi diperlukan. Anda dapat menyampaikan informasi apa pun yang Anda miliki, dan kami akan menanganinya. Sebagai contoh:

Jika Anda hanya mengetahui negara penagihan pelanggan, hanya berikan itu.
Alur checkout secara otomatis akan mengumpulkan detail yang hilang sebelum memindahkan pelanggan ke halaman pembayaran.
Di sisi lain, jika Anda sudah memiliki semua informasi yang diperlukan dan ingin langsung ke halaman pembayaran, Anda dapat menyampaikan data lengkap dan menyertakan confirm=true dalam body permintaan Anda.

Proses Migrasi

Migrasi dari Tautan Dinamis ke Sesi Checkout adalah mudah:

Update your integration

Perbarui integrasi Anda untuk menggunakan metode API atau SDK yang baru.

Adjust request payload

Sesuaikan payload permintaan sesuai dengan format Sesi Checkout.

That's it!

Ya. Tidak diperlukan penanganan tambahan atau langkah migrasi khusus di pihak Anda.

Referensi API Terkait

Create Checkout Session

Referensi API lengkap untuk membuat sesi checkout dengan semua parameter dan opsi yang tersedia

Preview Checkout Session

Referensi API untuk pratinjau harga, pajak, dan total sebelum membuat sesi

Quick Start Guide

API Reference & Live Testing

Preview Checkout

​Prerequisites

​Creating Your First Checkout Session

​API Response

​Request Body

Required Fields

Optional Fields

​Required Fields

​Optional Fields

Country Code Reference

​Contoh Penggunaan

​1. Checkout Produk Tunggal Sederhana

​2. Keranjang Multi-Produk

​3. Langganan dengan Periode Percobaan

​4. Checkout yang Dikonfirmasi Sebelumnya

​5. Checkout dengan Override Mata Uang

​6. Metode Pembayaran Tersimpan untuk Pelanggan yang Kembali

​7. Checkout B2B dengan Pengumpulan ID Pajak

​8. Checkout Tema Gelap dengan Kode Diskon Tumpuk

​9. Metode Pembayaran Regional (UPI untuk India)

​10. BNPL (Beli Sekarang Bayar Nanti) Checkout

​11. Menggunakan Metode Pembayaran yang Ada untuk Checkout Instan

​12. Tautan Pendek untuk URL Pembayaran yang Lebih Bersih

​13. Lewati Halaman Sukses Pembayaran dengan Pengalihan Langsung

​14. Memaksa Bahasa

​15. Mengumpulkan Bidang Kustom

​Pratinjau Sesi Checkout

Preview API Reference

​Berpindah dari Tautan Dinamis ke Sesi Checkout

​Perbedaan Kunci

​Proses Migrasi

​Referensi API Terkait

Create Checkout Session

Preview Checkout Session

Prerequisites

Creating Your First Checkout Session

API Response

Request Body

Required Fields

Optional Fields

Contoh Penggunaan

1. Checkout Produk Tunggal Sederhana

2. Keranjang Multi-Produk

3. Langganan dengan Periode Percobaan

4. Checkout yang Dikonfirmasi Sebelumnya

5. Checkout dengan Override Mata Uang

6. Metode Pembayaran Tersimpan untuk Pelanggan yang Kembali

7. Checkout B2B dengan Pengumpulan ID Pajak

8. Checkout Tema Gelap dengan Kode Diskon Tumpuk

9. Metode Pembayaran Regional (UPI untuk India)

10. BNPL (Beli Sekarang Bayar Nanti) Checkout

11. Menggunakan Metode Pembayaran yang Ada untuk Checkout Instan

12. Tautan Pendek untuk URL Pembayaran yang Lebih Bersih

13. Lewati Halaman Sukses Pembayaran dengan Pengalihan Langsung

14. Memaksa Bahasa

15. Mengumpulkan Bidang Kustom

Pratinjau Sesi Checkout

Berpindah dari Tautan Dinamis ke Sesi Checkout

Perbedaan Kunci

Proses Migrasi

Referensi API Terkait