API Reference · Checkout Sessions

List checkout sessions

Returns a cursor-paginated list of checkout sessions, newest first.

GET/v1/checkout/sessions

Use `starting_after` and `ending_before` for cursor pagination — do not rely on page numbers. The response is an envelope `{ data, has_more, object: "list" }`.

Query parameters

limitintegerdefault: 10

Maximum number of sessions to return. Min 1, max 100.

Constraints: 1 <= limit <= 100

starting_afterstring

Return sessions after this id. Use the id of the last element of the previous page.

ending_beforestring

Return sessions before this id. Use the id of the first element of the previous page.

statusstring

Only return sessions in this status.

Allowed values: OPEN COMPLETE EXPIRED

Errors

422
invalid_request_error

Invalid query parameter (e.g., `limit` out of range).