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

/2.0/subscription/users

List all users subscribed to any of your subscription plans.

Optionally also accepts plan_id, subscription_id, and state to filter the response to just users of a specific plan, a user subscription, or the status of the user’s subscription.

Example Request

curl -X POST \
     -d 'vendor_id=123' \
     -d 'vendor_auth_code=1a4g5hjk6bc' \
     -d 'subscription_id=344566' \
     https://vendors.paddle.com/api/2.0/subscription/users

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
string

A specific subscription ID

pattern: \d+
plan_id
string

The subscription plan ID

pattern: \d+
state
string

The user subscription status. Returns all active, past due, trialling and paused subscription plans if not specified.

Allowed Values: active, past_due, trialling, deleted, paused
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
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.