Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscriptions

Update subscription

Updates a subscriptions tiers, add-ons, or interval.

Important considerations:

  • Updates cannot be made to canceled subscriptions
  • Billing will be prorated for the remaining period
  • Existing add-ons may need to be re-validated
  • Some features may be disabled if not available in new tier or add-ons
patch/subscriptions/{id}

Path parameters

idstring required

The unique identifier of the subscription to update

Request body

tierIdstring uuid nullable

Optional tier id to subscribe to.

An error is thrown if the supplied or existing add-ons are not valid for the supplied tier id.

addOnIdsstring[] nullable

Optional add-on ids to subscribe to.

An error is thrown if the supplied or existing add-ons are not valid for the existing or supplied tier id.

intervalstring nullable

Optional billing interval/pricing option to use when setting subscription tier.

If an interval is not supplied then the default interval option will be used.

If an interval is supplied but a tier is not supplied, the existing tier is used and the interval is changed.

reasonstring nullable

Optional reason for changing the subscription tier.

Example request

{
  "tierId": "8d074e85-4d95-4d9a-8a63-187719470d49",
  "interval": "Monthly"
}

Response

When request is accepted. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable