Skip to main content
PATCH
Update a Subscription
Only metadata, failure_policy, and retry_offsets_days are editable. Other fields (interval, amount, currency, card) are immutable — create a new subscription to change them. A subscription.updated webhook is dispatched when the subscription changes.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Public subscription id (UUID).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
metadata
object | null
failure_policy
enum<string>
Available options:
immediate_cancel,
retry_then_cancel
retry_offsets_days
integer[]
Required array length: 1 - 10 elements
Required range: 1 <= x <= 30

Response

Success

success
boolean
required
requestId
string
required
data
object
required