List subscriptions
Path parameters
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
Optional list of expandable objects.subscription_premium_tiers
- Returns an array of tiers the subscription is associated with.referrals
- Returns an array of subscriptions with limited data - id
, email
, and status
. These are the subscriptions that were referred by this subscription.stats
- Returns statistics about the subscription(s).custom_fields
- Returns an array of custom field values that have been set on the subscription.
Pagination returns the results in pages. Each page contains the number of results specified by the limit
(default: 10).
If not specified, results 1-10 from page 1 will be returned.
Optional email address to find a subscription.
This param must be an exact match and is case insensitive.
The field that the results are sorted by. Defaults to created
created
- The time in which the subscription was first created.
email
- The email address of the subscription.
The direction that the results are sorted in. Defaults to asc
asc
- Ascending, sorts from smallest to largest.
desc
- Descending, sorts from largest to smallest.
Optional date entry (in the format YYYY/MM/DD) that filters returned subscriptions by their creation date.