Sample - Stripe API
GET/v1/checkout/sessions

List Checkout Sessions

Lists Checkout Sessions, optionally filtered by creation interval, customer, payment relationship, or session status. Use cursor parameters and limit to paginate the results, which are returned in the API's list format. You can request expanded fields with expand.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

12 parameters
createdobjectoptional
Filter Checkout Sessions by creation time using a Unix timestamp or a range with `gt`, `gte`, `lt`, or `lte`.
customerstringoptional
Return only Checkout Sessions for the specified Customer. Maximum 5,000 characters.
customer_accountstringoptional
Return only Checkout Sessions for the specified Account. Maximum 5,000 characters.
customer_detailsobjectoptional
Filter by customer details; the object must include an `email` value.
ending_beforestringoptional
Cursor identifying the object before which to return results.
expandarray<string>optional
Fields to expand in the response. Each field name can be up to 5,000 characters.
limitintegeroptional
Maximum number of Checkout Sessions to return. Must be between 1 and 100. Defaults to 10 when omitted.
payment_intentstringoptional
Return the Checkout Session associated with the specified PaymentIntent. Maximum 5,000 characters.
payment_linkstringoptional
Return Checkout Sessions associated with the specified Payment Link. Maximum 5,000 characters.
starting_afterstringoptional
Cursor identifying the object after which to return results.
statusstringoptional
Filter by Checkout Session status: complete, expired, or open.
Allowed:completeexpiredopen
subscriptionstringoptional
Return the Checkout Session associated with the specified subscription. Maximum 5,000 characters.

2 status codes
200Returns a paginated list object containing Checkout Sessions in `data`, a `has_more` indicator, the list object type, and the list URL.
dataarray<CheckoutSession>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultReturned when the list request cannot be processed because a supplied filter, cursor, or pagination value is invalid.
errorobjectrequired

Error handling

limit must be an integer between 1 and 100 and defaults to 10 when omitted. status must be one of: complete, expired, or open; customer_details must include an email value when supplied. Cursor values in starting_after and ending_before must identify list positions.