Operations API
Subscriptions

List All Subscriptions

This API endpoint (GET) retrieves all your active subscriptions. The response is paginated; therefore, you should use the 'page' parameter for navigating through the results in subsequent requests. On successful completion, it returns an array of Subscription Object the number of available results and the flags used for filtering. Permissions: subscriptions.view

Query Parameters

page * Fetch the results from a specific page. It defaults to 1.



per_page * The number of results to fetch per page. The maximum is 50, and if it defaults to 10.



from date-format Start date used for filtering (the date the customer was created).



to date-format End date used for filtering (the date the customer was created).



sort_by An optional identifier used for sorting results. Available options are status, email and payment_count.



filter Optional text used for filtering results by customer email.



customer_id If provided, it will return the subscriptions of the customer.



product_id If provided, it will return the subscriptions of the product.



cancelled Set this parameter to true if you like to fetch cancelled subscriptions.



order Determines in which order the results are returned. The available options are asc (ascending) and desc (descending). The default value is desc.



currency currency code Filters subscriptions by currency.



billing_cycle Used to filter subscriptions by billing cycle. The available options are day, week, month and year.



instalments Set this parameter to true if you like to fetch only subscriptions with type instalment.





PREVIOUS
Bulk Delete Subscriptions
NEXT
Retrieve Upgrades
Docs powered by Archbee