Update subscription

📘
To update the information about subscription use secret token. The update_subscriptions access scope is required. Reach out to us at [email protected] to add the scope.

Headers

Name	Type	Description
Authorization	string	oAuth token with mandatory `Bearer` before it. Example: `Bearer e*s0`, where `e*s0` should be replaced with your oAuth token.

Request

A JSON object of type 'Subscription' with the following fields:

Subscription

Field	Type	Description
chargeSettings	Array<ChargeSettings>	Charge settings information.
nextCharge	string	Subscription's next charge date and time. E.g. 2021-07-16 12:53:40 +0000.
status	string	Subscription status. Supported values: `ACTIVE`, `CANCELLED`, `LAST_CHARGE_FAILED` or `REQUIRES_PAYMENT_CONFIRMATION`.

ChargeSettings

Field	Type	Description
recurringInterval	string	Charge recurring interval. Supported values: `DAY`, `WEEK`, `MONTH`, `YEAR`.
recurringIntervalCount	number	Charge recurring interval. Supported values: for `DAY` - 1 (daily), for `WEEK` - 1 (weekly), 2 (biweekly), for `MONTH` - 1 (monthly), 3 (quarterly), for `YEAR` - 1 (annually).

{
  "status": "ACTIVE",
  "chargeSettings": {
      "recurringInterval": "DAY",
      "recurringIntervalCount": 1
  },
  "nextCharge": "2021-05-27 13:37:46 +0000"
}

{
  "status": "CANCELLED",
  "chargeSettings": {
      "recurringInterval": "DAY",
      "recurringIntervalCount": 1
  }
}