List all subscriptions

get

https://api.fastspring.com/subscriptions

Returns a list of all subscription IDs.

Query Params

accountId

string

Filter subscriptions by the associated account ID.

begin

date

Specify the beginning of a date range in yyyy-mm-dd format.

end

date

Specify the end of a date range in yyyy-mm-dd format.

event

string

enum

Specify the event type to filter results. Valid values include canceled, charged, created, deactivated, trialended, or trialstarted.

Must be used with the begin and end parameters.

Allowed:

products

string

Filter subscriptions by specific product IDs.

scope

string

enum

Specify the scope to filter by test or live subscriptions. If not provided, both live and test subscriptions are returned by default.

Allowed:

status

string

enum

Specify the subscription status to filter results. Valid values include active, canceled, deactivated, overdue, or trial.

Allowed:

page

integer

Specify the page number of results to retrieve. Defaults to 1 if not provided.

limit

integer

Specify the maximum number of results per page. Defaults to 50 if not provided.

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK