Checkout Configuration

Use the Checkout Configurations API to create checkout links for an existing or inline variant, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used.

Replaces the Legacy Checkout configurations resource. Existing Legacy integrations keep working; see API versions for the stability contract.

Endpoints

Endpoint	Request
List checkout configurations	GET `/checkout_configurations`
Retrieve a checkout configuration	GET `/checkout_configurations/{id}`
Create a checkout configuration	POST `/checkout_configurations`
Delete a checkout configuration	DELETE `/checkout_configurations/{id}`

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

The configuration governing a checkout mounted from this configuration, resolved through every layer (its own overrides, the variant’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.

Properties

string[]

Payment methods explicitly disabled.

string[]

Payment methods explicitly enabled.

boolean

Whether platform default payment methods are included.

object | null

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

string

required

Controls whether checkout charges the buyer immediately or saves payment details for later.Available options: payment, setup

object | null

Payment method overrides for this checkout. null when it uses the variant 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.

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 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 variant policy.Available options: mandate_challenge, mandate_if_required, frictionless_if_required

string

required

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

object | null

Variant used for payment checkout. null in setup mode.

Properties

string

required

Variant ID, prefixed plan_.

boolean

required

Whether this variant 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 variants.

string

required

Billing model for the variant.Available options: renewal, one_time

string

required

Three-letter ISO currency code for the variant’s prices.

integer | null

required

Access duration in days for expiration-based variants.

number

required

Initial purchase price in the variant currency.

string

required

Sales method for the variant.Available options: buy_now, waitlist

number

required

Recurring price charged each billing period.

string | null

required

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. null inherits the account default.Available options: mandate_challenge, mandate_if_required, frictionless_if_required

integer | null

required

Free trial days before the first renewal charge.

string

required

Whether the variant is visible to customers or hidden from public view.Available options: visible, hidden, archived, quick_link

CheckoutConfiguration

{
	"id": "ch_xxxxxxxxxxxxxx",
	"account_id": "biz_xxxxxxxxxxxxxx",
	"affiliate_code": "pickaxe-partner",
	"created_at": "2026-07-01T12:00:00Z",
	"currency": "usd",
	"metadata": {
		"campaign": "summer-launch"
	},
	"mode": "payment",
	"payment_method_configuration": {
		"enabled": ["card", "apple_pay"],
		"disabled": ["crypto"],
		"include_platform_defaults": true
	},
	"effective_payment_method_configuration": {
		"enabled": ["card", "apple_pay"],
		"disabled": ["crypto"],
		"include_platform_defaults": true
	},
	"variant": {
		"id": "plan_xxxxxxxxxxxxx",
		"visibility": "visible",
		"billing_type": "renewal",
		"release_method": "buy_now",
		"currency": "usd",
		"billing_period": 30,
		"expiration_days": null,
		"initial_price": 29,
		"renewal_price": 29,
		"trial_period_days": 7,
		"three_ds_level": "frictionless_if_required",
		"adaptive_pricing_enabled": true
	},
	"purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxx/?session=ch_xxxxxxxxxxxxxx",
	"redirect_url": "https://pickaxe.example/welcome",
	"three_ds_level": "frictionless_if_required",
	"updated_at": "2026-07-02T12:00:00Z"
}

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

Checkout Configuration

Endpoints

Attributes

​Endpoints

​Attributes

Endpoints

Attributes