Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
checkouts
public

List Checkout Sessions

List checkout sessions.

Scopes: checkouts:read checkouts:write

get/v1/checkouts/

Query parameters

string uuid4

The organization ID.

OR
string[]
Example:1dbfc517-0bbf-4301-9ba8-555ca42b9737

Filter by organization ID.

string uuid4

The product ID.

OR
string[]

Filter by product ID.

string uuid4

The customer ID.

OR
string[]

Filter by customer ID.

string

The customer external ID.

OR
string[]

Filter by customer external ID.

'open' | 'expired' | 'confirmed' | 'succeeded' | 'failed'
OR
CheckoutStatus[]

Filter by checkout session status.

querystring nullable

Filter by customer email.

Filter by customer email.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingCheckoutSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response