Skip to main content
POST
/
v1
/
c
/
contract
/
{contract_id}
/
upgrade
cURL
curl --request POST \
  --url http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade \
  --header 'Content-Type: application/json' \
  --header 'wb-key: <api-key>' \
  --data '
{
  "upgrade_configuration": {
    "activation": {
      "type": "next_cycle"
    },
    "currency": "usd",
    "cycle": "once",
    "plan_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
    "unit_configuration": {},
    "unit_count_configuration": {},
    "upgrade_strategy": "new_plan",
    "discount_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
    "pricing_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
  },
  "downgrade_allowed": true
}
'
"Cont_cc871a3a-2b38-4689-a32d-14bf2e62b1ae"

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.

  • Option 1
  • Option 2
  • Option 3
​
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

Upgraded

The response is of type string.