Retrieve a subscription

get

https://api.fastspring.com/subscriptions/{subscription_id}

Retrieves the details of a subscription with the given subscription_id.

Path Params

subscription_id

string

required

Unique identifier for the subscription.

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. Use commas to separate multiple values.

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:

Responses

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

400Bad Request

401Authentication credentials are missing or invalid.

429Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header.

500Internal server error.