Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26336777.7 KB

post/subscription/edit

Headers

Idempotency-Keystring

A unique key for making the request idempotent. Must match pattern: ^[a-zA-Z0-9\-_:\.]+$. See Idempotent Requests for more details.

Request body

subscriptionIdstring required

Unique identifier of the subscription

newAmountinteger

New recurring amount for the subscription, if changed. The amount in lowest count unit. e.g.: For USD 1, amount is 100 representing 100 cents (The minimum amount should be greater than 1 USD).

newCycleCountinteger

New number of billing cycles for the subscription, if changed.

newNextPaymentDateinteger

New next payment date in epoch milliseconds, if changed. Future payments will be deducted at the frequency interval defined in the subscription, calculated from the new next payment date.

interval'DAY' | 'WEEK' | 'MONTH' | 'YEAR'

The interval group between subscriptions.

⚠️ Please note: When editing interval, intervalCount and newNextPaymentDate must also be provided.

intervalCountinteger

The number of intervals between subscription billings. For example, interval = MONTH and intervalCount = 3 bills every 3 months.

⚠️ Please note: When editing intervalCount, interval and newNextPaymentDate must also be provided.

Example request

{
  "subscriptionId": "sub_fooBOwYsaK50AEfK",
  "newAmount": 1000,
  "newCycleCount": 6,
  "newNextPaymentDate": 1753104947000,
  "interval": "MONTH",
  "intervalCount": 2
}

Response

Subscription edited successfully