Subscriptions
Update Subscription
Subscriptions
Update Subscription
Update a subscription’s details.
PATCH
/
subscriptions
/
{subscription_id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
subscription_id
string
requiredSubscription Id
Body
application/json
status
enum<string>
requiredAvailable options:
pending, active, on_hold, paused, cancelled, failed, expired Response
200 - application/json
created_at
string
requiredcurrency
enum<string>
requiredAvailable 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 customer
object
requirednext_billing_date
string
requiredpayment_frequency_count
integer
requiredpayment_frequency_interval
enum<string>
requiredAvailable options:
Day, Week, Month, Year product_id
string
requiredquantity
integer
requiredrecurring_pre_tax_amount
integer
requiredstatus
enum<string>
requiredAvailable options:
pending, active, on_hold, paused, cancelled, failed, expired subscription_id
string
requiredsubscription_period_count
integer
requiredsubscription_period_interval
enum<string>
requiredAvailable options:
Day, Week, Month, Year trial_period_days
integer
required