List checkout configurations
Lists checkout configurations for an account.
Query parameters
Account ID, prefixed biz_.
Only return checkout configurations for this plan ID, prefixed plan_.
Only return checkout configurations created before this ISO 8601 timestamp.
Only return checkout configurations created after this ISO 8601 timestamp.
Field used to sort checkout configurations.
Sort direction. Defaults to desc.
Number of results to return from the start of the range.
Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.
Response
checkout configurations listed
Example response
{
"data": [
{
"account_id": "biz_xxxxxxxxxxxxxx",
"affiliate_code": "tanyacole",
"created_at": "2026-01-01T12:00:00.000Z",
"currency": "usd",
"effective_payment_method_configuration": {
"disabled": [
"crypto"
],
"enabled": [
"card"
],
"include_platform_defaults": true
},
"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_if_required",
"trial_period_days": 7,
"visibility": "visible"
},
"purchase_url": "https://whop.com/checkout/ch_xxxxxxxxxxxxxx/",
"redirect_url": "https://shinetime.example/thanks",
"three_ds_level": "frictionless_if_required",
"updated_at": "2026-01-01T12:00:00.000Z"
}
],
"page_info": {
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}Changes
Changed in 6 of the 74 revisions of this API.3209
- ▲
for the
queryrequest parameterfirst, default value20was addedrequest-parameter-default-value-added
- ●
for the
queryrequest parameterfirst, the max was set to100.00request-parameter-max-set
- ●
added the new
frictionless_if_requiredenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
frictionless_if_requiredenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate_if_requiredenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate_if_requiredenum value to the//response property for the response statusresponse-property-enum-value-added
- ○
removed the
frictionlessenum value from the///response property for the response statusresponse-property-enum-value-removed
- ○
removed the
frictionlessenum value from the//response property for the response statusresponse-property-enum-value-removed
- ▲
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
the security scope
checkout_configuration:basic:readwas added to the endpoint's security schemebearerAuthapi-security-scope-added
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
added the new
archivedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
buy_nowenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
frictionlessenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
frictionlessenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
hiddenenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate_challengeenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
mandate_challengeenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
one_timeenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
quick_linkenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
renewalenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
undefinedenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
undefinedenum value to the//response property for the response statusresponse-property-enum-value-added
- ●
added the new
visibleenum value to the///response property for the response statusresponse-property-enum-value-added
- ●
added the new
waitlistenum value to the///response property for the response statusresponse-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
added the new required
queryrequest parameteraccount_idnew-required-request-parameter
- ▲
removed the required property
//from the response with the statusresponse-required-property-removed
- ●
deleted the
queryrequest parametercompany_idrequest-parameter-removed
- ○
for the
queryrequest parametercreated_after, the type was generalized fromintegertostringrequest-parameter-type-generalized
- ○
for the
queryrequest parametercreated_before, the type was generalized fromintegertostringrequest-parameter-type-generalized
- ○
added the required property
//to the response with the statusresponse-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
Of the 74 revisions, 1 has no diff computed.