Retrieve a Checkout Configuration
Retrieves a checkout configuration by ID. This endpoint is public so a checkout page can load from the configuration URL.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-09-25"
Path Parameters
The ID of the checkout configuration.
Response
checkout configuration found (unauthenticated)
Account ID, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
When the checkout configuration was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Checkout configuration ID, prefixed ch_.
"ch_xxxxxxxxxxxxxx"
Controls whether checkout charges the buyer immediately or saves payment details for later.
payment, setup "payment"
When the checkout configuration was last updated, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Affiliate code applied at checkout, or null when none is set.
"tanyacole"
Currency used for setup-mode payment method availability; defaults to usd when omitted.
"usd"
The configuration governing a checkout mounted from this configuration, resolved through every layer (its own overrides, the plan's, and the account's) — the shape a session's payment_method_configuration carries. Apply it over the payment method types catalogue for the offerable set. null means platform defaults; payment_method_configuration stays this configuration's own editable override.
Custom key-value metadata copied to payments and memberships. null without the checkout_configuration:basic:read scope.
Payment method overrides for this checkout. null when it uses the plan or platform defaults.
Plan used for payment checkout. null in setup mode.
Checkout URL you can send to customers.
"https://whop.com/checkout/ch_xxxxxxxxxxxxxx/"
URL customers are sent to after checkout, or null when no redirect is configured.
"https://shinetime.example/thanks"
3D Secure behavior for supported on-session card payments. mandate_challenge requires a 3DS challenge before payment processing; mandate_if_required mandates a challenge only when the payment processor requires it; frictionless_if_required uses the regular frictionless 3DS flow. Payments of $1,000 or more use mandate_if_required unless mandate_challenge is selected. Risk and authentication recovery requirements can override the preference. Applies in setup mode; null uses frictionless 3DS. Payment mode uses the plan policy.
mandate_challenge, mandate_if_required, frictionless_if_required, null "frictionless_if_required"

