Skip to main content
GET
List checkouts

Authorizations

Authorization
string
header
required

Authorization: Bearer ck_test_… or ck_live_…. There is no other auth scheme — no query-string keys, no request signing, no OAuth.

Query Parameters

limit
integer
default:20

Page size. Must be an integer from 1 to 100; anything else is a 400.

Required range: 1 <= x <= 100
cursor
string<date-time>

The previous page's nextCursor — an ISO 8601 timestamp. Returns rows created strictly before it.

status
enum<string>

Filter to one status. An unrecognised value is a 400, not an empty page. succeeded, failed and cancelled are terminal; nothing leaves them.

Available options:
queued,
running,
awaiting_user_action,
succeeded,
failed,
cancelled
subject
string

Filter to one end user. Composes with status, limit and cursor; a subject with no checkouts is an empty page, not an error.

A subject-bound key does not need this — its page is already narrowed to one person. Passing its own subject is fine; naming a different one is a 403, refused rather than quietly ignored.

Validated like every other subject: 1 to 200 characters, or 400.

Required string length: 1 - 200

Response

A page of summaries.

data
CheckoutSummary · object[]
required
nextCursor
string<date-time> | null
required

Pass back as ?cursor=. null means this was the last page.