Retrieve a Checkout Session
GET / v1 / checkout / sessions /:id
Retrieves a Checkout Session object.
Parameters
No parameters.
Returns
Returns a Checkout Session object.
Response
Retrieve a Checkout Session's line items
GET / v1 / checkout / sessions /:id / line_items
When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
Parameters
No parameters.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
A dictionary with a data property that contains an array of up to limit Checkout Session line items, starting after Line Item starting_after. Each entry in the array is a separate Line Item object. If no more line items are available, the resulting array will be empty.
Response
List all Checkout Sessions
GET / v1 / checkout / sessions
Returns a list of Checkout Sessions.
Parameters
- payment _ intent string Only return the Checkout Session for the PaymentIntent specified.
- subscription string Only return the Checkout Session for the subscription specified.
More parameters
- created object
- customer string
- customer _ account string
- customer _ details object
- ending _ before string
- limit integer
- payment _ link string
- starting _ after string
- status enum
Returns
A dictionary with a data property that contains an array of up to limit Checkout Sessions, starting after Checkout Session starting_after. Each entry in the array is a separate Checkout Session object. If no more Checkout Sessions are available, the resulting array will be empty.
Response