List all Checkout Sessions

GET {{baseUrl}}/v1/checkout/sessions

Returns a list of Checkout Sessions.

Request Params

KeyDatatypeRequiredDescription
customerstringOnly return the Checkout Sessions for the Customer specified.
customer_details[email]stringOnly return the Checkout Sessions for the Customer details specified.
ending_beforestringA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
expand[0]stringSpecifies which fields in the response should be expanded.
expand[1]stringSpecifies which fields in the response should be expanded.
limitstringA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
payment_intentstringOnly return the Checkout Session for the PaymentIntent specified.
starting_afterstringA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
subscriptionstringOnly return the Checkout Session for the subscription specified.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring