Switch Plan

post

https://api.brilo.tech/api/subscriptions/{subscription_id}/switch_plan/

Upgrades, downgrades, or changes the underlying pricing plan for an existing subscription.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscription_id

string

required

The ID of the subscription which will have its plans switched.

Body Params

switch_plan_id

uuid

The new plan to switch to.

invoicing_behavior

string

enum

Defaults to invoice_now

The invoicing behavior to use when replacing the plan. Invoice now will invoice the customer for the prorated difference of the old plan and the new plan, whereas add_to_next_invoice will wait until the end of the subscription to do the calculation.

add_to_next_invoice - Add to Next Invoice
invoice_now - Invoice Now

Allowed:

usage_behavior

string

enum

Defaults to transfer_to_new_subscription

The usage behavior to use when replacing the plan. Transfer to new subscription will transfer the usage from the old subscription to the new subscription, whereas keep_separate will reset the usage to 0 for the new subscription, while keeping the old usage on the old subscription and charging for that appropriately at the end of the month.

transfer_to_new_subscription - Transfer to New Subscription
keep_separate - Keep Separate

Allowed:

component_fixed_charges_initial_units

array of objects

The initial units for the plan components' prepaid fixed charges. In the context of swithciong plans, this is only required if the new plan has a component the old plan did not have, that has a prepaid charge, that deos not have a default.

component_fixed_charges_initial_units

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

200