Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Checkout Configurations

Create a checkout configuration

Creates a reusable checkout configuration for an existing or inline plan.

post/checkout_configurations

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

account_idstring

Account ID, prefixed biz_.

affiliate_codestring nullable

Affiliate code to apply to the checkout.

currencystring nullable

Currency used for setup-mode payment method availability.

metadataobject nullable

Custom key-value metadata copied to payments and memberships.

mode'payment' | 'setup'

Controls whether checkout charges the buyer immediately or saves payment details for later. Defaults to payment.

plan_idstring nullable

Existing plan ID, prefixed plan_. Mutually exclusive with plan.

redirect_urlstring nullable

URL customers are sent to after checkout.

three_ds_level'mandate_challenge' | 'frictionless' | 'null' nullable

3D Secure behavior for this checkout.

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "plan_id": "plan_xxxxxxxxxxxxx"
}

Response

checkout configuration created

account_idstring required

Account ID, prefixed biz_.

affiliate_codestring nullable

Affiliate code applied at checkout, or null when none is set.

created_atstring required

When the checkout configuration was created, as an ISO 8601 timestamp.

currencystring nullable

Currency used for setup-mode payment method availability; defaults to usd when omitted.

idstring required

Checkout configuration ID, prefixed ch_.

metadataobject nullable

Custom key-value metadata copied to payments and memberships. null without the checkout_configuration:basic:read scope.

mode'payment' | 'setup' required

Controls whether checkout charges the buyer immediately or saves payment details for later.

purchase_urlstring nullable

Checkout URL you can send to customers.

redirect_urlstring nullable

URL customers are sent to after checkout, or null when no redirect is configured.

three_ds_level'mandate_challenge' | 'frictionless' | 'null' nullable

3D Secure behavior for this checkout, or null to use the account default.

updated_atstring required

When the checkout configuration was last updated, as an ISO 8601 timestamp.