PATCH
Update a subscription

Authorizations

x-api-key
string
header
required

Server-side merchant API key. Never expose it in browser code.

Path Parameters

id
string
required

The resource identifier returned by the merchant API.

Body

application/json
customerId
string
required
priceId
string
required
trialDays
integer
Required range: x >= 0
couponId
string
successUrl
string<uri>
cancelUrl
string<uri>
metadata
object

Response

Resource updated

id
string
required
customerId
string
required
status
enum<string>
required
Available options:
trialing,
active,
past_due,
paused,
cancelled,
incomplete
priceId
string
trialEndsAt
string<date-time>
currentPeriodEnd
string<date-time>
cancelAtPeriodEnd
boolean
metadata
object