cURL
curl --request POST \
--url http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate \
--header 'Content-Type: application/json' \
--header 'wb-key: <api-key>' \
--data '
{
"upgrade_configuration": {
"activation": {
"type": "next_cycle"
},
"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
}
'import requests
url = "http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate"
payload = {
"upgrade_configuration": {
"activation": { "type": "next_cycle" },
"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
}
headers = {
"wb-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'wb-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
upgrade_configuration: {
activation: {type: 'next_cycle'},
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
})
};
fetch('http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'upgrade_configuration' => [
'activation' => [
'type' => 'next_cycle'
],
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"wb-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate"
payload := strings.NewReader("{\n \"upgrade_configuration\": {\n \"activation\": {\n \"type\": \"next_cycle\"\n },\n \"plan_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_configuration\": {},\n \"unit_count_configuration\": {},\n \"upgrade_strategy\": \"new_plan\",\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\"\n },\n \"downgrade_allowed\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("wb-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate")
.header("wb-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"upgrade_configuration\": {\n \"activation\": {\n \"type\": \"next_cycle\"\n },\n \"plan_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_configuration\": {},\n \"unit_count_configuration\": {},\n \"upgrade_strategy\": \"new_plan\",\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\"\n },\n \"downgrade_allowed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["wb-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upgrade_configuration\": {\n \"activation\": {\n \"type\": \"next_cycle\"\n },\n \"plan_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_configuration\": {},\n \"unit_count_configuration\": {},\n \"upgrade_strategy\": \"new_plan\",\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\"\n },\n \"downgrade_allowed\": true\n}"
response = http.request(request)
puts response.read_body{
"is_downgrade": true,
"price_on_new_contract": [
{
"invoice": {
"currency": "usd",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"date": "2023-11-07T05:31:56Z",
"deposit_transaction_status": "not_processed",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"invoice_number": {
"number": "<string>"
},
"status": "pending_validation",
"total": "<string>",
"deposit_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"external_reference": "<string>"
},
"invoice_items": [
{
"charge_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"currency": "usd",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"scheduling_policy": "immediate",
"status": "pending_validation",
"subtotal": "<string>",
"total_excluding_tax": "<string>",
"total_including_tax": "<string>",
"unit_count": "<string>",
"unit_price": "<string>",
"description": "<string>",
"discount_amount": "<string>",
"discount_description": "<string>",
"invoice_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"tax_amount": "<string>",
"tax_code": "<string>",
"tax_policy": "tax_included",
"withdrawal_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
}
]
}
],
"pro_rate_new_contract": "<string>",
"pro_rate_old_contract": "<string>",
"remains_to_pay_current_contract": [
{
"invoice": {
"currency": "usd",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"date": "2023-11-07T05:31:56Z",
"deposit_transaction_status": "not_processed",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"invoice_number": {
"number": "<string>"
},
"status": "pending_validation",
"total": "<string>",
"deposit_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"external_reference": "<string>"
},
"invoice_items": [
{
"charge_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"currency": "usd",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"scheduling_policy": "immediate",
"status": "pending_validation",
"subtotal": "<string>",
"total_excluding_tax": "<string>",
"total_including_tax": "<string>",
"unit_count": "<string>",
"unit_price": "<string>",
"description": "<string>",
"discount_amount": "<string>",
"discount_description": "<string>",
"invoice_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"tax_amount": "<string>",
"tax_code": "<string>",
"tax_policy": "tax_included",
"withdrawal_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
}
]
}
],
"upgrade_cost_breakdown": {
"new_contract": {
"cost_pro_rated": "<string>",
"cycle": "once",
"full_cost": "<string>",
"pro_rate": "<string>",
"time_on_contract": {
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"time_used": {
"unit": "hour",
"unit_count": 123
}
},
"usage": "<string>"
},
"new_contract_cost_pro_rated": "<string>",
"old_contract": {
"cost_pro_rated": "<string>",
"cycle": "once",
"full_cost": "<string>",
"pro_rate": "<string>",
"time_on_contract": {
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"time_used": {
"unit": "hour",
"unit_count": 123
}
},
"usage": "<string>"
},
"pro_rate_new_contract": "<string>",
"pro_rate_old_contract": "<string>",
"total": "<string>",
"usage_old_contract": "<string>",
"time_on_new_contract": {
"unit": "hour",
"value": 123
},
"time_on_old_contract": {
"unit": "hour",
"value": 123
}
},
"usage_old_contract": "<string>",
"new_contract_period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
}
}Contract
Estimate Upgrade Costss
Estimate plan upgrade costs.
POST
/
v1
/
c
/
contract
/
{contract_id}
/
upgrade_estimate
cURL
curl --request POST \
--url http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate \
--header 'Content-Type: application/json' \
--header 'wb-key: <api-key>' \
--data '
{
"upgrade_configuration": {
"activation": {
"type": "next_cycle"
},
"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
}
'import requests
url = "http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate"
payload = {
"upgrade_configuration": {
"activation": { "type": "next_cycle" },
"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
}
headers = {
"wb-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'wb-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
upgrade_configuration: {
activation: {type: 'next_cycle'},
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
})
};
fetch('http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'upgrade_configuration' => [
'activation' => [
'type' => 'next_cycle'
],
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"wb-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate"
payload := strings.NewReader("{\n \"upgrade_configuration\": {\n \"activation\": {\n \"type\": \"next_cycle\"\n },\n \"plan_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_configuration\": {},\n \"unit_count_configuration\": {},\n \"upgrade_strategy\": \"new_plan\",\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\"\n },\n \"downgrade_allowed\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("wb-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate")
.header("wb-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"upgrade_configuration\": {\n \"activation\": {\n \"type\": \"next_cycle\"\n },\n \"plan_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_configuration\": {},\n \"unit_count_configuration\": {},\n \"upgrade_strategy\": \"new_plan\",\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\"\n },\n \"downgrade_allowed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/c/contract/{contract_id}/upgrade_estimate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["wb-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"upgrade_configuration\": {\n \"activation\": {\n \"type\": \"next_cycle\"\n },\n \"plan_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"unit_configuration\": {},\n \"unit_count_configuration\": {},\n \"upgrade_strategy\": \"new_plan\",\n \"discount_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\",\n \"pricing_id\": \"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670\"\n },\n \"downgrade_allowed\": true\n}"
response = http.request(request)
puts response.read_body{
"is_downgrade": true,
"price_on_new_contract": [
{
"invoice": {
"currency": "usd",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"date": "2023-11-07T05:31:56Z",
"deposit_transaction_status": "not_processed",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"invoice_number": {
"number": "<string>"
},
"status": "pending_validation",
"total": "<string>",
"deposit_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"external_reference": "<string>"
},
"invoice_items": [
{
"charge_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"currency": "usd",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"scheduling_policy": "immediate",
"status": "pending_validation",
"subtotal": "<string>",
"total_excluding_tax": "<string>",
"total_including_tax": "<string>",
"unit_count": "<string>",
"unit_price": "<string>",
"description": "<string>",
"discount_amount": "<string>",
"discount_description": "<string>",
"invoice_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"tax_amount": "<string>",
"tax_code": "<string>",
"tax_policy": "tax_included",
"withdrawal_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
}
]
}
],
"pro_rate_new_contract": "<string>",
"pro_rate_old_contract": "<string>",
"remains_to_pay_current_contract": [
{
"invoice": {
"currency": "usd",
"customer_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"date": "2023-11-07T05:31:56Z",
"deposit_transaction_status": "not_processed",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"invoice_number": {
"number": "<string>"
},
"status": "pending_validation",
"total": "<string>",
"deposit_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"external_reference": "<string>"
},
"invoice_items": [
{
"charge_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"currency": "usd",
"due_date": "2023-11-07T05:31:56Z",
"id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"name": "<string>",
"scheduling_policy": "immediate",
"status": "pending_validation",
"subtotal": "<string>",
"total_excluding_tax": "<string>",
"total_including_tax": "<string>",
"unit_count": "<string>",
"unit_price": "<string>",
"description": "<string>",
"discount_amount": "<string>",
"discount_description": "<string>",
"invoice_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670",
"tax_amount": "<string>",
"tax_code": "<string>",
"tax_policy": "tax_included",
"withdrawal_transaction_id": "Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
}
]
}
],
"upgrade_cost_breakdown": {
"new_contract": {
"cost_pro_rated": "<string>",
"cycle": "once",
"full_cost": "<string>",
"pro_rate": "<string>",
"time_on_contract": {
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"time_used": {
"unit": "hour",
"unit_count": 123
}
},
"usage": "<string>"
},
"new_contract_cost_pro_rated": "<string>",
"old_contract": {
"cost_pro_rated": "<string>",
"cycle": "once",
"full_cost": "<string>",
"pro_rate": "<string>",
"time_on_contract": {
"period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
},
"time_used": {
"unit": "hour",
"unit_count": 123
}
},
"usage": "<string>"
},
"pro_rate_new_contract": "<string>",
"pro_rate_old_contract": "<string>",
"total": "<string>",
"usage_old_contract": "<string>",
"time_on_new_contract": {
"unit": "hour",
"value": 123
},
"time_on_old_contract": {
"unit": "hour",
"value": 123
}
},
"usage_old_contract": "<string>",
"new_contract_period": {
"end": "2023-11-07T05:31:56Z",
"start": "2023-11-07T05:31:56Z"
}
}Authorizations
api-keywb_user_cookie
Path Parameters
Id of the Contract
Body
application/json
Upgrade configuration used when WbCustomer is performing a Contract Upgrade for a Customer
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
Show child attributes
Show child attributes
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
Estimate of the price of the Contract Upgrade When contract upgrade is performed mid-cycle, but the billing period is kept the same, the unused part of the current contract billing period, as well as the unused part of the new contract's billing period will be accordingly pro-rated For example, if the contract is paid on the 1st of every month and the upgrade is performed on 16th, we pro-rate as follows:
- days 1
15 of the old contract are considered "used", remainder is "unused" thus, days 16end-of-month will be pro-rated - for the new contract, days 1~15 will be unused and pro-rated
If contract change is downgrade (a move to a cheaper contract), then this will be set to True. Downgrade can not be performed mid-cycle, only at the end of the billing cycle
Estimated invoices of the first billing period for the new Contract
Show child attributes
Show child attributes
Pro rated amount on the new contract. Deprecated, please use UpgradeCostBreakdown.
Pro rated amount for the current contract. Deprecated, please use UpgradeCostBreakdown.
Invoices for the current Contract
Show child attributes
Show child attributes
Additional information about upgrade costs
Show child attributes
Show child attributes
If old contract has usage-priced features, this indicates how much will be paid for usage on upgrade. Deprecated, please use UpgradeCostBreakdown.
Billing period of the contract. For example, for contracts that are paid monthly, a new billing period would be created each month. For Constant or Once contracts, a single period would be created with empty "end" value
Show child attributes
Show child attributes