Operations API
Subscriptions

Update Subscription

This API endpoint (POST) updates the billing plan of a subscription. If the request succeeds, it returns a Subscription Object. Permissions: subscriptions.edit Webhook event: subscription-updated

If you want to see which billing plans are available to use as upgrades and downgrades before making the request, see the Retrieve Upgrades endpoint.

Path Parameters

id * The id of the subscription to update.

Body Parameters

id string * The id of the new billing plan.



pricing_model_id string * The id of the new pricing model.



prorations boolean Determines whether any charges that might occur due to the upgrade will be prorated. The default value is false.