v8

OpenAPI 3.1.02026-08-033623795.0 MB

Checkout Configurations

Retrieve a checkout configuration

Retrieves a checkout configuration by ID. This endpoint is public so a checkout page can load from the configuration URL.

get/checkout_configurations/{id}

checkout configuration found (unauthenticated)

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.