Skip to main content

Change subscription plan​

Change a subscription plan by ID.

Path Parameters
    org_id string required
    id string required

    ID of the subscription to update

Request Body required
    billing_id ID of the billing account to update the subscription for
    plan plan to change to deprecated in favor of plan_change
    immediate should the change be immediate or at the end of the current billing period deprecated in favor of plan_change
    plan_change object
    plan plan to change to
    immediate should the change be immediate or at the end of the current billing period
    phase_change object
    cancel_upcoming_changes should the upcoming changes be cancelled
Responses

A successful response.

Schema
    phase object
    effective_at date-time
    plan_id string
POST /v1beta1/organizations/:org_id/billing/subscriptions/:id/change

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
org_id — path required
id — path required
Body required
{

  "billing_id": "string",

  "plan": "string",

  "immediate": true,

  "plan_change": {

    "plan": "string",

    "immediate": true

  },

  "phase_change": {

    "cancel_upcoming_changes": true

  }

}
curl / cURL
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/billing/subscriptions/:id/change' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "billing_id": "string",
  "plan": "string",
  "immediate": true,
  "plan_change": {
    "plan": "string",
    "immediate": true
  },
  "phase_change": {
    "cancel_upcoming_changes": true
  }
}'