get
/v1/checkout/sessions List all Checkout Sessions
GetCheckoutSessions
<p>Returns a list of Checkout Sessions.</p>
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
created | query | object | integer | no | Only return Checkout Sessions that were created during the given date interval. |
customer | query | string | no | Only return the Checkout Sessions for the Customer specified. |
customer_account | query | string | no | Only return the Checkout Sessions for the Account specified. |
customer_details | query | object | no | Only return the Checkout Sessions for the Customer details specified. |
ending_before | query | string | no | A 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 | query | string[] | no | Specifies which fields in the response should be expanded. |
limit | query | integer | no | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
payment_intent | query | string | no | Only return the Checkout Session for the PaymentIntent specified. |
payment_link | query | string | no | Only return the Checkout Sessions for the Payment Link specified. |
starting_after | query | string | no | A 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. |
status | query | string | no | Only return the Checkout Sessions matching the given status. |
subscription | query | string | no | Only return the Checkout Session for the subscription specified. |
Request Body
application/x-www-form-urlencoded Responses
200 Successful response.
default Error response.