put https://app.ecwid.com/api/v3//subscriptions/
Update the details of a specific subscription using its unique subscription ID.
Access scopes
Requires the following access scope: update_subscriptions
Request
A JSON object with the following fields:
| 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
}
}