OpenAPI 3.1.02026-08-143874115.7 MB
a84d4905fdbb
Checkout Configurations
List checkout configurations
Lists checkout configurations for an account.
get/checkout_configurations
Query parameters
account_idstring required
Account ID, prefixed biz_.
plan_idstring
Only return checkout configurations for this plan ID, prefixed plan_.
created_beforestring
Only return checkout configurations created before this ISO 8601 timestamp.
created_afterstring
Only return checkout configurations created after this ISO 8601 timestamp.
order'created_at'
Field used to sort checkout configurations.
direction'asc' | 'desc'
Sort direction. Defaults to desc.
firstinteger
Number of checkout configurations to return.
afterstring
Cursor for the next page of results.
Response
checkout configurations listed
Example response
{
"data": [
{
"account_id": "biz_xxxxxxxxxxxxxx",
"affiliate_code": "tanyacole",
"created_at": "2026-01-01T12:00:00.000Z",
"currency": "usd",
"id": "ch_xxxxxxxxxxxxxx",
"metadata": {
"booking_source": "front_desk"
},
"mode": "payment",
"payment_method_configuration": {
"disabled": [
"crypto"
],
"enabled": [
"card"
],
"include_platform_defaults": true
},
"plan": {
"adaptive_pricing_enabled": true,
"billing_period": 30,
"currency": "usd",
"expiration_days": 365,
"id": "plan_xxxxxxxxxxxxxx",
"plan_type": "renewal",
"release_method": "buy_now",
"renewal_price": 59,
"three_ds_level": "frictionless",
"trial_period_days": 7,
"visibility": "visible"
},
"purchase_url": "https://whop.com/checkout/plan_xxxxxxxxxxxxxx/",
"redirect_url": "https://shinetime.example/thanks",
"three_ds_level": "frictionless",
"updated_at": "2026-01-01T12:00:00.000Z"
}
],
"page_info": {
"end_cursor": "WyJjdXJzb3IiLDFd",
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}