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
string
required
The unique identifier of the subscription to update, for example
sub_01HABC1234MNOPQR.Request body
string
New status for the subscription. Accepted values:
ACTIVE, CANCELLED.number
New recurring charge amount in US dollars. Must be a positive number.
Response
On success the endpoint returns the updated Subscription object.string
required
Unique identifier for the subscription.
string
required
Updated subscription status. One of:
ACTIVE, CANCELLED.number
required
Updated recurring charge amount in US dollars.
string
required
Billing frequency. One of:
DAILY, WEEKLY, MONTHLY, ANNUALLY.string
required
ISO 8601 date of the next scheduled charge.
string
required
ISO 8601 date of the most recent successful charge.
string
required
ISO 8601 date when the subscription is scheduled to end.
boolean
required
Whether the donor elected to cover processing fees on each charge.
Response codes
Examples
Response