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
List Plans
post
Users
Modifiers
Payments
One-off Charges
Alert API
Alert API
Webhooks

List Plans

post
/2.0/subscription/plans

Example Request

preparing...
  • Optionally, specify the plan ID in order to return just the information related to that specific plan.
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]+
plan
integer

Filter: The product/plan ID

Body
:
:
: