Each subscription instance has a unique subscription ID, which you can obtain through webhooks or API requests. The API allows you to search for subscription instances, edit subscriptions, and initiate rebills on managed subscriptions.

Search for Subscription by Parameter

Append one or more parameters to the URL to filter search results. Use a ? to append the first result. For subsequent search results, use &.

👍

When using Begin & End parameters, always include the event type in your parameters, otherwise, the URL variables do not filter results based on date ranges.

Parameter

Value

accountId

Add the account ID associated with the subscriptions.

begin date

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

end

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

Events

In each event, use begin and end dates to retrieve corresponding subscriptions

Parameter

Value

canceled

Retrieve subscriptions that were canceled within a given date range

charged

Retrieve subscription rebills from a specific date range.

created

Retrieve subscriptions that were created in a specific date range.

deactivated

Retrieve subscriptions that were deactivated in a specific date range.

trialended

Retrieve subscriptions with free trials that ended in a specific date range.

trialstarted

Retrieve subscriptions with free trials that began in a specific date range.

product ids

Enter product IDs to filter by specific subscriptions.

Scope

Parameter

Value

all

Unnecessary; if you do not pass a scope parameter, the API returns both live and test-mode subscriptions by default

live

Specify scope=live to retrieve only live (non-test-mode) subscriptions

test

Specify scope=test to retrieve only test-mode (non-live) subscriptions

Status

Parameter

Value

active

Specify status=active to retrieve only subscriptions that are currently active (note: this includes subscriptions with free trial days that are still in trial status)

canceled

Specify status=canceled to retrieve only subscriptions that have been canceled but not yet deactivated

deactivated

Specify status=deactivated to retrieve only subscriptions that have been deactivated

overdue

Specify status=overdue to retrieve only subscriptions that are currently overdue due to a failed rebill charge

trial

Specify status=trial to retrieve only subscriptions that are currently in trial status (i.e., via the Free Trial