Upgrade/Change Plan

Authorizations

wb-key

string

header

required

Path Parameters

contract_id

string

required

Id of the Contract

Body

application/json

Upgrade configuration used when WbCustomer is performing a Contract Upgrade for a Customer

upgrade_configuration

object

required

Type of plan upgrade:

NewPlan - upgrade to a different plan
ChangeUnitCount - only increase or decrease the number of purchased units for the current plan

The main difference between ChangeUnitCount and using NewPlan with the ID of the same plan is that if the prices of features changed between contract creation and current time, ChangeUnitCount will preserve the prices of features recorded in the contract, while using NewPlan will also mean that new prices will take effect.

upgrade_configuration.activation

object

required

Configuration to choose the date when upgrade takes place:

NextCycle - at the beginning of the next billing cycle
Date - at the specific date (UTC)

upgrade_configuration.currency

enum<string>

required

A supported currency

The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")

Available options:

usd,

eur,

gbp,

brl,

ars

upgrade_configuration.cycle

enum<string>

required

Enum that lists supported payment cycles for contracts:

Once - one-time payment
Constant - one-time payment for the duration of the contract
Week - contract is paid weekly
Month - contract is paid monthly
Quarter - contract is paid every quarter
Year - contract is paid yearly

Available options:

once,

hour,

day,

week,

month,

quarter,

year,

constant

upgrade_configuration.plan_id

string

required

Unique identifier of an object. Consists of object class prefix and a UUID

upgrade_configuration.unit_configuration

object

required

Configuration specifying overrides to apply to new plan during contract upgrade. In addition to the number of units to purchase, it is possible to override price and flat_fee of specific features to create customized plans See UnitConfiguration for format

upgrade_configuration.unit_count_configuration

object

required

Configuration specifying the number of units to purchase on the new plan for unit-based features. This is a hashmap where keys are slugs of features, and values are the numbers of units to purchase { "{feature_slug}": {number_of_units} }

upgrade_configuration.upgrade_strategy

enum<string>

required

Available options:

new_plan

upgrade_configuration.discount_id

string

Unique identifier of an object. Consists of object class prefix and a UUID

upgrade_configuration.pricing_id

string

Unique identifier of an object. Consists of object class prefix and a UUID

downgrade_allowed

boolean

By default downgrading to a cheaper plan can only be done at the end of the billing cycle This is done to avoid the need to refund unused part of the current billing cycle from the old contract However, WbCustomer may override this behaviour, and force immediate downgrade by setting this argument to true. Default is false

Response

200 - application/json

The response is of type string.

Welcome

Guides

Wingback.js

Advanced

API Reference

Upgrade/Change Plan

Authorizations

Path Parameters

Body

Response