API Reference
Overview
Quick Start
API Authentication
API Error Codes
APIs
Checkout API
Checkout API
Order Details
User History
Prices
Product API
Product API
Coupons
Products
Licenses
Pay Links
Transactions
Payments
Subscription API
Subscription API
Plans
Users
Modifiers
Payments
List Payments
post
Reschedule Payment
post
One-off Charges
Alert API
Alert API
Webhooks

List Payments

post
/2.0/subscription/payments
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: Payments for a specific subscription.

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:
01
from
string

Filter: Payments starting after the date specified (date in format YYYY-MM-DD)

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

Filter: Payments ending the day before the date specified (date in format YYYY-MM-DD)

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

Filter: Non-recurring payments created from the Charges API (0 = No, 1 = Yes)

Allowed values:
01
Body
:
:
:
:
:
:
:
: