|
header.currency
|
Currency code used in the pricing response. Similar to the one sent in the request.Data type: String
Example: `USD`
|
|
header.costbook
|
Identifier of the costbook used for pricing.Data type: String \(Sys\_id\)
|
|
header.lineItems
|
Contains pricing details for each line item.Data type: Array<Object>
```
{
"lineItems": [
{
"line_id": "String",
"status": "String",
"currency": "String",
"base_price": {
"value": "String",
"displayValue": "String"
},
"list_price": {
"value": "String",
"displayValue": "String"
},
"pricelist": "String",
"quantity": "",
"price_list_line": "String",
"product_offering": "String",
"one_time_price": {
"value": "String",
"displayValue": "String"
},
"monthly_recurring_price": {
"value": "String",
"displayValue": "String"
},
"annual_recurring_price": {
"value": "String",
"displayValue": "String"
},
"unit_net_price": {
"value": "String",
"displayValue": "String"
},
"cumulative_net_price": {
"value": "String",
"displayValue": "String"
},
"cumulative_one_time_price": {
"value": "String",
"displayValue": "String"
},
"cumulative_monthly_recurring_price": {
"value": "String",
"displayValue": "String"
},
"cumulative_annual_recurring_price": {
"value": "String",
"displayValue": "String"
},
"unit_adjustment": {
"value": "String",
"displayValue": "String"
},
"term_month": {
"value": Integer,
"displayValue": Integer
},
"cumulative_annual_recurring_price_v1": {
"value": Integer,
"displayValue": Integer
},
"cumulative_monthly_recurring_price_v1": {
"value": 0,
"displayValue": 0
},
"total_recurring_price": {
"value": "String",
"displayValue": "String"
},
"pricingAdjustments": [],
"total_adjustment_amount": []
}
]
}
```
|
|
header.lineItems\[\].line\_id
|
Identifier of the line item.Data type: String
Example: `CONNECTEDC1100`
|
|
header.lineItems\[\].status
|
Status of the pricing calculation for the line item.Valid options:
- Success
- Failure
Data type: String
Example: `Success`
|
|
header.lineItems\[\].base\_price
|
Base price before adjustments.Data type: Object
```
{
"base_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].list\_price
|
List price which is base price and attribute adjustments included.Data type: Object
```
{
"list_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].pricelist
|
Price list reference.Data type: String \(Sys\_id\)
|
|
header.lineItems\[\].quantity
|
Quantity sent as part of request.Data type: String
Example: `1`
|
|
header.lineItems\[\].price\_list\_line
|
Price list line reference.Data type: String \(Sys\_id\)
Example: `3e93e785d07a7910f8770dbf976be1ee`
|
|
header.lineItems\[\].product\_offering
|
Product offering reference.Data type: String \(Sys\_id\)
Example: `db61dd9fd0a63110f8770dbf976be19c`
|
|
header.lineItems\[\].one\_time\_price
|
One-time price for the product, unit net price \* quantity.Data type: Object
```
{
"one_time_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].monthly\_recurring\_price
|
Monthly recurring price for the product inclusive of all quantities.Data type: Object
```
{
"monthly_recurring_price": {
"value": Integer,
"displayValue": Integer
}
}
```
|
|
header.lineItems\[\].annual\_recurring\_price
|
Annual recurring price for the product inclusive of all quantities.Data type: Object
```
{
"annual_recurring_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].unit\_net\_price
|
Net price per unit after auto adjustments.Data type: Object
```
{
"unit_net_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].cumulative\_net\_price
|
\[One time price + \(Monthly Recurring price \* Term\)\] + \(if parent line\) sum of all CNP for immediate and grand child linesData type: Object
```
{
"cumulative_net_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].cumulative\_one\_time\_price
|
For Child- One time price for the line item. For Parent line item - One time price for the line item + One time price for all child and grand child line items.Data type: Object
```
{
"cumulative_one_time_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].cumulative\_monthly\_recurring\_price
|
If price method = recurring. Monthly Recurring price for the line + \(if parent line\) sum of all monthly recurring price of child lines.Data type: Object
```
{
"cumulative_monthly_recurring_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].cumulative\_annual\_recurring\_price
|
If price method = recurring. Cumulative Monthly Recurring Price \* 12.Data type: Object
```
{
"cumulative_annual_recurring_price": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].unit\_adjustment
|
Price adjustment applied per unit.Data type: Object
```
{
"unit_adjustment": {
"value": "String",
"displayValue": "String"
}
}
```
|
|
header.lineItems\[\].term\_month
|
Term duration in months.Data type: Object
```
{
"term_month": {
"value": Integer,
"displayValue": Integer
}
}
```
|
|
header.lineItems\[\].cost
|
Unit cost of the product.Data type: Object
```
{
"cost": {
"value": Integer,
"displayValue": Integer
}
}
```
|
|
header.lineItems\[\].unit\_margin\_amount
|
Profit margin amount per unit.Data type: Object
```
{
"cost": {
"value": Integer,
"displayValue": Integer
}
}
```
|
|
header.lineItems\[\].unit\_margin\_percentage
|
Profit margin percentage per unit.Data type: Object
|
|
header.lineItems\[\].one\_time\_cost
|
One-time cost for the product inclusive of all quantities.Data type: Object
|
|
header.lineItems\[\].monthly\_recurring\_cost
|
Monthly recurring cost for the product inclusive of all quantities.Data type: Object
|
|
header.lineItems\[\].cumulative\_one\_time\_cost
|
For Child- One time cost for the line item. For Parent line item - One time cost for the line item + One time cost for all child and grand child line items.Data type: Object
|
|
header.lineItems\[\].cumulative\_monthly\_recurring\_cost
|
If price method = recurring. Monthly Recurring cost for the line + \(if parent line\) sum of all monthly recurring cost of child lines.Data type: Object
|
|
header.lineItems\[\].cumulative\_net\_cost
|
\[One time cost + \(Monthly Recurring cost \* Term\)\] + \(if parent line\) sum of all CNC for immediate and grand child linesData type: Object
|
|
header.lineItems\[\].cumulative\_margin\_percentage
|
Overall margin percentage.Data type: Object
|
|
header.status
|
Status of the overall pricing request.Valid options are:
- Success
- Failure
- Partial Failure
Data type: String
Example: `Success`
|
|
header.total\_monthly\_recurring\_price
|
Aggregated monthly recurring price.Data type: Object
|
|
header.total\_annual\_recurring\_price
|
Aggregated annual recurring price.Data type: Object
|
|
header.total\_amount
|
Total transaction amount.Data type: Object
|
|
header.total\_one\_time\_price
|
Aggregated one-time price.Data type: Object
|
|
header.total\_one\_time\_cost
|
Aggregated one-time cost.Data type: Object
|
|
header.total\_monthly\_cost
|
Aggregated monthly cost.Data type: Object
|
|
header.total\_cost
|
Total cost \(one-time + recurring\).Data type: Object
|
|
header.total\_one\_time\_margin
|
Total margin from one-time charges.Data type: Object
|
|
header.total\_monthly\_margin
|
Total margin from monthly charges.Data type: Object
|
|
header.total\_margin\_amount
|
Total profit margin amount.Data type: Object
|
|
header.total\_one\_time\_margin\_percentage
|
Margin percentage for one-time charges.Data type: Object
|
|
header.total\_monthly\_margin\_percentage
|
Margin percentage for monthly charges.Data type: Object
|
|
header.total\_margin\_percentage
|
Overall margin percentage.Data type: Object
|
|
settings.pricing\_elements
|
Elements included in the pricing response \(PRICE, COST, NET\_PRICE, etc.\).Data type: String
|
|
settings.pricing\_context\_id
|
Identifier for pricing session when scope is configurator.Data type: String
|