Sign in

v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Change plan

Change the plan that a subscription sits on

put/{companyDomain}/subscriptions/{subscriptionUniqueId}/plan

Path parameters

companyDomainstring required

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

subscriptionUniqueIdstring required

The unique identifier of the subscription in the Billsby platform

Request body

planIdinteger required

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

cycleIdinteger required

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

customerUniqueIdstring required

The unique identifier of the subscription in the Billsby platform

planChangeTypeinteger

Immediate = 1 OnRenewal = 2

unitsinteger

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

allowancesinteger[]
issueRefundboolean

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

200