Skip to main content
GET
JavaScript

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-18"

Path Parameters

id
string
required

The ID of the checkout configuration.

Response

checkout configuration found (unauthenticated)

account_id
string
required

Account ID, prefixed biz_.

created_at
string
required

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

id
string
required

Checkout configuration ID, prefixed ch_.

mode
enum<string>
required

Checkout mode: payment collects payment now; setup saves payment details for later.

Available options:
payment,
setup
updated_at
string
required

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

affiliate_code
string | null

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

currency
string | null

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

metadata
object | null

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

payment_method_configuration
object | null

Payment method overrides for this checkout. null when it uses the plan or platform defaults.

plan
object | null

Plan used for payment checkout. null in setup mode.

purchase_url
string | null

Checkout URL you can send to customers.

redirect_url
string | null

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

three_ds_level
string | null

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