Read all subscriptions

This endpoint allows you to retrieves a list of all subscriptions.

Token scope - Read subscription contracts

Rate limit - 2 requests per 3 seconds

Note: This endpoint returns data in descending order of Id


Query Params
string

The cursor returned in the previous response. Use the nextCursor value from that response to fetch the next page of results.

string

The number of records to return per page. Maximum - 100

int32

Start of the time range (in epoch) for filtering customers based on their last update time.

int32

End of the time range (in epoch) for filtering customers based on their last update time.

string
enum
Allowed:
int32

Start of the time range (in epoch) for filtering subscriptions based on their next billing date.

int32

End of the time range (in epoch) for filtering subscriptions based on their next billing date.

string
enum

Filters subscriptions by their last order status (e.g., Skipped, delayed or partially billed)

Allowed:
string

Start of the time range (in epoch) for filtering subscriptions based on their createdAt date.

int32

End of the time range (in epoch) for filtering subscriptions based on their createdAt date.

string
enum

Filter subscriptions by their last order payment status. This filter is used to filter subscriptions that are in dunning.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json