PUT /v1/subscriptions/{id} endpoint lets you modify an existing subscription. You can cancel a subscription by setting status to CANCELLED, adjust the recurring amount by passing a new amount, or do both in a single request. At least one field must be included in the request body. This endpoint requires the subscriptions:write permission on your API key.
Path parameters
The unique identifier of the subscription to update, for example
sub_01HABC1234MNOPQR.Request body
Response
On success the endpoint returns the updated Subscription object.The response never includes the display-currency fields (
displayCurrency, displayAmount, fxRate, fxRateTableId, fxRateAsOf) or lastChargeFx. Changing the amount removes the five from the subscription record, so the subscription.updated webhook for this change arrives without them; lastChargeFx is kept because it describes a charge that already happened. See Display currency and amount changes.Response codes
Examples
Response