List Subscriptions

The List Subscriptions endpoint allows you to retrieve a list of all active subscriptions within your organization. Use this endpoint to track and manage your organization's ongoing subscriptions with its customers.

Note

A subscription is created automatically when a customer makes a payment on a recurring plan. Use this endpoint to track all active subscriptions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Retrieve a list of subscriptions for a particular customer.

string
enum

Retrieve subscriptions based on their respective status.

Allowed:
string

Retrieve subscriptions after this timestamp.

string

Retrieve subscriptions before this timestamp.

integer
1 to 100

Maximum number of subscriptions to retrieve per page (default=100).

integer
≥ 1

Page number of the results to retrieve (default=1).

string

Retrieve subscriptions since this timestamp.

string
enum

Sort order for the retrieved subscriptions (ascending or descending).

Allowed:
string

Retrieve subscriptions until this timestamp.

Responses

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