Create Checkout Session

POST

checkouts

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const checkoutSessionResponse = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'product_id', quantity: 0 }],
});

console.log(checkoutSessionResponse.session_id);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
checkout_session_response = client.checkout_sessions.create(
    product_cart=[{
        "product_id": "product_id",
        "quantity": 0,
    }],
)
print(checkout_session_response.session_id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	checkoutSessionResponse, err := client.CheckoutSessions.New(context.TODO(), dodopayments.CheckoutSessionNewParams{
		CheckoutSessionRequest: dodopayments.CheckoutSessionRequestParam{
			ProductCart: dodopayments.F([]dodopayments.ProductItemReqParam{{
				ProductID: dodopayments.F("product_id"),
				Quantity:  dodopayments.F(int64(0)),
			}}),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkoutSessionResponse.SessionID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;
import com.dodopayments.api.models.checkoutsessions.ProductItemReq;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        CheckoutSessionRequest params = CheckoutSessionRequest.builder()
            .addProductCart(ProductItemReq.builder()
                .productId("product_id")
                .quantity(0)
                .build())
            .build();
        CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse
import com.dodopayments.api.models.checkoutsessions.ProductItemReq

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: CheckoutSessionRequest = CheckoutSessionRequest.builder()
        .addProductCart(ProductItemReq.builder()
            .productId("product_id")
            .quantity(0)
            .build())
        .build()
    val checkoutSessionResponse: CheckoutSessionResponse = client.checkoutSessions().create(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

checkout_session_response = dodo_payments.checkout_sessions.create(product_cart: [{product_id: "product_id", quantity: 0}])

puts(checkout_session_response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\Misc\CountryCode;
use Dodopayments\Misc\Currency;
use Dodopayments\Payments\PaymentMethodTypes;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $checkoutSessionResponse = $client->checkoutSessions->create(
    productCart: [
      [
        'productID' => 'product_id',
        'quantity' => 0,
        'addons' => [['addonID' => 'addon_id', 'quantity' => 0]],
        'amount' => 0,
        'creditEntitlements' => [
          [
            'creditEntitlementID' => 'credit_entitlement_id',
            'creditsAmount' => 'credits_amount',
          ],
        ],
      ],
    ],
    allowedPaymentMethodTypes: [PaymentMethodTypes::ACH],
    billingAddress: [
      'country' => CountryCode::AF,
      'city' => 'city',
      'state' => 'state',
      'street' => 'street',
      'zipcode' => 'zipcode',
    ],
    billingCurrency: Currency::AED,
    cancelURL: 'cancel_url',
    confirm: true,
    customFields: [
      [
        'fieldType' => 'text',
        'key' => 'key',
        'label' => 'label',
        'options' => ['string'],
        'placeholder' => 'placeholder',
        'required' => true,
      ],
    ],
    customer: ['customerID' => 'customer_id'],
    customerBusinessName: 'customer_business_name',
    customization: [
      'forceLanguage' => 'force_language',
      'paymentMethodLayout' => 'accordion',
      'showOnDemandTag' => true,
      'showOrderDetails' => true,
      'theme' => 'dark',
      'themeConfig' => [
        'dark' => [
          'bgPrimary' => 'bg_primary',
          'bgSecondary' => 'bg_secondary',
          'borderPrimary' => 'border_primary',
          'borderSecondary' => 'border_secondary',
          'buttonPrimary' => 'button_primary',
          'buttonPrimaryHover' => 'button_primary_hover',
          'buttonSecondary' => 'button_secondary',
          'buttonSecondaryHover' => 'button_secondary_hover',
          'buttonTextPrimary' => 'button_text_primary',
          'buttonTextSecondary' => 'button_text_secondary',
          'inputFocusBorder' => 'input_focus_border',
          'textError' => 'text_error',
          'textPlaceholder' => 'text_placeholder',
          'textPrimary' => 'text_primary',
          'textSecondary' => 'text_secondary',
          'textSuccess' => 'text_success',
        ],
        'fontPrimaryURL' => 'font_primary_url',
        'fontSecondaryURL' => 'font_secondary_url',
        'fontSize' => 'xs',
        'fontWeight' => 'normal',
        'light' => [
          'bgPrimary' => 'bg_primary',
          'bgSecondary' => 'bg_secondary',
          'borderPrimary' => 'border_primary',
          'borderSecondary' => 'border_secondary',
          'buttonPrimary' => 'button_primary',
          'buttonPrimaryHover' => 'button_primary_hover',
          'buttonSecondary' => 'button_secondary',
          'buttonSecondaryHover' => 'button_secondary_hover',
          'buttonTextPrimary' => 'button_text_primary',
          'buttonTextSecondary' => 'button_text_secondary',
          'inputFocusBorder' => 'input_focus_border',
          'textError' => 'text_error',
          'textPlaceholder' => 'text_placeholder',
          'textPrimary' => 'text_primary',
          'textSecondary' => 'text_secondary',
          'textSuccess' => 'text_success',
        ],
        'payButtonText' => 'pay_button_text',
        'radius' => 'radius',
      ],
    ],
    discountCode: 'discount_code',
    discountCodes: ['string'],
    featureFlags: [
      'allowCurrencySelection' => true,
      'allowCustomerEditingBusinessName' => true,
      'allowCustomerEditingCity' => true,
      'allowCustomerEditingCountry' => true,
      'allowCustomerEditingEmail' => true,
      'allowCustomerEditingName' => true,
      'allowCustomerEditingState' => true,
      'allowCustomerEditingStreet' => true,
      'allowCustomerEditingTaxID' => true,
      'allowCustomerEditingZipcode' => true,
      'allowDiscountCode' => true,
      'allowEditingAddons' => true,
      'allowPhoneNumberCollection' => true,
      'allowTaxID' => true,
      'alwaysCreateNewCustomer' => true,
      'redirectImmediately' => true,
      'requireCardholderName' => true,
      'requirePhoneNumber' => true,
      'requireTaxID' => true,
      'singlePage' => true,
    ],
    force3DS: true,
    mandateMinAmountInrPaise: 0,
    metadata: ['foo' => 'string'],
    minimalAddress: true,
    paymentMethodID: 'payment_method_id',
    productCollectionID: 'product_collection_id',
    returnURL: 'return_url',
    shortLink: true,
    showSavedPaymentMethods: true,
    subscriptionData: [
      'onDemand' => [
        'mandateOnly' => true,
        'adaptiveCurrencyFeesInclusive' => true,
        'productCurrency' => Currency::AED,
        'productDescription' => 'product_description',
        'productPrice' => 0,
      ],
      'trialPeriodDays' => 0,
    ],
    taxID: 'tax_id',
  );

  var_dump($checkoutSessionResponse);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.CheckoutSessions;

DodoPaymentsClient client = new();

CheckoutSessionCreateParams parameters = new()
{
    ProductCart =
    [
        new()
        {
            ProductID = "product_id",
            Quantity = 0,
            Addons =
            [
                new()
                {
                    AddonID = "addon_id",
                    Quantity = 0,
                },
            ],
            Amount = 0,
            CreditEntitlements =
            [
                new()
                {
                    CreditEntitlementID = "credit_entitlement_id",
                    CreditsAmount = "credits_amount",
                },
            ],
        },
    ],
};

var checkoutSessionResponse = await client.CheckoutSessions.Create(parameters);

Console.WriteLine(checkoutSessionResponse);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .checkout_sessions()
        .create()
        .body(dodopayments::models::CheckoutSessionsCreateParams {
                product_cart: Some(vec![dodopayments::models::ProductItemReq {
                    product_id: "product_id".to_string(),
                    quantity: 0,
                    addons: None,
                    amount: None,
                    credit_entitlements: None,
                }]),
                ..Default::default()
            })
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request POST \
  --url https://test.dodopayments.com/checkouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_cart": [
    {
      "product_id": "<string>",
      "quantity": 1,
      "addons": [
        {
          "addon_id": "<string>",
          "quantity": 1
        }
      ],
      "amount": 123,
      "credit_entitlements": [
        {
          "credit_entitlement_id": "<string>",
          "credits_amount": "<string>"
        }
      ]
    }
  ],
  "allowed_payment_method_types": [],
  "billing_address": {
    "city": "<string>",
    "state": "<string>",
    "street": "<string>",
    "zipcode": "<string>"
  },
  "cancel_url": "<string>",
  "confirm": true,
  "custom_fields": [
    {
      "key": "<string>",
      "label": "<string>",
      "options": [
        "<string>"
      ],
      "placeholder": "<string>",
      "required": true
    }
  ],
  "customer": {
    "customer_id": "<string>"
  },
  "customer_business_name": "<string>",
  "customization": {
    "force_language": "<string>",
    "show_on_demand_tag": true,
    "show_order_details": true,
    "theme_config": {
      "dark": {
        "bg_primary": "<string>",
        "bg_secondary": "<string>",
        "border_primary": "<string>",
        "border_secondary": "<string>",
        "button_primary": "<string>",
        "button_primary_hover": "<string>",
        "button_secondary": "<string>",
        "button_secondary_hover": "<string>",
        "button_text_primary": "<string>",
        "button_text_secondary": "<string>",
        "input_focus_border": "<string>",
        "text_error": "<string>",
        "text_placeholder": "<string>",
        "text_primary": "<string>",
        "text_secondary": "<string>",
        "text_success": "<string>"
      },
      "font_primary_url": "<string>",
      "font_secondary_url": "<string>",
      "light": {
        "bg_primary": "<string>",
        "bg_secondary": "<string>",
        "border_primary": "<string>",
        "border_secondary": "<string>",
        "button_primary": "<string>",
        "button_primary_hover": "<string>",
        "button_secondary": "<string>",
        "button_secondary_hover": "<string>",
        "button_text_primary": "<string>",
        "button_text_secondary": "<string>",
        "input_focus_border": "<string>",
        "text_error": "<string>",
        "text_placeholder": "<string>",
        "text_primary": "<string>",
        "text_secondary": "<string>",
        "text_success": "<string>"
      },
      "pay_button_text": "<string>",
      "radius": "<string>"
    }
  },
  "discount_code": "<string>",
  "discount_codes": [
    "<string>"
  ],
  "feature_flags": {
    "allow_currency_selection": true,
    "allow_customer_editing_business_name": true,
    "allow_customer_editing_city": true,
    "allow_customer_editing_country": true,
    "allow_customer_editing_email": true,
    "allow_customer_editing_name": true,
    "allow_customer_editing_state": true,
    "allow_customer_editing_street": true,
    "allow_customer_editing_tax_id": true,
    "allow_customer_editing_zipcode": true,
    "allow_discount_code": true,
    "allow_editing_addons": true,
    "allow_phone_number_collection": true,
    "allow_tax_id": true,
    "always_create_new_customer": true,
    "redirect_immediately": true,
    "require_cardholder_name": true,
    "require_phone_number": true,
    "require_tax_id": true,
    "single_page": true
  },
  "force_3ds": true,
  "mandate_min_amount_inr_paise": 123,
  "metadata": {},
  "minimal_address": true,
  "payment_method_id": "<string>",
  "product_collection_id": "<string>",
  "return_url": "<string>",
  "short_link": true,
  "show_saved_payment_methods": true,
  "subscription_data": {
    "on_demand": {
      "mandate_only": true,
      "adaptive_currency_fees_inclusive": true,
      "product_description": "<string>",
      "product_price": 123
    },
    "trial_period_days": 123
  },
  "tax_id": "<string>"
}
'

{
  "session_id": "<string>",
  "checkout_url": "<string>",
  "client_secret": "<string>",
  "payment_id": "<string>",
  "publishable_key": "<string>"
}

Authorizations

Authorization

string

header

required

Send your API key as a bearer token: Authorization: Bearer <api_key>. A test mode key starts with dodo_test_, for example dodo_test_AbCd1234EfGh5678.<secret>. A live mode key starts with dodo_live_. Use a test mode key on test.dodopayments.com and a live mode key on live.dodopayments.com. Keys from before these tags have no tag and operate as before.

Body

application/json

product_cart

Product Item Request · object[]

required

The products of the checkout. A cart holds at most 20 of them, one-time and subscription products together. An empty cart is valid for the product-collection flow, where the customer chooses the product later.

Show child attributes

allowed_payment_method_types

enum<string>[] | null

Customers will never see payment methods that are not in this list. However, adding a method here does not guarantee customers will see it. Availability still depends on other factors (e.g., customer location, merchant settings).

Disclaimar: Always provide 'credit' and 'debit' as a fallback. If all payment methods are unavailable, checkout session will fail.

All supported payment method types.

Used for disabled-payment-methods filtering and validation.

Available options:

ach,

affirm,

afterpay_clearpay,

alfamart,

ali_pay,

ali_pay_hk,

alma,

amazon_pay,

apple_pay,

atome,

bacs,

bancontact_card,

becs,

benefit,

bizum,

blik,

boleto,

bca_bank_transfer,

bni_va,

bri_va,

card_redirect,

cimb_va,

classic,

credit,

crypto_currency,

cashapp,

dana,

danamon_va,

debit,

duit_now,

efecty,

eft,

eps,

fps,

evoucher,

giropay,

givex,

google_pay,

go_pay,

gcash,

ideal,

interac,

indomaret,

klarna,

kakao_pay,

local_bank_redirect,

mandiri_va,

knet,

mb_way,

mobile_pay,

momo,

momo_atm,

multibanco,

online_banking_thailand,

online_banking_czech_republic,

online_banking_finland,

online_banking_fpx,

online_banking_poland,

online_banking_slovakia,

oxxo,

pago_efectivo,

permata_bank_transfer,

open_banking_uk,

pay_bright,

paypal,

paze,

pix,

pay_safe_card,

przelewy24,

prompt_pay,

pse,

red_compra,

red_pagos,

samsung_pay,

sepa,

sepa_bank_transfer,

sofort,

swish,

touch_n_go,

trustly,

twint,

upi_collect,

upi_intent,

vipps,

viet_qr,

venmo,

walley,

we_chat_pay,

seven_eleven,

lawson,

mini_stop,

family_mart,

seicomart,

pay_easy,

local_bank_transfer,

mifinity,

open_banking_pis,

direct_carrier_billing,

instant_bank_transfer,

billie,

zip,

revolut_pay,

naver_pay,

payco,

satispay

billing_address

null | Checkout Session Billing Address · object

Billing address information for the session

Show child attributes

billing_currency

null | enum<string>

The currency to charge the customer in.

Adaptive pricing must be enabled for the business. The customer then pays in this currency. If you do not set it, the currency comes from the billing country.

If adaptive pricing is disabled, the API discards this field. The currency then comes from the product price, or from the billing country.

Available options:

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

cancel_url

string | null

The URL to redirect the customer if they cancel or go back from the checkout. If not provided, the back button will not be displayed.

confirm

boolean

If confirm is true, all the details will be finalized. If required data is missing, an API error is thrown.

custom_fields

null | object[]

Custom fields to collect from customer during checkout (max 5 fields)

Show child attributes

customer

Attach Existing Customer · object

Customer details for the session

Attach Existing Customer
New Customer

Show child attributes

customer_business_name

string | null

Optional business / legal name associated with the tax id. When provided together with a valid tax id for a B2B purchase, this name is rendered on the invoice instead of the customer's personal name.

customization

Checkout Session Customization · object

Customization for the checkout session page

Show child attributes

discount_code

string | null

deprecated

DEPRECATED: Use discount_codes instead. Cannot be used together with discount_codes.

discount_codes

string[] | null

Stacked discount codes to apply, in order. Max 20. Cannot be used together with discount_code.

feature_flags

Checkout Session Flags · object

Show child attributes

force_3ds

boolean | null

Override merchant default 3DS behaviour for this session

mandate_min_amount_inr_paise

integer<int32> | null

Override the merchant-level mandate floor (in INR paise) for INR e-mandates on Indian-card recurring payments. The mandate amount sent to the processor is max(this_floor, actual_billing_amount), so this is effectively the customer-facing authorization ceiling whenever billing is lower. When unset, the merchant setting applies; when that's also unset, the system default of ₹15,000 applies.

metadata

null | Metadata · object

Additional metadata associated with the payment. Defaults to empty if not provided.

Show child attributes

minimal_address

boolean | null

If true, only zipcode is required when confirm is true; other address fields remain optional

Default is true when feature_flags.single_page is true. Otherwise, default is false.

payment_method_id

string | null

Optional payment method ID to use for this checkout session. Only allowed when confirm is true. If provided, existing customer id must also be provided.

product_collection_id

string | null

Product collection ID for collection-based checkout flow

return_url

string | null

The url to redirect after payment failure or success.

short_link

boolean

If true, returns a shortened checkout URL. Defaults to false if not specified.

show_saved_payment_methods

boolean

Display saved payment methods of a returning customer False by default

subscription_data

null | Subscription Data · object

Show child attributes

tax_id

string | null

Tax ID for the customer (e.g. VAT number). Requires billing_address with country.

Response

Checkout session successfully created

session_id

string

required

The ID of the created checkout session

checkout_url

string | null

Checkout url (None when payment_method_id is provided)

client_secret

string | null

Client secret used to load the Dodo Payments checkout SDK. Returned when confirm: true was passed and a PaymentIntent was created at session-creation time. None otherwise.

payment_id

string | null

Underlying payment id when confirm: true was passed and a PaymentIntent was created at session-creation time. None otherwise.

publishable_key

string | null

Publishable key for the Dodo Payments checkout SDK. Returned when confirm: true was passed and a PaymentIntent was created at session-creation time. None otherwise.

Last modified on March 25, 2026

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const checkoutSessionResponse = await client.checkoutSessions.create({
  product_cart: [{ product_id: 'product_id', quantity: 0 }],
});

console.log(checkoutSessionResponse.session_id);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
checkout_session_response = client.checkout_sessions.create(
    product_cart=[{
        "product_id": "product_id",
        "quantity": 0,
    }],
)
print(checkout_session_response.session_id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	checkoutSessionResponse, err := client.CheckoutSessions.New(context.TODO(), dodopayments.CheckoutSessionNewParams{
		CheckoutSessionRequest: dodopayments.CheckoutSessionRequestParam{
			ProductCart: dodopayments.F([]dodopayments.ProductItemReqParam{{
				ProductID: dodopayments.F("product_id"),
				Quantity:  dodopayments.F(int64(0)),
			}}),
		},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", checkoutSessionResponse.SessionID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest;
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse;
import com.dodopayments.api.models.checkoutsessions.ProductItemReq;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        CheckoutSessionRequest params = CheckoutSessionRequest.builder()
            .addProductCart(ProductItemReq.builder()
                .productId("product_id")
                .quantity(0)
                .build())
            .build();
        CheckoutSessionResponse checkoutSessionResponse = client.checkoutSessions().create(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionRequest
import com.dodopayments.api.models.checkoutsessions.CheckoutSessionResponse
import com.dodopayments.api.models.checkoutsessions.ProductItemReq

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: CheckoutSessionRequest = CheckoutSessionRequest.builder()
        .addProductCart(ProductItemReq.builder()
            .productId("product_id")
            .quantity(0)
            .build())
        .build()
    val checkoutSessionResponse: CheckoutSessionResponse = client.checkoutSessions().create(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

checkout_session_response = dodo_payments.checkout_sessions.create(product_cart: [{product_id: "product_id", quantity: 0}])

puts(checkout_session_response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
use Dodopayments\Misc\CountryCode;
use Dodopayments\Misc\Currency;
use Dodopayments\Payments\PaymentMethodTypes;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $checkoutSessionResponse = $client->checkoutSessions->create(
    productCart: [
      [
        'productID' => 'product_id',
        'quantity' => 0,
        'addons' => [['addonID' => 'addon_id', 'quantity' => 0]],
        'amount' => 0,
        'creditEntitlements' => [
          [
            'creditEntitlementID' => 'credit_entitlement_id',
            'creditsAmount' => 'credits_amount',
          ],
        ],
      ],
    ],
    allowedPaymentMethodTypes: [PaymentMethodTypes::ACH],
    billingAddress: [
      'country' => CountryCode::AF,
      'city' => 'city',
      'state' => 'state',
      'street' => 'street',
      'zipcode' => 'zipcode',
    ],
    billingCurrency: Currency::AED,
    cancelURL: 'cancel_url',
    confirm: true,
    customFields: [
      [
        'fieldType' => 'text',
        'key' => 'key',
        'label' => 'label',
        'options' => ['string'],
        'placeholder' => 'placeholder',
        'required' => true,
      ],
    ],
    customer: ['customerID' => 'customer_id'],
    customerBusinessName: 'customer_business_name',
    customization: [
      'forceLanguage' => 'force_language',
      'paymentMethodLayout' => 'accordion',
      'showOnDemandTag' => true,
      'showOrderDetails' => true,
      'theme' => 'dark',
      'themeConfig' => [
        'dark' => [
          'bgPrimary' => 'bg_primary',
          'bgSecondary' => 'bg_secondary',
          'borderPrimary' => 'border_primary',
          'borderSecondary' => 'border_secondary',
          'buttonPrimary' => 'button_primary',
          'buttonPrimaryHover' => 'button_primary_hover',
          'buttonSecondary' => 'button_secondary',
          'buttonSecondaryHover' => 'button_secondary_hover',
          'buttonTextPrimary' => 'button_text_primary',
          'buttonTextSecondary' => 'button_text_secondary',
          'inputFocusBorder' => 'input_focus_border',
          'textError' => 'text_error',
          'textPlaceholder' => 'text_placeholder',
          'textPrimary' => 'text_primary',
          'textSecondary' => 'text_secondary',
          'textSuccess' => 'text_success',
        ],
        'fontPrimaryURL' => 'font_primary_url',
        'fontSecondaryURL' => 'font_secondary_url',
        'fontSize' => 'xs',
        'fontWeight' => 'normal',
        'light' => [
          'bgPrimary' => 'bg_primary',
          'bgSecondary' => 'bg_secondary',
          'borderPrimary' => 'border_primary',
          'borderSecondary' => 'border_secondary',
          'buttonPrimary' => 'button_primary',
          'buttonPrimaryHover' => 'button_primary_hover',
          'buttonSecondary' => 'button_secondary',
          'buttonSecondaryHover' => 'button_secondary_hover',
          'buttonTextPrimary' => 'button_text_primary',
          'buttonTextSecondary' => 'button_text_secondary',
          'inputFocusBorder' => 'input_focus_border',
          'textError' => 'text_error',
          'textPlaceholder' => 'text_placeholder',
          'textPrimary' => 'text_primary',
          'textSecondary' => 'text_secondary',
          'textSuccess' => 'text_success',
        ],
        'payButtonText' => 'pay_button_text',
        'radius' => 'radius',
      ],
    ],
    discountCode: 'discount_code',
    discountCodes: ['string'],
    featureFlags: [
      'allowCurrencySelection' => true,
      'allowCustomerEditingBusinessName' => true,
      'allowCustomerEditingCity' => true,
      'allowCustomerEditingCountry' => true,
      'allowCustomerEditingEmail' => true,
      'allowCustomerEditingName' => true,
      'allowCustomerEditingState' => true,
      'allowCustomerEditingStreet' => true,
      'allowCustomerEditingTaxID' => true,
      'allowCustomerEditingZipcode' => true,
      'allowDiscountCode' => true,
      'allowEditingAddons' => true,
      'allowPhoneNumberCollection' => true,
      'allowTaxID' => true,
      'alwaysCreateNewCustomer' => true,
      'redirectImmediately' => true,
      'requireCardholderName' => true,
      'requirePhoneNumber' => true,
      'requireTaxID' => true,
      'singlePage' => true,
    ],
    force3DS: true,
    mandateMinAmountInrPaise: 0,
    metadata: ['foo' => 'string'],
    minimalAddress: true,
    paymentMethodID: 'payment_method_id',
    productCollectionID: 'product_collection_id',
    returnURL: 'return_url',
    shortLink: true,
    showSavedPaymentMethods: true,
    subscriptionData: [
      'onDemand' => [
        'mandateOnly' => true,
        'adaptiveCurrencyFeesInclusive' => true,
        'productCurrency' => Currency::AED,
        'productDescription' => 'product_description',
        'productPrice' => 0,
      ],
      'trialPeriodDays' => 0,
    ],
    taxID: 'tax_id',
  );

  var_dump($checkoutSessionResponse);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.CheckoutSessions;

DodoPaymentsClient client = new();

CheckoutSessionCreateParams parameters = new()
{
    ProductCart =
    [
        new()
        {
            ProductID = "product_id",
            Quantity = 0,
            Addons =
            [
                new()
                {
                    AddonID = "addon_id",
                    Quantity = 0,
                },
            ],
            Amount = 0,
            CreditEntitlements =
            [
                new()
                {
                    CreditEntitlementID = "credit_entitlement_id",
                    CreditsAmount = "credits_amount",
                },
            ],
        },
    ],
};

var checkoutSessionResponse = await client.CheckoutSessions.Create(parameters);

Console.WriteLine(checkoutSessionResponse);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let result = client
        .checkout_sessions()
        .create()
        .body(dodopayments::models::CheckoutSessionsCreateParams {
                product_cart: Some(vec![dodopayments::models::ProductItemReq {
                    product_id: "product_id".to_string(),
                    quantity: 0,
                    addons: None,
                    amount: None,
                    credit_entitlements: None,
                }]),
                ..Default::default()
            })
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request POST \
  --url https://test.dodopayments.com/checkouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_cart": [
    {
      "product_id": "<string>",
      "quantity": 1,
      "addons": [
        {
          "addon_id": "<string>",
          "quantity": 1
        }
      ],
      "amount": 123,
      "credit_entitlements": [
        {
          "credit_entitlement_id": "<string>",
          "credits_amount": "<string>"
        }
      ]
    }
  ],
  "allowed_payment_method_types": [],
  "billing_address": {
    "city": "<string>",
    "state": "<string>",
    "street": "<string>",
    "zipcode": "<string>"
  },
  "cancel_url": "<string>",
  "confirm": true,
  "custom_fields": [
    {
      "key": "<string>",
      "label": "<string>",
      "options": [
        "<string>"
      ],
      "placeholder": "<string>",
      "required": true
    }
  ],
  "customer": {
    "customer_id": "<string>"
  },
  "customer_business_name": "<string>",
  "customization": {
    "force_language": "<string>",
    "show_on_demand_tag": true,
    "show_order_details": true,
    "theme_config": {
      "dark": {
        "bg_primary": "<string>",
        "bg_secondary": "<string>",
        "border_primary": "<string>",
        "border_secondary": "<string>",
        "button_primary": "<string>",
        "button_primary_hover": "<string>",
        "button_secondary": "<string>",
        "button_secondary_hover": "<string>",
        "button_text_primary": "<string>",
        "button_text_secondary": "<string>",
        "input_focus_border": "<string>",
        "text_error": "<string>",
        "text_placeholder": "<string>",
        "text_primary": "<string>",
        "text_secondary": "<string>",
        "text_success": "<string>"
      },
      "font_primary_url": "<string>",
      "font_secondary_url": "<string>",
      "light": {
        "bg_primary": "<string>",
        "bg_secondary": "<string>",
        "border_primary": "<string>",
        "border_secondary": "<string>",
        "button_primary": "<string>",
        "button_primary_hover": "<string>",
        "button_secondary": "<string>",
        "button_secondary_hover": "<string>",
        "button_text_primary": "<string>",
        "button_text_secondary": "<string>",
        "input_focus_border": "<string>",
        "text_error": "<string>",
        "text_placeholder": "<string>",
        "text_primary": "<string>",
        "text_secondary": "<string>",
        "text_success": "<string>"
      },
      "pay_button_text": "<string>",
      "radius": "<string>"
    }
  },
  "discount_code": "<string>",
  "discount_codes": [
    "<string>"
  ],
  "feature_flags": {
    "allow_currency_selection": true,
    "allow_customer_editing_business_name": true,
    "allow_customer_editing_city": true,
    "allow_customer_editing_country": true,
    "allow_customer_editing_email": true,
    "allow_customer_editing_name": true,
    "allow_customer_editing_state": true,
    "allow_customer_editing_street": true,
    "allow_customer_editing_tax_id": true,
    "allow_customer_editing_zipcode": true,
    "allow_discount_code": true,
    "allow_editing_addons": true,
    "allow_phone_number_collection": true,
    "allow_tax_id": true,
    "always_create_new_customer": true,
    "redirect_immediately": true,
    "require_cardholder_name": true,
    "require_phone_number": true,
    "require_tax_id": true,
    "single_page": true
  },
  "force_3ds": true,
  "mandate_min_amount_inr_paise": 123,
  "metadata": {},
  "minimal_address": true,
  "payment_method_id": "<string>",
  "product_collection_id": "<string>",
  "return_url": "<string>",
  "short_link": true,
  "show_saved_payment_methods": true,
  "subscription_data": {
    "on_demand": {
      "mandate_only": true,
      "adaptive_currency_fees_inclusive": true,
      "product_description": "<string>",
      "product_price": 123
    },
    "trial_period_days": 123
  },
  "tax_id": "<string>"
}
'

{
  "session_id": "<string>",
  "checkout_url": "<string>",
  "client_secret": "<string>",
  "payment_id": "<string>",
  "publishable_key": "<string>"
}

API Reference

Checkout Sessions

Payments

Subscriptions

Invoices

Discounts

Licenses

Entitlements

Customers

Customer Wallets

Customer Blocklist

Products

Localized Pricing

Addons

Credit Entitlements

Meters

Usage Events

Refunds

Disputes

Payouts

Balance Ledger

Moderation

Brands

Webhooks

Miscellaneous

Product Collections

Authorizations

Body

Response