Subscriptions
Update Subscription
Subscriptions
Update Subscription
Update a subscription’s details.
PATCH
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Subscription Id
Body
application/json
Available options:
pending, active, on_hold, paused, cancelled, failed, expired Response
200 - application/json
Subscription successfully updated
Response struct representing subscription details
Timestamp when the subscription was created
Available options:
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW Timestamp of the next scheduled billing
Number of payment frequency intervals
Available options:
Day, Week, Month, Year Identifier of the product associated with this subscription
Number of units/items included in the subscription
Amount charged before tax for each recurring payment in smallest currency unit (e.g. cents)
Available options:
pending, active, on_hold, paused, cancelled, failed, expired Unique identifier for the subscription
Number of subscription period intervals
Available options:
Day, Week, Month, Year Indicates if the recurring_pre_tax_amount is tax inclusive
Number of days in the trial period (0 if no trial)
The discount id if discount is applied