Skip to main content
POST
Set the quantity of a one-time item on the next renewal of a subscription (0 takes it off)

Authorizations

x-cms-token
string
header
required

CMS session JWT from /api/v1/cms/session/login. Customer account operations require an email-verified session; signed offer links accept an anonymous store session.

Body

application/json
subscriptionId
string
required
Minimum string length: 1
productId
string
required
Minimum string length: 1
variantId
string
required
Minimum string length: 1
quantity
integer
required
Required range: 0 <= x <= 100

Response

Successful response

subscription
object | null
required
membership
object | null
required