Change plan

put

https://public.billsby.com/api/v1/rest/core/{companyDomain}/subscriptions/{subscriptionUniqueId}/plan

Change the plan that a subscription sits on

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

In this API request you can specify exactly which plan and cycle you would like to change a subscription to. You are also able to outline when the plan change would take effect. This query exists so you can action a plan change programmatically rather than using our account management functionality.

Path Params

companyDomain

string

required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

subscriptionUniqueId

string

required

The unique identifier of the subscription in the Billsby platform

Body Params

planId

int32

required

The unique identifier of the plan that you want to change the subscription to in the Billsby platform

cycleId

int32

required

The unique identifier of the cycle that you want to change the subscription to in the Billsby platform

customerUniqueId

string

required

The unique identifier of the subscription in the Billsby platform

planChangeType

int32

Defaults to 1

Immediate = 1 OnRenewal = 2

units

int32

The number of units required (for cycles with mulitple units allowed)

addOns

array of objects

addOns

allowances

array of int32s

allowances

issueRefund

boolean

Defaults to false

In case of immediate change, this will apply a refund into the first invoice of the new plan based on the prorated amount of the current plan

Response

200200