Skip to main content
A Checkout Configuration is a reusable checkout link owned by an account. In payment mode it sells a specific plan; in setup mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used.

​
Endpoints

​
Attributes

​
string
required
Checkout configuration ID, prefixed ch_.
​
string
required
Account ID, prefixed biz_.
​
string | null
Affiliate code applied at checkout, or null when none is set.
​
string
required
When the checkout configuration was created, as an ISO 8601 timestamp.
​
string | null
Currency used for setup-mode payment method availability; defaults to usd when omitted.
​
object | null
Custom key-value metadata copied to payments and memberships. null without the checkout_configuration:basic:read scope.
​
string
required
Checkout mode: payment collects payment now; setup saves payment details for later.Available options: payment, setup
​
object | null
Payment method overrides for this checkout. null when it uses the plan or platform defaults.

Properties

​
string[]
Payment methods explicitly disabled for checkout.
​
string[]
Payment methods explicitly enabled for checkout.
​
boolean
Whether platform default payment methods are included.
​
object | null
Plan used for payment checkout. null in setup mode.

Properties

​
string
required
Plan ID, prefixed plan_.
​
boolean
required
Whether this plan accepts local currency payments via adaptive pricing.
​
integer | null
required
Recurring billing interval in days, such as 30 for monthly or 365 for annual. null for one-time plans.
​
string
required
Three-letter ISO currency code for the plan’s prices.
​
integer | null
required
Access duration in days for expiration-based plans.
​
number
required
Initial purchase price in the plan currency.
​
string
required
Billing model for the plan: renewal (recurring) or one_time (single payment).
​
string
required
Sales method for the plan, such as buy_now or waitlist.
​
number
required
Recurring price charged each billing period.
​
string | null
required
3D Secure behavior for this plan, or null to use the account default.
​
integer | null
required
Free trial days before the first renewal charge.
​
string
required
Whether the plan is visible to customers or hidden from public view.
​
string | null
Checkout URL you can send to customers.
​
string | null
URL customers are sent to after checkout, or null when no redirect is configured.
​
string | null
3D Secure behavior for this checkout, or null to use the account default.
​
string
required
When the checkout configuration was last updated, as an ISO 8601 timestamp.
CheckoutConfiguration