Other

Change an existing subscription to a new price.

This will immediately change their subscription to the new plan if upgrading, prorating the charge. If the user is downgrading to a lower price, it will schedule the change at the end of the current billing period.

<pre class="prettyprint"> <b>GET</b> /api/v2/stripe/change-plan/?subscription_id=<code>{subscription_id}</code>&price_id=<code>{price_id}</code> </pre>

Example

  curl -X GET https://[kpi]/api/v2/stripe/change-plan/

Payload

   {
      "price_id": "price_A34cds8fmske3tf",
      "subscription_id": "sub_s9aNFrd2fsmld4gz",
      "quantity": 100000
   }

where:

  • "price_id" (required) is the Stripe Price ID for the plan the user is changing to.
  • "quantity" is the quantity for the new subscription price (default: 1).
  • "subscription_id" (required) is a Stripe Subscription ID for the subscription being changed.
get/api/v2/stripe/change-plan

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Response

price_idstring required
subscription_idstring required
quantityinteger

Changes

No recorded changes to this operation across all 50 revisions of this API.