POpolar
checkouts
public

List Checkout Sessions

Changed on

List checkout sessions.

Scopes: checkouts:read checkouts:write

get/v1/checkouts/

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/checkouts/
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: checkouts:read, checkouts:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4

The organization ID.

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

The product ID.

OR
string[]
string uuid4

The customer ID.

OR
string[]
string

The customer external ID.

OR
string[]
'open' | 'expired' | 'confirmed' | 'succeeded' | 'failed'
OR
CheckoutStatus[]
querystring nullable

Filter by customer email.

pageinteger

Page number, defaults to 1.

limitinteger

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.

Response

Successful Response

Changes