Skip to main content
GET
List Subscriptions

Authorizations

Authorization
string
header
required

Authentication: Customer session tokens authenticate buyers within your organization. Generate one through the customer session operation.

Query Parameters

product_id

Return only records matching product ID. Identifier of the product.

active
boolean | null

Return only records matching active or cancelled subscription.

query
string | null

Parameter: Search by product or organization name.

page
integer
default:1

Results page to return. The first page is used by default.

limit
integer
default:10

Records returned per page. Defaults to 10 and accepts up to 100.

sorting
enum<string>[] | null

Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.

Available options:
started_at,
-started_at,
amount,
-amount,
status,
-status,
organization,
-organization,
product,
-product

Response

Request completed successfully

items
CustomerSubscription · object[]
required
pagination
Pagination · object
required