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

requerido

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.

Mostrar Product Cart Item Properties

product_id

string

requerido

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

quantity

integer

requerido

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.

Mostrar Addon item properties

addon_id

string

requerido

quantity

integer

requerido

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.

Mostrar Credit entitlement override properties

credit_entitlement_id

string

requerido

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

credits_amount

string

requerido

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.

Mostrar Existing Customer Properties

customer_id

string

requerido

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.

Mostrar New Customer Properties

string

requerido

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.

Mostrar 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

requerido

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

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

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

obsoleto

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

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

Mostrar Customization object properties

theme

string

predeterminado:"system"

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

show_order_details

boolean

predeterminado:"true"

Display order details section in the checkout interface.

show_on_demand_tag

boolean

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

Mostrar Feature flags object properties

allow_currency_selection

boolean

predeterminado:"true"

Allow customers to select their preferred currency during checkout.

allow_discount_code

boolean

predeterminado:"true"

Show discount code input field in the checkout interface.

allow_editing_addons

boolean

predeterminado:"false"

Permite a los clientes agregar o quitar complementos en un producto de suscripción durante el proceso de pago. Solo se aplica a productos de suscripción.

allow_phone_number_collection

boolean

predeterminado:"true"

Recoge números de teléfono de clientes durante el proceso de pago.

allow_tax_id

boolean

predeterminado:"true"

Permite a los clientes ingresar números de identificación fiscal.

always_create_new_customer

boolean

predeterminado:"false"

Forza la creación de un nuevo registro de cliente en lugar de actualizar los existentes.

allow_customer_editing_email

boolean

Permite a los clientes editar su dirección de correo electrónico durante el proceso de pago.

allow_customer_editing_name

boolean

Permite a los clientes editar su nombre durante el proceso de pago.

allow_customer_editing_street

boolean

Permite a los clientes editar la dirección durante el proceso de pago.

allow_customer_editing_city

boolean

Permite a los clientes editar la ciudad durante el proceso de pago.

allow_customer_editing_state

boolean

Permite a los clientes editar el estado durante el proceso de pago.

allow_customer_editing_country

boolean

Permite a los clientes editar el país durante el proceso de pago.

allow_customer_editing_zipcode

boolean

Permite a los clientes editar el código postal durante el proceso de pago.

redirect_immediately

boolean

predeterminado:"false"

Omite la página de éxito de pago predeterminada y redirige a los clientes inmediatamente a tu return_url después de completar el pago.

Usa esto cuando tengas una página de éxito personalizada que proporcione una mejor experiencia de usuario, o para aplicaciones móviles y flujos de pago integrados.

Custom Fields

custom_fields

array

Recoge información adicional de los clientes durante el proceso de pago con campos de formulario personalizados. Puedes definir hasta 5 campos personalizados por sesión de pago. Las respuestas de los clientes están incluidas en cargas útiles de webhook y disponibles a través de la API.

Mostrar Custom field object properties

key

string

requerido

Identificador único para este campo. Se usa como clave en cargas útiles de webhook y respuestas de API.Ejemplo: "company_name", "referral_source", "team_size"

label

string

requerido

Etiqueta de visualización mostrada al cliente en el formulario de pago.Ejemplo: "Company Name", "How did you hear about us?", "Team Size"

field_type

string

requerido

Tipo de campo que determina las reglas de validación de entrada.Tipos disponibles:

text - Entrada de texto de una sola línea
number - Entrada numérica
email - Dirección de correo electrónico con validación
url - URL con validación
date - Selector de fecha
dropdown - Selección de opciones predefinidas
boolean - Alternar Sí/No

required

boolean

predeterminado:"false"

Si este campo debe completarse antes de poder finalizar el proceso de pago.

placeholder

string

Texto de marcador de posición mostrado en el campo de entrada.

options

array

Lista de opciones para el tipo de campo dropdown. Requerido cuando field_type es dropdown, ignorado para otros tipos.Ejemplo: ["Google", "Twitter", "Friend referral", "Other"]

Las respuestas de los clientes a campos personalizados están incluidas en:

Webhooks: payment.succeeded, subscription.active y otras cargas útiles de eventos relevantes contienen el array custom_field_responses
Respuestas de API: Los objetos de pago y suscripción incluyen custom_field_responses

Subscription Configuration

subscription_data

object

Configuración adicional para sesiones de pago que contienen productos de suscripción.

Mostrar Subscription data object properties

trial_period_days

integer

Número de días para el periodo de prueba antes del primer cargo. Debe estar entre 0 y 10000 días.

on_demand

object

Configuración de suscripción bajo demanda para facturación basada en uso o medida.

Mostrar On-demand object properties

mandate_only

boolean

requerido

Si se establece en verdadero, no se realiza ningún cargo y solo se autorizan los detalles del método de pago para uso futuro.

product_price

integer

Precio del producto para el cargo inicial al cliente. Si no se especifica, se usará el precio almacenado del producto.Formato: Representado en la denominación más baja de la moneda (por ejemplo, centavos para USD). Por ejemplo, para cobrar $1.00, pasa 100.

product_currency

string

Moneda opcional del precio del producto. Si no se especifica, el valor predeterminado es la moneda del producto.

product_description

string

Descripción opcional del producto que anula la factura y las líneas de artículos. Si no se especifica, se usará la descripción almacenada del producto.

adaptive_currency_fees_inclusive

boolean

Si las tarifas de moneda adaptable deben incluirse en el precio del producto (verdadero) o añadirse por separado (falso). Ignorado si la cotización adaptable no está habilitada.

Ejemplos de Uso

Aquí tienes 10 ejemplos comprensivos que muestran diferentes configuraciones de sesiones de pago para varios escenarios de negocio:

1. Pago de Producto Único Simple

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. Carrito de Múltiples Productos

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. Suscripción con Periodo de Prueba

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. Pago Preconfirmado

Cuando confirm se establece en true, el cliente será llevado directamente a la página de pago, omitiendo cualquier paso de confirmación.

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. Pago con Anulación de Moneda

La anulación billing_currency solo tiene efecto cuando la moneda adaptable está habilitada en la configuración de tu cuenta. Si la moneda adaptable está deshabilitada, este parámetro no tendrá efecto.

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. Métodos de Pago Guardados para Clientes que Regresan

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. Pago B2B con Colección de ID Fiscal

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. Pago en Tema Oscuro con Códigos de Descuento Apilados

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. Métodos de Pago Regionales (UPI para India)

Para información detallada sobre la configuración y pruebas de UPI, consulta la página de Métodos de Pago en 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 (Compra Ahora, Paga Después) Pago

Para información detallada sobre la configuración y pruebas de BNPL, consulta la página de Compra Ahora, Paga Después (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. Usando Métodos de Pago Existentes para Perfilado de Pago

Usa un método de pago guardado del cliente para crear una sesión de pago que procese inmediatamente, omitiendo la colección de método de pago:

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

Cuando uses payment_method_id, confirm debe establecerse en true y debe proporcionarse un customer_id existente. El método de pago será validado para su elegibilidad con la moneda del pago.

El método de pago debe pertenecer al cliente y ser compatible con la moneda del pago. Esto permite compras con un clic para clientes que regresan.

12. Enlaces Cortos para URLs de Pago Más Limpias

Genera enlaces de pago acortados y compartibles con slugs personalizados:

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

Los enlaces cortos son perfectos para compartir por SMS, correo electrónico o redes sociales. Son más fáciles de recordar y generan más confianza entre los clientes que las URLs largas.

13. Omitir la Página de Éxito de Pago con Redirección Inmediata

Redirige a los clientes inmediatamente después de completar el pago, omitiendo la página de éxito predeterminada:

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

Utiliza redirect_immediately: true cuando tengas una página de éxito personalizada que proporcione una mejor experiencia de usuario que la página de éxito de pago predeterminada. Esto es especialmente útil para aplicaciones móviles y flujos de pago integrados.

Cuando redirect_immediately está habilitado, los clientes son redirigidos a tu return_url inmediatamente después de completar el pago, omitiendo completamente la página de éxito predeterminada.

14. Forzar un Idioma

Forza al pago a mostrarse en un idioma específico, sobrescribiendo la detección del idioma del navegador del cliente:

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

Utiliza force_language cuando sepas el idioma preferido de tu cliente (por ejemplo, desde la configuración de su cuenta) o al dirigirse a mercados regionales específicos.

Idiomas soportados: Árabe (ar), Catalán (ca), Chino (zh), Holandés (nl), Inglés (en), Francés (fr), Alemán (de), Hebreo (he), Indonesio (id), Italiano (it), Japonés (ja), Coreano (ko), Malayo (ms), Polaco (pl), Portugués (pt), Rumano (ro), Ruso (ru), Español (es), Sueco (sv), Tailandés (th), Turco (tr)

15. Recolectando Campos Personalizados

Recoge información adicional de los clientes durante el proceso de pago usando campos personalizados:

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

Las respuestas a los campos personalizados se incluyen automáticamente en las cargas útiles de webhook (payment.succeeded, subscription.active, etc.) y se pueden recuperar a través de la API. Úsalas para enriquecer tu CRM, activar flujos de incorporación o personalizar la experiencia del cliente.

Tipos de campo disponibles: text, number, email, url, date, dropdown, boolean

Previsualización de Sesiones de Pago

Antes de crear una sesión de pago, puedes previsualizar el desglose de precios, incluidos impuestos, descuentos y totales. Esto es útil para mostrar precios precisos a los clientes antes de que procedan al pago.

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

Consulta la documentación completa del endpoint de previsualización.

Pasar de Enlaces Dinámicos a Sesiones de Pago

Principales Diferencias

Anteriormente, al crear un enlace de pago con Enlaces Dinámicos, se requería proporcionar la dirección de facturación completa del cliente. Con las Sesiones de Pago, esto ya no es necesario. Puedes simplemente pasar la información que tengas, y nosotros nos encargamos del resto. Por ejemplo:

Si solo conoces el país de facturación del cliente, simplemente proporciona eso.
El flujo de pago recopilará automáticamente los detalles faltantes antes de pasar al cliente a la página de pago.
Por otro lado, si ya tienes toda la información requerida y deseas pasar directamente a la página de pago, puedes pasar el conjunto de datos completo e incluir confirm=true en tu cuerpo de solicitud.

Proceso de Migración

La migración de Enlaces Dinámicos a Sesiones de Pago es sencilla:

Update your integration

Actualiza tu integración para usar el nuevo método API o SDK.

Adjust request payload

Ajusta la carga útil de la solicitud según el formato de Sesiones de Pago.

That's it!

Sí. No se necesitan manejos adicionales o pasos especiales de migración de tu parte.

Referencia de API Relacionada

Create Checkout Session

Referencia completa de la API para crear sesiones de pago con todos los parámetros y opciones disponibles

Preview Checkout Session

Referencia de API para previsualizar precios, impuestos y totales antes de crear una sesión

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

​Ejemplos de Uso

​1. Pago de Producto Único Simple

​2. Carrito de Múltiples Productos

​3. Suscripción con Periodo de Prueba

​4. Pago Preconfirmado

​5. Pago con Anulación de Moneda

​6. Métodos de Pago Guardados para Clientes que Regresan

​7. Pago B2B con Colección de ID Fiscal

​8. Pago en Tema Oscuro con Códigos de Descuento Apilados

​9. Métodos de Pago Regionales (UPI para India)

​10. BNPL (Compra Ahora, Paga Después) Pago

​11. Usando Métodos de Pago Existentes para Perfilado de Pago

​12. Enlaces Cortos para URLs de Pago Más Limpias

​13. Omitir la Página de Éxito de Pago con Redirección Inmediata

​14. Forzar un Idioma

​15. Recolectando Campos Personalizados

​Previsualización de Sesiones de Pago

Preview API Reference

​Pasar de Enlaces Dinámicos a Sesiones de Pago

​Principales Diferencias

​Proceso de Migración

​Referencia de API Relacionada

Create Checkout Session

Preview Checkout Session

Prerequisites

Creating Your First Checkout Session

API Response

Request Body

Required Fields

Optional Fields

Ejemplos de Uso

1. Pago de Producto Único Simple

2. Carrito de Múltiples Productos

3. Suscripción con Periodo de Prueba

4. Pago Preconfirmado

5. Pago con Anulación de Moneda

6. Métodos de Pago Guardados para Clientes que Regresan

7. Pago B2B con Colección de ID Fiscal

8. Pago en Tema Oscuro con Códigos de Descuento Apilados

9. Métodos de Pago Regionales (UPI para India)

10. BNPL (Compra Ahora, Paga Después) Pago

11. Usando Métodos de Pago Existentes para Perfilado de Pago

12. Enlaces Cortos para URLs de Pago Más Limpias

13. Omitir la Página de Éxito de Pago con Redirección Inmediata

14. Forzar un Idioma

15. Recolectando Campos Personalizados

Previsualización de Sesiones de Pago

Pasar de Enlaces Dinámicos a Sesiones de Pago

Principales Diferencias

Proceso de Migración

Referencia de API Relacionada