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

obligatorisk

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.

Visa Product Cart Item Properties

product_id

string

obligatorisk

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

quantity

integer

obligatorisk

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.

Visa Addon item properties

addon_id

string

obligatorisk

quantity

integer

obligatorisk

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.

Visa Credit entitlement override properties

credit_entitlement_id

string

obligatorisk

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

credits_amount

string

obligatorisk

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.

Visa Existing Customer Properties

customer_id

string

obligatorisk

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.

Visa New Customer Properties

string

obligatorisk

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.

Visa 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

obligatorisk

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

standard:"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

standard:"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

föråldrad

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

standard:"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.

Visa Customization object properties

theme

string

standard:"system"

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

show_order_details

boolean

standard:"true"

Display order details section in the checkout interface.

show_on_demand_tag

boolean

standard:"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.

Visa Feature flags object properties

allow_currency_selection

boolean

standard:"true"

Allow customers to select their preferred currency during checkout.

allow_discount_code

boolean

standard:"true"

Show discount code input field in the checkout interface.

allow_editing_addons

boolean

standard:"false"

Tillåt kunder att lägga till eller ta bort tillägg på en prenumerationsprodukt under kassan. Gäller endast prenumerationsprodukter.

allow_phone_number_collection

boolean

standard:"true"

Samla in kundens telefonnummer under kassan.

allow_tax_id

boolean

standard:"true"

Tillåt kunder att ange skatteidentifikationsnummer.

always_create_new_customer

boolean

standard:"false"

Tvinga fram skapande av en ny kundpost istället för att uppdatera befintliga.

allow_customer_editing_email

boolean

Tillåt kunder att redigera sin e-postadress under kassan.

allow_customer_editing_name

boolean

Tillåt kunder att redigera sitt namn under kassan.

allow_customer_editing_street

boolean

Tillåt kunder att redigera gatuadressen under kassan.

allow_customer_editing_city

boolean

Tillåt kunder att redigera staden under kassan.

allow_customer_editing_state

boolean

Tillåt kunder att redigera staten under kassan.

allow_customer_editing_country

boolean

Tillåt kunder att redigera landet under kassan.

allow_customer_editing_zipcode

boolean

Tillåt kunder att redigera postnumret under kassan.

redirect_immediately

boolean

standard:"false"

Hoppa över standardsidan för betalningsframgång och omdirigera kunder omedelbart till din return_url efter slutförd betalning.

Använd detta när du har en anpassad framgångssida som ger en bättre användarupplevelse, eller för mobilappar och inbäddade kassa-flöden.

Custom Fields

custom_fields

array

Samla in ytterligare information från kunder under kassan med anpassade formulärfält. Du kan definiera upp till 5 anpassade fält per kassasession. Kundsvar inkluderas i webhook-payloads och är tillgängliga via API:et.

Visa Custom field object properties

key

string

obligatorisk

Unik identifierare för detta fält. Används som nyckel i webhook-payloads och API-svar.Exempel: "company_name", "referral_source", "team_size"

label

string

obligatorisk

Displayetikett som visas för kunden på kassans formulär.Exempel: "Company Name", "How did you hear about us?", "Team Size"

field_type

string

obligatorisk

Typ av fält som bestämmer regler för inmatningsvalidering.Tillgängliga typer:

text - Enkelradig textinmatning
number - Numerisk inmatning
email - E-postadress med validering
url - URL med validering
date - Datumväljare
dropdown - Välj från fördefinierade alternativ
boolean - Ja/Nej-omkopplare

required

boolean

standard:"false"

Huruvida detta fält måste fyllas i innan kassan kan slutföras.

placeholder

string

Placholdertext som visas i inmatningsfältet.

options

array

Lista över alternativ för dropdown fälttyp. Krävs när field_type är dropdown, ignoreras för andra typer.Exempel: ["Google", "Twitter", "Friend referral", "Other"]

Kundsvar på anpassade fält inkluderas i:

Webhooks: payment.succeeded, subscription.active, och andra relevanta händelse-payloads innehåller custom_field_responses fältet
API-svar: Betalnings- och prenumerationsobjekt inkluderar custom_field_responses

Subscription Configuration

subscription_data

object

Ytterligare konfiguration för kassasessioner som innehåller prenumerationsprodukter.

Visa Subscription data object properties

trial_period_days

integer

Antal dagar för provperioden innan första debiteringen. Måste vara mellan 0 och 10000 dagar.

on_demand

object

On-demand prenumerationskonfiguration för användningsbaserad eller mätardebitering.

Visa On-demand object properties

mandate_only

boolean

obligatorisk

Om satt till true, utförs ingen debitering och endast betalningsmetodens detaljer godkänns för framtida användning.

product_price

integer

Produktpris för den initiala debiteringen till kunden. Om det inte specificeras används produktens lagrade pris.Format: Representeras i den lägsta valören av valutan (t.ex. cent för USD). Till exempel, för att debitera $1.00, ange 100.

product_currency

string

Valuta för produktpriset, valfritt. Om det inte anges standardiseras det till produktens valuta.

product_description

string

Valfri produktbeskrivningsöversikt för fakturering och radposter. Om det inte anges används produktens lagrade beskrivning.

adaptive_currency_fees_inclusive

boolean

Huruvida anpassade valutakurser ska inkluderas i produktpriset (true) eller läggas till (false). Ignoreras om adaptiv prissättning inte är aktiverad.

Användnings Exempel

Här är 10 omfattande exempel som visar olika konfigurationer av kassasessioner för olika affärsscenarier:

1. Enkel Produktkassa

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. Flera Produkter i Varukorgen

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. Prenumeration med Proveriod

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. Förkonfirmerad Kassa

När confirm är inställt på true, kommer kunden att tas direkt till kassasidan, och eventuella bekräftelsesteg förbikopplas.

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. Kassa med Valutaöverskrivning

billing_currency överskrivning träder i kraft endast när adaptiv valuta är aktiverad i dina kontoinställningar. Om adaptiv valuta är avaktiverad, kommer denna parameter inte att ha någon effekt.

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. Sparade Betalningsmetoder för Återkommande Kunder

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. B2B Kassa med Insamling av Skatte-ID

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. Mörkt Tema Kassa med Staplade Rabattkoder

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. Regionala Betalningsmetoder (UPI för Indien)

För detaljerad information om UPI-konfiguration och testning, se sidan India Payment Methods.

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 (Buy Now Pay Later) Kassa

För detaljerad information om BNPL-konfiguration och testning, se sidan Buy Now Pay Later (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. Använda Befintliga Betalningsmetoder för Omedelbar Kassa

Använd en kunds sparade betalningsmetod för att skapa en kassasession som behandlas omedelbart, och hoppar över samlingen av betalningsmetoder:

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'
});

När du använder payment_method_id, måste confirm ställas in på true och en befintlig customer_id måste tillhandahållas. Betalningsmetoden verifieras för behörighet med betalningens valuta.

Betalningsmetoden måste tillhöra kunden och vara kompatibel med betalningens valuta. Detta möjliggör ett-klicks köp för återkommande kunder.

12. Kortlänkar för Renare Betalnings-URLer

Generera förkortade, delbara betalningslänkar med anpassade slugs:

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

Kortlänkar är perfekta för SMS, e-post eller sociala medier. De är lättare att komma ihåg och skapar mer förtroende hos kunder jämfört med långa URLer.

13. Hoppa över Betalningsframgångssida med Omedelbar Omdirigering

Omdirigera kunder omedelbart efter betalningsslutförande, hoppa över standardsidan för betalningsframgång:

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'
  }
});

Använd redirect_immediately: true när du har en anpassad framgångssida som ger en bättre användarupplevelse än standardsidan för betalningsframgång. Detta är särskilt användbart för mobilappar och inbäddade kassaflöden.

När redirect_immediately är aktiverad, omdirigeras kunden till din return_url direkt efter betalningsslutförande, och hoppar över standardsidan för betalningsframgång helt.

14. Tvinga språkval

Tvinga kassan att visa på ett specifikt språk och ignorera kundens webbläsares språkinställningar:

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'
});

Använd force_language när du känner till kundens föredragna språk (t.ex. från deras kontoinställningar) eller när du riktar dig mot specifika regionala marknader.

Stödda språk: Arabiska (ar), Katalanska (ca), Kinesiska (zh), Nederländska (nl), Engelska (en), Franska (fr), Tyska (de), Hebreiska (he), Indonesiska (id), Italienska (it), Japanska (ja), Koreanska (ko), Malayiska (ms), Polska (pl), Portugisiska (pt), Rumänska (ro), Ryska (ru), Spanska (es), Svenska (sv), Thailändska (th), Turkiska (tr)

15. Insamling av Anpassade Fält

Samla in ytterligare information från kunder under kassan med anpassade fält:

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'
});

Anpassade fält svar inkluderas automatiskt i webhook-payloads (payment.succeeded, subscription.active, etc.) och kan hämtas via API:et. Använd dem för att berika ditt CRM, utlösa onboarding-flöden eller anpassa kundupplevelsen.

Tillgängliga fälttyper: text, number, email, url, date, dropdown, boolean

Förhandsvisning av Kassasessioner

Innan du skapar en kassasession kan du förhandsgranska prisuppdelningen inklusive skatter, rabatter och summor. Detta är användbart för att visa kunderna korrekta priser innan de går vidare till kassan.

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

Visa den fullständiga dokumentationen för förhandsvisningsendpunkt.

Flytta från Dynamiska Länkar till Kassasessioner

Nyckelskillnader

Tidigare, när du skapade en betalningslänk med Dynamiska Länkar, krävdes det att du angav kundens kompletta faktureringsadress. Med Kassasessioner är detta inte längre nödvändigt. Du kan helt enkelt skicka in den information du har, så tar vi hand om resten. Till exempel:

Om du bara känner till kundens faktureringland, ange bara det.
Kassaflödet kommer automatiskt att samla in de saknade detaljerna innan kunden flyttas till betalningssidan.
Å andra sidan, om du redan har all nödvändig information och vill gå direkt till betalningssidan, kan du skicka hela datasetet och inkludera confirm=true i kroppens begäran.

Migrationsprocess

Att flytta från Dynamiska Länkar till Kassasessioner är enkelt:

Update your integration

Uppdatera din integration för att använda den nya API- eller SDK-metoden.

Adjust request payload

Justera begärandens payload enligt Kassasessionernas format.

That's it!

Ja. Ingen ytterligare hantering eller speciella migrationssteg behövs från din sida.

Relaterad API-Referens

Create Checkout Session

Komplett API-referens för att skapa kassasessioner med alla tillgängliga parametrar och alternativ

Preview Checkout Session

API-referens för att förhandsgranska priser, skatter och summor innan du skapar en session

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

​Användnings Exempel

​1. Enkel Produktkassa

​2. Flera Produkter i Varukorgen

​3. Prenumeration med Proveriod

​4. Förkonfirmerad Kassa

​5. Kassa med Valutaöverskrivning

​6. Sparade Betalningsmetoder för Återkommande Kunder

​7. B2B Kassa med Insamling av Skatte-ID

​8. Mörkt Tema Kassa med Staplade Rabattkoder

​9. Regionala Betalningsmetoder (UPI för Indien)

​10. BNPL (Buy Now Pay Later) Kassa

​11. Använda Befintliga Betalningsmetoder för Omedelbar Kassa

​12. Kortlänkar för Renare Betalnings-URLer

​13. Hoppa över Betalningsframgångssida med Omedelbar Omdirigering

​14. Tvinga språkval

​15. Insamling av Anpassade Fält

​Förhandsvisning av Kassasessioner

Preview API Reference

​Flytta från Dynamiska Länkar till Kassasessioner

​Nyckelskillnader

​Migrationsprocess

​Relaterad API-Referens

Create Checkout Session

Preview Checkout Session

Prerequisites

Creating Your First Checkout Session

API Response

Request Body

Required Fields

Optional Fields

Användnings Exempel

1. Enkel Produktkassa

2. Flera Produkter i Varukorgen

3. Prenumeration med Proveriod

4. Förkonfirmerad Kassa

5. Kassa med Valutaöverskrivning

6. Sparade Betalningsmetoder för Återkommande Kunder

7. B2B Kassa med Insamling av Skatte-ID

8. Mörkt Tema Kassa med Staplade Rabattkoder

9. Regionala Betalningsmetoder (UPI för Indien)

10. BNPL (Buy Now Pay Later) Kassa

11. Använda Befintliga Betalningsmetoder för Omedelbar Kassa

12. Kortlänkar för Renare Betalnings-URLer

13. Hoppa över Betalningsframgångssida med Omedelbar Omdirigering

14. Tvinga språkval

15. Insamling av Anpassade Fält

Förhandsvisning av Kassasessioner

Flytta från Dynamiska Länkar till Kassasessioner

Nyckelskillnader

Migrationsprocess

Relaterad API-Referens