Create a checkout configuration
Creates a reusable checkout configuration for an existing or inline plan.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-08-13"
Body
Account ID, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
Affiliate code to apply to the checkout.
"tanyacole"
Currency used for setup-mode payment method availability.
"usd"
Custom key-value metadata copied to payments and memberships.
Controls whether checkout charges the buyer immediately or saves payment details for later. Defaults to payment.
payment, setup "payment"
Payment method overrides for this checkout. null uses the plan or platform defaults.
Plan attributes used to create or find a plan for this checkout configuration. Mutually exclusive with plan_id.
Existing plan ID, prefixed plan_. Mutually exclusive with plan.
"plan_xxxxxxxxxxxxxx"
URL customers are sent to after checkout.
"https://shinetime.example/thanks"
3D Secure behavior for this checkout.
mandate_challenge, frictionless, null "frictionless"
Response
checkout configuration created for an existing plan
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 "setup"
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 this checkout, or null to use the account default.
mandate_challenge, frictionless, null "mandate_challenge"

