Order Information
User History
Prices
Coupons
Products
Licenses
Pay Links
Transactions
Plans
Subscription Users
Modifiers
One-off Charges
Webhooks
post

/2.0/subscription/payments

List all paid and upcoming (unpaid) payments.

Request example:

curl -X POST \
     -d 'vendor_id=123...' \
     -d 'vendor_auth_code=1g3g456abc' \
     -d 'subscription_id=2746' \
     -d 'from:2017-10-29' \
     -d 'to:2017-11-20' \
     https://vendors.paddle.com/api/2.0/subscription/payments

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: Payments for a specific subscription.

pattern: ^\d+$
plan
integer

Filter: The product/plan ID (single or comma-separated values)

is_paid
integer

Filter: Payment is paid (0 = No, 1 = Yes)

Allowed Values: 0, 1
from
string

Filter: Payments starting from (date in format YYYY-MM-DD)

pattern: \d{4}-\d{2}-\d{2}
to
string

Filter: Payments up to (date in format YYYY-MM-DD)

pattern: \d{4}-\d{2}-\d{2}
is_one_off_charge
integer

Filter: One-off charge payments only (0 = No, 1 = Yes)

Allowed Values: 0, 1

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.