Checkout Sessions

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.

Engångslänkar: checkout_url som returneras av API:et kan inte återanvändas och upphör att gälla inom 24 timmar (eller 15 minuter när confirm=true). Den är avsedd för att en enskild kund ska slutföra en betalning. Generera en ny checkout-session för varje kund och varje betalningsförsök i stället för att dela eller återanvända en länk.

Förutsättningar

Dodo Payments Account

Du behöver ett aktivt Merchant-konto hos Dodo Payments med API-åtkomst.

API Credentials

Generera dina API-autentiseringsuppgifter från Dodo Payments-dashboarden:

Products Setup

Skapa dina produkter i Dodo Payments-dashboarden innan du implementerar checkout-sessioner.

Skapa din första 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: 'pdt_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": "pdt_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: 'pdt_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-svar

Alla metoder ovan returnerar samma svarsstruktur:

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

Endast session_id garanteras finnas med. Två fall returnerar ytterligare eller färre fält:

payment_method_id angavs — debiteringen behandlas omedelbart och checkout_url är null. Använd i stället den returnerade payment_id.
confirm: true skapade betalningen när sessionen skapades — svaret innehåller även payment_id, client_secret och publishable_key för användning med Dodo Payments checkout SDK.

Den genererade checkout_url kan endast användas en gång och upphör att gälla inom 24 timmar. Cachelagra eller återanvänd den inte mellan kunder eller betalningsförsök — skapa en ny checkout-session när du behöver en ny länk.

Get the checkout URL

Hämta checkout_url från API-svaret.

Redirect your customer

Skicka kunden till checkout-URL:en för att slutföra köpet.

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

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

Alternativa integrationsalternativ: I stället för att omdirigera kan du bädda in checkout direkt på sidan med Overlay Checkout (modal överlagring) eller Inline Checkout (helt inbäddad). I en inbyggd mobilapp skickar du samma URL till Mobile Checkout SDKs för Android, iOS, React Native eller Flutter. Alla dessa använder samma checkout-session-URL.

Handle the return

Efter betalningen omdirigeras kunderna till din return_url med frågeparametrar som bland annat innehåller betalnings-/prenumerations-ID, status, kundens e-postadress och eventuella licensnycklar. Se dokumentationen för parametrarna i return_url för en fullständig lista.

Request Body

Required Fields

Obligatoriska fält som behövs för varje checkout-session

Optional Fields

Ytterligare konfiguration för att anpassa checkout-upplevelsen

Obligatoriska fält

array

obligatorisk

Array med produkter som ska inkluderas i checkout-sessionen. Varje produkt måste ha ett giltigt product_id från din Dodo Payments-dashboard.

Blandad checkout: Du kan kombinera engångsbetalningsprodukter och prenumerationsprodukter i samma checkout-session. Det möjliggör användningsfall som startavgifter tillsammans med prenumerationer, hårdvarupaket med SaaS och mycket mer.

Visa Product Cart Item Properties

string

obligatorisk

Den unika identifieraren för produkten från din Dodo Payments-dashboard.Exempel: "pdt_123abc456def"

integer

obligatorisk

Produktens antal.Exempel: 1 för en enskild artikel, 3 för flera antal

array

Array med tillägg som ska kopplas till produkten. Gäller endast om produkten är en prenumeration.

Visa Addon item properties

string

obligatorisk

integer

obligatorisk

integer

Beloppet kunden betalar när pay_what_you_want är aktiverat. Om det är inaktiverat ignoreras detta fält.Format: Anges i valutans minsta valör (t.ex. cent för USD). För att ta ut 1,00 USD skickar du 100.

array

Åsidosättningar per checkout-session för kreditförmåner som redan är kopplade till denna produkt. Använd detta för att tilldela ett annat antal krediter för just denna session — till exempel ett kampanjpaket som ger 1 000 API-krediter i stället för produktens standard på 500 — utan att skapa en separat produkt.

Varje credit_entitlement_id måste redan vara kopplad till produkten. Detta fält åsidosätter endast credits_amount som tilldelas när sessionen fullföljs; inställningarna för kreditförmånen på produktnivå (utgång, överföring och så vidare) gäller fortfarande.

Visa Credit entitlement override properties

string

obligatorisk

ID för kreditförmånen som ska åsidosättas. Måste redan vara kopplad till produkten.

string

obligatorisk

Antalet krediter som ska tilldelas för denna checkout-session, vilket åsidosätter produktnivåns credits_amount. Måste vara större än noll.

Hitta dina produkt-ID:n: Du hittar produkt-ID:n i din Dodo Payments-dashboard under Products → View Details eller genom att använda List Products API.

Valfria fält

Konfigurera dessa fält för att anpassa checkout-upplevelsen och lägga till affärslogik i ditt betalningsflöde.

Customer Information

object

Kundinformation. Du kan antingen koppla en befintlig kund med deras ID eller skapa en ny kundpost under checkout.

Attach Existing Customer
New Customer

Koppla en befintlig kund till checkout-sessionen med deras ID.

Visa Existing Customer Properties

string

obligatorisk

Den unika identifieraren för en befintlig kund. Använd detta för att koppla checkout-sessionen till en befintlig kund i stället för att skapa en ny.

Skapa en ny kundpost under checkout.

Visa New Customer Properties

string

obligatorisk

Kundens e-postadress. Krävs när en ny kund skapas.

string

Kundens fullständiga namn så som det ska visas på kvitton och fakturor.Exempel: "John Doe" eller "Jane Smith"

string

Kundens telefonnummer i internationellt format. Krävs för vissa betalningsmetoder och förebyggande av bedrägerier.Format: Inkludera landskod, till exempel "+1234567890" för amerikanska nummer

object

Faktureringsadress för korrekt skatteberäkning, förebyggande av bedrägerier och efterlevnad av regelverk.

När confirm anges till true blir alla fält för faktureringsadress obligatoriska för att sessionen ska kunna skapas.

Visa Billing address object properties

string

Fullständig gatuadress inklusive husnummer, gatunamn och lägenhets-/enhetsnummer om tillämpligt.Exempel: "123 Main St, Apt 4B" eller "456 Oak Avenue"

string

Namn på stad eller kommun.Exempel: "San Francisco", "New York", "London"

string

Namn på delstat, provins eller region. Använd fullständiga namn eller standardförkortningar.Exempel: "California" eller "CA", "Ontario" eller "ON"

string

obligatorisk

Tvåbokstavs ISO-landskod (ISO 3166-1 alpha-2). Detta fält är alltid obligatoriskt när billing_address anges.Exempel: "US" (USA), "CA" (Kanada), "GB" (Storbritannien), "DE" (Tyskland)

Country Code Reference

Visa en fullständig lista över länder som stöds och deras ISO-koder

string

Postnummer, ZIP-kod eller motsvarande enligt landets krav.Exempel: "94102" (USA), "M5V 3A8" (Kanada), "SW1A 1AA" (Storbritannien)

Payment Configuration

array

Styr vilka betalningsmetoder som är tillgängliga för kunder under checkout. Detta hjälper dig att optimera för specifika marknader eller affärskrav.Vanliga alternativ: credit, debit, upi_collect, apple_pay, google_pay, amazon_pay, klarna, affirm, afterpay_clearpay, cashapp, ach, multibanco, bancontact_card, eps, ideal, blik, paypal. Detta är inte hela uppsättningen – se API-referensen för Create Checkout Session för alla accepterade värden.

Viktigt: Inkludera alltid credit och debit som reservalternativ för att förhindra checkout-fel när önskade betalningsmetoder inte är tillgängliga.

Exempel:

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

string

Åsidosätt standardvalet av valuta med en fast faktureringsvaluta. Använder ISO 4217-valutakoder.Valutor som stöds: USD, EUR, GBP, CAD, AUD, INR och flerExempel: "USD" för amerikanska dollar, "EUR" för euro

Detta fält har endast effekt när adaptiv prissättning är aktiverad. Om adaptiv prissättning är inaktiverad används produktens standardvaluta.

boolean

standard:"false"

Visa tidigare sparade betalningsmetoder för återkommande kunder, vilket förbättrar checkout-hastigheten och användarupplevelsen.

Session Management

string

URL dit kunderna omdirigeras efter att betalningen har slutförts. Dodo Payments lägger till följande frågeparametrar i din URL vid omdirigering:

Parameter	Type	Condition
`payment_id`	`string`	Finns alltid för engångsbetalningar
`subscription_id`	`string`	Finns alltid för prenumerationsbetalningar
`status`	`string`	Finns alltid
`license_key`	`string`	Finns om produkten har licensnycklar aktiverade. Kommaseparerad om flera nycklar finns
`email`	`string`	Finns om kunden har en registrerad e-postadress

Exempel på omdirigerings-URL:er:

# 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

Använd frågeparametrarna license_key och email för att visa licensnycklar eller skicka en bekräftelse direkt på din retursida utan att behöva göra ett extra API-anrop.

string

URL dit kunderna omdirigeras när de klickar på bakåtknappen eller avbryter checkout-sessionen. Om den inte anges visas ingen bakåtknapp.

Ange en cancel_url för att ge kunderna ett tydligt sätt att återvända till din webbplats utan att slutföra köpet. Detta förbättrar checkout-upplevelsen och minskar friktionen.

boolean

standard:"false"

Om true slutförs alla sessionsuppgifter omedelbart. API:t genererar ett fel om obligatoriska uppgifter saknas.

array

Tillämpa en eller flera staplade rabattkoder på checkout-sessionen. Koderna tillämpas i arrayordning (den första koden minskar grundpriset, den andra minskar det redan rabatterade priset och så vidare), med högst 20 koder per session.

discount_codes: ['WELCOME10', 'BLACKFRIDAY20']

Det enskilda fältet discount_code nedan är föråldrat men stöds fortfarande fullt ut — befintliga integrationer fortsätter att fungera utan ändringar. Det kan inte kombineras med discount_codes i samma begäran. Migrera till discount_codes när det passar för att kunna använda stapling.

string

föråldrad

Föråldrat — använd helst discount_codes för nya integrationer. Fältet fungerar fortfarande av bakåtkompatibilitetsskäl men kan inte kombineras med discount_codes i samma begäran.

object

Egna nyckel-värde-par för att lagra ytterligare information om sessionen.

boolean

Åsidosätt handlarens standardbeteende för 3DS för denna session.

boolean

standard:"false"

Aktivera läget för insamling av minimal adress. När det är aktiverat samlar checkout endast in:

Land: Alltid obligatoriskt för skattebestämning
ZIP-/postnummer: Endast i regioner där det behövs för beräkning av sales tax, VAT eller GST

Detta minskar checkout-friktionen avsevärt genom att onödiga formulärfält tas bort.

Aktivera minimal adress för snabbare slutförande av checkout. Fullständig adressinsamling är fortfarande tillgänglig för företag som behöver fullständiga faktureringsuppgifter.

string

En sparad betalningsmetod som tillhör den kopplade kunden. Kräver confirm: true och en befintlig customer.customer_id. När den anges behandlas debiteringen omedelbart och checkout_url returneras som null — använd i stället den returnerade payment_id.

boolean

standard:"false"

Om true returneras en förkortad checkout-URL i stället för den fullständiga sessions-URL:en.

string

Produktinsamlings-ID för den samlingsbaserade checkout-processen.

string

Skatte-ID för kunden (till exempel ett VAT-nummer). Kräver billing_address med en country.

string

Valfritt företags- eller juridiskt namn som är kopplat till skatte-ID:t. När det anges tillsammans med en giltig tax_id visas det på fakturan i stället för kundens personliga namn.

integer

Åsidosätt handlarens mandatgolv på nivå för INR (i paise) för INR-e-mandat på indiska kort.

UI Customization & Features

object

Anpassa checkout-gränssnittets utseende och beteende.

Visa Customization object properties

string

standard:"system"

Tema för checkout-gränssnittet. Alternativen är light, dark eller system.

boolean

standard:"true"

Visa avsnittet med orderdetaljer i checkout-gränssnittet.

boolean

standard:"true"

Visa taggen “on-demand” för tillämpliga produkter.

string

Tvinga checkout-gränssnittet att återges på ett specifikt språk. Som standard identifierar checkout automatiskt kundens webbläsarspråk.Språkkoder som stöds: ar (arabiska), ca (katalanska), de (tyska), en (engelska), es (spanska), fr (franska), he (hebreiska), id (indonesiska), it (italienska), ja (japanska), ko (koreanska), ms (malajiska), nl (nederländska), pl (polska), pt (portugisiska), ro (rumänska), ru (ryska), sv (svenska), th (thailändska), tr (turkiska), zh (kinesiska)Exempel: "es" för spanska, "ja" för japanska

object

Anpassad temakonfiguration med färger för ljust och mörkt läge, typsnitt och knappformat. Detta är ersättningen på serversidan för det föråldrade klientalternativet themeConfig.

Visa Theme config properties

object

Färgkonfiguration för ljust läge.

object

Färgkonfiguration för mörkt läge.

string

URL för det primära typsnittet. Måste vara en giltig URL för https://.

string

URL för det sekundära typsnittet. Måste vara en giltig URL för https://.

string

Teckenstorlek för checkout-gränssnittet. Alternativen är xs, sm, md, lg, xl och 2xl.

string

Tyngd för checkout-gränssnittets teckensnitt. Alternativen är normal, medium, bold och extraBold.

string

Anpassad text för betalningsknappen (till exempel "Complete Purchase" eller "Subscribe Now"). Högst 100 tecken.

string

Hörnradie för UI-element. Ett tal följt av px, rem eller em (till exempel "4px", "0.5rem", "1em").

object

Konfigurera specifika funktioner och beteenden för checkout-sessionen.

Visa Feature flags object properties

boolean

standard:"true"

Tillåt kunder att välja önskad valuta under checkout.

boolean

standard:"true"

Visa fältet för rabattkod i checkout-gränssnittet.

boolean

standard:"false"

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

boolean

standard:"true"

Samla in kundernas telefonnummer under checkout.

boolean

standard:"false"

Kräv att kunden anger ett telefonnummer för att slutföra checkout. Kräver även att allow_phone_number_collection är true.

boolean

standard:"true"

Tillåt kunder att ange skatteidentifieringsnummer.

boolean

standard:"false"

Tvinga fram skapandet av en ny kundpost i stället för att uppdatera befintliga poster.

boolean

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

boolean

Tillåt kunder att redigera sitt namn under checkout.

boolean

Tillåt kunder att redigera gatuadressen under checkout.

boolean

Tillåt kunder att redigera staden under checkout.

boolean

Tillåt kunder att redigera delstaten under checkout.

boolean

Tillåt kunder att redigera landet under checkout.

boolean

Tillåt kunder att redigera postnumret under checkout.

boolean

Tillåt kunder att ange eller redigera sitt skatte-ID under checkout.

boolean

standard:"false"

Tillåt kunden att ange eller redigera företagsnamnet som är kopplat till skatte-ID:t. Fungerar oberoende av allow_customer_editing_tax_id — endera flaggan (eller allow_tax_id) räcker. Anges vanligtvis tillsammans med allow_customer_editing_tax_id.

boolean

standard:"false"

Hoppa över standardsidan för lyckad betalning och omdirigera kunderna direkt till din return_url efter att betalningen har slutförts.

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

Custom Fields

array

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

Visa Custom field object properties

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"

string

obligatorisk

Visningsetikett som visas för kunden i checkout-formuläret.Exempel: "Company Name", "How did you hear about us?", "Team Size"

string

obligatorisk

Fälttyp som avgör reglerna för indatavalidering.Tillgängliga typer:

text - Textinmatning på en rad
number - Numerisk inmatning
email - E-postadress med validering
url - URL med validering
date - Datumväljare
dropdown - Välj bland fördefinierade alternativ
boolean - Ja/Nej-växlare

boolean

standard:"false"

Om detta fält måste fyllas i innan checkout kan slutföras.

string

Platshållartext som visas i inmatningsfältet.

array

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

Kundernas svar på anpassade fält inkluderas i:

Webhooks: payment.succeeded, subscription.active och andra relevanta händelsepayloads innehåller arrayen custom_field_responses
API-svar: Betalnings- och prenumerationsobjekt innehåller custom_field_responses

Subscription Configuration

object

Ytterligare konfiguration för checkout-sessioner som innehåller prenumerationsprodukter.

Visa Subscription data object properties

integer

Antalet dagar i provperioden före den första debiteringen. Måste vara mellan 0 och 10 000 dagar.Ett betalt provbelopp kan inte anges per session — konfigurera i stället trial_amount för produktens återkommande pris. Se Paid Trials.

object

Konfiguration av on-demand-prenumeration för användningsbaserad eller mätarbaserad fakturering.

Visa On-demand object properties

boolean

obligatorisk

Om true utförs ingen debitering och endast betalningsmetodens uppgifter auktoriseras för framtida användning.

integer

Produktpris för den ursprungliga debiteringen av kunden. Om det inte anges används produktens lagrade pris.Format: Anges i valutans minsta valör (t.ex. cent för USD). För att ta ut 1,00 USD skickar du 100.

string

Valfri valuta för produktpriset. Om den inte anges används produktens valuta som standard.

string

Valfri åsidosättning av produktbeskrivningen för fakturering och radposter. Om den inte anges används produktens lagrade beskrivning.

boolean

Om avgifter för adaptiv valuta ska inkluderas i produktpriset (true) eller läggas ovanpå (false). Ignoreras om adaptiv prissättning inte är aktiverad.

Användningsexempel

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

1. Enkel checkout med en produkt

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

2. Varukorg med flera produkter

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_laptop',
      quantity: 1
    },
    {
      product_id: 'pdt_mouse',
      quantity: 2
    },
    {
      product_id: 'pdt_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 provperiod

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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örbekräftad checkout

När confirm anges till true skickas kunden direkt till checkout-sidan, förbi alla bekräftelsesteg.

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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 med åsidosättning av valuta

Åsidosättningen billing_currency får endast effekt när adaptiv valuta är aktiverad i kontoinställningarna. Om adaptiv valuta är inaktiverad har denna parameter ingen effekt.

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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: 'pdt_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-checkout med insamling av skatte-ID

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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 med mörkt tema och staplade rabattkoder

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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)

Detaljerad information om konfiguration och testning av UPI finns på sidan India Payment Methods.

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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-checkout (Buy Now Pay Later)

Detaljerad information om konfiguration och testning av BNPL finns på sidan Buy Now Pay Later (BNPL).

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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 checkout

Använd en kunds sparade betalningsmetod för att skapa en checkout-session som behandlas omedelbart och hoppa över insamlingen av betalningsmetod:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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 payment_method_id används måste confirm anges till true och en befintlig customer_id tillhandahållas. Betalningsmetoden valideras för kompatibilitet med betalningens valuta. Eftersom debiteringen behandlas omedelbart returneras checkout_url som null — använd i stället den returnerade payment_id.

Betalningsmetoden måste tillhöra kunden och vara kompatibel med betalningsvalutan. Detta möjliggör köp med ett klick för återkommande kunder.

12. Korta länkar för renare betalnings-URL:er

Generera förkortade, delningsbara betalningslänkar med anpassade sluggar:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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

Korta länkar passar perfekt för SMS, e-post eller delning i sociala medier. De är lättare att komma ihåg och skapar större förtroende hos kunderna än långa URL:er.

13. Hoppa över sidan för lyckad betalning med omedelbar omdirigering

Omdirigera kunderna direkt efter att betalningen har slutförts och hoppa över standardsidan för lyckad betalning:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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 lyckad-sida som ger en bättre användarupplevelse än standardsidan för lyckad betalning. Detta är särskilt användbart för mobilappar och inbäddade checkout-flöden.

När redirect_immediately är aktiverat omdirigeras kunderna till din return_url direkt efter att betalningen har slutförts, vilket helt hoppar över standardsidan för lyckad betalning.

14. Tvinga fram ett språk

Tvinga checkout att visas på ett specifikt språk och åsidosätt kundens webbläsarbaserade språkinställning:

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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 önskade språk (till exempel från kontoinställningarna) eller när du riktar dig mot specifika regionala marknader.

Språk som stöds: 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), malajiska (ms), polska (pl), portugisiska (pt), rumänska (ro), ryska (ru), spanska (es), svenska (sv), thailändska (th), turkiska (tr)

15. Samla in anpassade fält

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

const session = await client.checkoutSessions.create({
  product_cart: [
    {
      product_id: 'pdt_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'
});

Svar på anpassade fält inkluderas automatiskt i webhook-payloads (payment.succeeded, subscription.active och så vidare) och kan hämtas via API:t. 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örhandsgranska checkout-sessioner

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

När varukorgen innehåller en prenumerationsprodukt returnerar förhandsgranskningssvaret även en next_billing_date — en förhandsgranskning av det kommande faktureringsdatumet, så att du kan visa det innan prenumerationen skapas. Det beräknas i förhållande till nu: now + trial period när en provperiod gäller, annars now + one payment frequency. Fältet utelämnas för varukorgar som endast innehåller engångsköp. Detta är en uppskattning baserad på tiden för förhandsgranskningen; det auktoritativa next_billing_date anges när prenumerationen aktiveras.

Förhandsgranskningen returnerar även trial_period_days (den effektiva provperiodens längd, kostnadsfri eller betald) och trial_amount (debiteringen per enhet under provperioden efter rabatter, i prisvalutans minsta enheter). trial_amount finns endast för en betald provperiod och är null för en kostnadsfri provperiod eller ingen provperiod. Använd current_breakup för den beskattade totalsumma som faktiskt ska betalas idag.

Node.js SDK
Python SDK

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

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

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

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

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

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

Preview API Reference

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

Flytta från Dynamic Links till Checkout Sessions

Viktiga skillnader

Tidigare, när du skapade en betalningslänk med Dynamic Links, var du tvungen att ange kundens fullständiga faktureringsadress. Med Checkout Sessions är detta inte längre nödvändigt. Du kan helt enkelt skicka den information du har, så hanterar vi resten. Till exempel:

Om du bara känner till kundens faktureringsland anger du bara det.
Checkout-flödet samlar automatiskt in de uppgifter som saknas innan kunden skickas till betalningssidan.
Om du däremot redan har all obligatorisk information och vill hoppa direkt till betalningssidan kan du skicka hela datauppsättningen och inkludera confirm=true i request body.

Migreringsprocess

Att migrera från Dynamic Links till Checkout Sessions är enkelt:

Update your integration

Uppdatera din integration så att den använder den nya API- eller SDK-metoden.

Adjust request payload

Anpassa request payload enligt formatet för Checkout Sessions.

That's it!

Ja. Inga ytterligare åtgärder eller särskilda migreringssteg krävs från din sida.

Relaterad API-referens

Create Checkout Session

Fullständig API-referens för att skapa checkout-sessioner med alla tillgängliga parametrar och alternativ

Preview Checkout Session

API-referens för att förhandsgranska priser, skatter och totalsummor innan en session skapas

Integration Guides

Billing Deconstructions

Cookbooks

Quick Start Guide

API Reference & Live Testing

Preview Checkout

Förutsättningar

Skapa din första checkout-session

API-svar

Request Body

Required Fields

Optional Fields

Obligatoriska fält

Valfria fält

Country Code Reference

Användningsexempel

1. Enkel checkout med en produkt

2. Varukorg med flera produkter

3. Prenumeration med provperiod

4. Förbekräftad checkout

5. Checkout med åsidosättning av valuta

6. Sparade betalningsmetoder för återkommande kunder

7. B2B-checkout med insamling av skatte-ID

8. Checkout med mörkt tema och staplade rabattkoder

9. Regionala betalningsmetoder (UPI för Indien)

10. BNPL-checkout (Buy Now Pay Later)

11. Använda befintliga betalningsmetoder för omedelbar checkout

12. Korta länkar för renare betalnings-URL:er

13. Hoppa över sidan för lyckad betalning med omedelbar omdirigering

14. Tvinga fram ett språk

15. Samla in anpassade fält

Förhandsgranska checkout-sessioner

Preview API Reference

Flytta från Dynamic Links till Checkout Sessions

Viktiga skillnader

Migreringsprocess

Relaterad API-referens

Create Checkout Session

Preview Checkout Session

Quick Start Guide

API Reference & Live Testing

Preview Checkout

​Förutsättningar

​Skapa din första checkout-session

​API-svar

​Request Body

Required Fields

Optional Fields

​Obligatoriska fält

​Valfria fält

Country Code Reference

​Användningsexempel

​1. Enkel checkout med en produkt

​2. Varukorg med flera produkter

​3. Prenumeration med provperiod

​4. Förbekräftad checkout

​5. Checkout med åsidosättning av valuta

​6. Sparade betalningsmetoder för återkommande kunder

​7. B2B-checkout med insamling av skatte-ID

​8. Checkout med mörkt tema och staplade rabattkoder

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

​10. BNPL-checkout (Buy Now Pay Later)

​11. Använda befintliga betalningsmetoder för omedelbar checkout

​12. Korta länkar för renare betalnings-URL:er

​13. Hoppa över sidan för lyckad betalning med omedelbar omdirigering

​14. Tvinga fram ett språk

​15. Samla in anpassade fält

​Förhandsgranska checkout-sessioner

Preview API Reference

​Flytta från Dynamic Links till Checkout Sessions

​Viktiga skillnader

​Migreringsprocess

​Relaterad API-referens

Create Checkout Session

Preview Checkout Session

Förutsättningar

Skapa din första checkout-session

API-svar

Request Body

Obligatoriska fält

Valfria fält

Användningsexempel

1. Enkel checkout med en produkt

2. Varukorg med flera produkter

3. Prenumeration med provperiod

4. Förbekräftad checkout

5. Checkout med åsidosättning av valuta

6. Sparade betalningsmetoder för återkommande kunder

7. B2B-checkout med insamling av skatte-ID

8. Checkout med mörkt tema och staplade rabattkoder

9. Regionala betalningsmetoder (UPI för Indien)

10. BNPL-checkout (Buy Now Pay Later)

11. Använda befintliga betalningsmetoder för omedelbar checkout

12. Korta länkar för renare betalnings-URL:er

13. Hoppa över sidan för lyckad betalning med omedelbar omdirigering

14. Tvinga fram ett språk

15. Samla in anpassade fält

Förhandsgranska checkout-sessioner

Flytta från Dynamic Links till Checkout Sessions

Viktiga skillnader

Migreringsprocess

Relaterad API-referens