List Users

post

/2.0/subscription/users

List all users subscribed to any of your subscription plans

Example Request

preparing...

Usage Notes

Optionally, specify the plan_id, subscription_id, and/or state to filter the response to just users of a specific plan, a user subscription, or the status of the user's subscription.
The plan_id field is passed in as a string however 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_page to 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 quantity purchased by the user.
This endpoint is paginated, with a max 250 results per page. Use the page and results_per_page parameters to work with pagination.

Request

Body

vendor_id

integer

required

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

>= 1

vendor_auth_code

string

required

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.

Match pattern:

[0-9a-f]+

subscription_id

integer

Filter: A specific user subscription ID

>= 1

plan_id

string

Filter: The subscription plan ID

Match pattern:

\d+

state

string

Filter: The user subscription status. Returns all active, past_due, trialing and paused subscription plans if not specified. A list of possible values and their meanings can be found under Event Statuses.

Allowed values:

activepast_duetrialingpauseddeleted

page

integer

Paginate return results

>= 1

results_per_page

integer

Number of records to return per page.

>= 1<= 250

Body