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

Reschedule Payment

post
/2.0/subscription/payments_reschedule

Example Request

preparing...
  • You may need to first call the List Payments API to get an upcoming (is_paid is 0) payment ID value to make this call.
  • Rescheduling a payment doesn't recalculate the customer's billing schedule.
  • Causes all future payments to be rescheduled on the basis of the date chosen, using the same billing interval. For example, moving a monthly subscription payment date from Jan 30th to Jan 15th changes the recurring billing date to 15th of each month.
  • Subscription state is not impacted.
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]+
payment_id
integer
required

The upcoming subscription payment ID. This can be obtained by calling the List Payments API.

date
string
required

The date (in format YYYY-MM-DD) you want to move the payment to.

Match pattern:
\d{4}-\d{2}-\d{2}
Body
:
:
:
: