- Optionally, specify the
stateto filter the response to just users of a specific plan, a user subscription, or the status of the user's subscription.
plan_idfield is passed in as a
stringhowever the content of this string must be numbers.
- If you're not filtering by the
subscription_id, we strongly recommend that you utilize the
results_per_pageto limit the amount of results returned within each API call. This ensures that the response time remains quick and consistent as the amount of user subscriptions build up over time.
- For any quantity-enabled subscription plans, the response will include the
quantitypurchased by the user.
The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.
The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.
Filter: A specific user subscription ID
Filter: The subscription plan ID
Filter: The user subscription status. Returns all
paused subscription plans if not specified. A list of possible values and their meanings can be found under Event Statuses.
Paginate return results
Number of subscription records to return per page.