PATCH
/
v1
/
subscriptions
/
{id}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Subscription ID

Body

application/json

Details used to update subscription

channel
enum<string>

Channel

Available options:
WEBSITE,
POS
customer
object

Customer details to be updated

shipTo
object

Ship to details

billTo
object

Billing address update details

paymentDetails
object

Payment details to be updated

customAttributes
object

Custom attributes

item
object

Item details to be updated

plan
object

Subscription plan details

offer
object

Offer details to be updated

shipping
object

Shipping details to be updated

expiry
object

Expiration date and billing cycle

Response

200 - application/json

Subscription returned by ID

responseStatus
string

Brief response status

message
string

Full response message

data
object

Subscription details