Sign in
latestOpenAPI 3.0.12026-07-225791279.7 KB

1ecd4b94ff07

Subscription Lifecycle

Change Plan

This changes the subscription to another pricing plan either immediately or at the next billing cycle.

Notes:

  • effective defaults to NEXT_CYCLE if not supplied.
  • When effective is NEXT_CYCLE, the new plan is stored as the pending plan and becomes active at the next successful billing cycle.
  • When effective is IMMEDIATELY, the subscription is switched to the new plan immediately.
  • Attempting to change to the current plan or modifying a terminal subscription returns a validation error.
post/subscription/api/v1/subscriptions/{id}/change-plan

Path parameters

idstring required

The ID of the subscription.

Request body

newPlanCodestring required

The plan code of the new subscription plan.

effectivestring

When the new plan should take effect. Supported values are IMMEDIATELY and NEXT_CYCLE.

prorateboolean

Indicates whether the current billing cycle should be prorated.

Example request

{
  "newPlanCode": "PLAN-XY99ZZ00",
  "effective": "NEXT_CYCLE",
  "prorate": true
}

Response

Request Successful

B9aaaf35387f42a99fd9D7b0292aacbc required— unresolved $ref