Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-25"

Query Parameters

account_id
string
required

Account ID, prefixed biz_.

plan_id
string

Only return checkout configurations for this plan ID, prefixed plan_.

created_before
string

Only return checkout configurations created before this ISO 8601 timestamp.

created_after
string

Only return checkout configurations created after this ISO 8601 timestamp.

order
enum<string>
default:created_at

Field used to sort checkout configurations.

Available options:
created_at
direction
enum<string>
default:desc

Sort direction. Defaults to desc.

Available options:
asc,
desc
first
integer
default:20

Number of results to return from the start of the range.

Required range: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

Response

checkout configurations listed

data
object[]
required
page_info
object
required