Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Subscriptions

Switch product tier

Changes a subscription's product tier to the specified tier.

Important considerations:

  • Tier changes take effect immediately
  • 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
patch/subscriptions/{subscriptionId}/tiers/{id}

Path parameters

subscriptionIdstring required

The unique identifier of the subscription to update

idstring uuid required

The identifier of the target product tier

Request body

promotionIdstring nullable

Optional Promotion ID. If the provided promotion id does not exist, the request will fail.

intervalstring nullable

Optional billing interval/pricing option.

If no interval is provided then the default pricing option will be used.

If the interval is provided but does not exist, the request will fail.

reasonstring nullable

Optional reason for changing the subscription tier.

Example request

{
  "interval": "Monthly"
}

Response

When request is accepted. Returns a 'Link' object to the subscription.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable