Order Details
User History
Prices
Coupons
Products
Licenses
Pay Links
Transactions
Payments
Webhooks
post

/2.0/subscription/users

List all users subscribed to any of your subscription plans

Example Request

curl -X POST -d 'vendor_id=1234567' \
             -d 'vendor_auth_code=123456abc...' \
             -d 'subscription_id=12345' \
https://vendors.paddle.com/api/2.0/subscription/users

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.
  • 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.

Request Body

Form data (application/x-www-form-urlencoded)
vendor_id
integer

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

required
minimum: 1
pattern: \d+
vendor_auth_code
string

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.

required
pattern: [0-9a-f]+
subscription_id
integer

Filter: A specific user subscription ID

minimum: 1
pattern: \d+
plan_id
string

Filter: The subscription plan ID

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: active, past_due, trialing, paused, deleted
page
integer

Paginate return results

minimum: 1
pattern: \d+
results_per_page
integer

Number of subscription records to return per page.

maximum: 200
minimum: 1
pattern: \d+

Responses

1 Example
Schema
object

Success response

or
object

An unsuccessful call to the Dashboard API will return a 200 response containing a field success set to false and an error object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.