Skip to navigation
API ReferenceCheckout Sessions

List Checkout Sessions

Lists your Checkout Sessions in the key’s mode, newest first, so you can reconcile payments without having kept every id. Narrow it with status and a from/to created range. To page, pass the nextCursor you got as cursor until it is null.

Authentication

AuthorizationBearer

Your secret key: sk_test_… in Test mode, sk_live_… in Live mode.

Query parameters

limitstringOptional

1 to 100; defaults to 10.

cursorstringOptional

The nextCursor from the previous page; returns the sessions older than it. Opaque: don’t build or change one.

statusstringOptional

Only sessions with this status: one of pending, succeeded, failed or cancelled.

fromstringOptional
Only sessions created at or after this Unix ms timestamp.
tostringOptional
Only sessions created at or before this Unix ms timestamp.

Response

A page of Checkout Sessions.
datalist of objects
This page of Checkout Sessions, newest first.
nextCursorstring or null

Pass as cursor to get the next page; null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error