Calculate pricing for Ports and Layer 2 Connections
OK
No price was found for this combination.
error
{- "ports": [
- {
- "dcf": "5a8ba9118195000012e9f141",
- "speed": 1000,
- "durationUnit": "y"
}
]
}
{- "results": [
- {
- "type": "PORT",
- "entity": {
- "dcf": {
- "id": "5a8ba9118195000012e9f141",
- "name": "Company A",
- "popId": null,
- "regionIds": null,
- "metroIds": null,
- "tags": null
}, - "speed": 1000,
- "discountId": "",
- "durationUnit": "y"
}, - "price": 300,
- "preAuthAmount": 300,
- "amountSaved": null,
- "amountSavedTotal": null,
- "basicTotalAmount": null,
- "basicMonthlyAmount": null,
- "priceCalculatorAttributes": {
- "discountIds": [ ],
- "discounts": [ ]
}
}
]
}
Retrieve flex pricing for a connection.
OK
No price was found for this combination.
error
{- "connectionId": "95908593icTTl895393135Y7K",
- "flexBandwidth": "100"
}
{- "connectionId": "95908593icTTl895393135Y7K",
- "flexBandwidth": 100,
- "flexCharge": 97
}
Get Internet On-Demand pricing by company and port.
OK
Validation errors
entity not found
{- "contractTotals": {
- "giaCost": 3420,
- "ipCosts": {
- "ipv426Cost": 1596,
- "ipv427Cost": 1140,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "unitCosts": {
- "giaCost": 142.5,
- "ipCosts": {
- "ipv426Cost": 66.5,
- "ipv427Cost": 47.5,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "contractTotalsAmountSaved": null,
- "unitCostsAmountSaved": null,
- "burstRate": 0.04681165489,
- "duration": {
- "unit": "m",
- "value": 24
}
}
Get Internet On-Demand price for a specific DCF
Note: An error will be returned if there was no pricing found for a service with the desired bandwidth. Please contact your BDM or Support if this happens.
OK
Validation errors
entity not found
{- "contractTotals": {
- "giaCost": 3420,
- "ipCosts": {
- "ipv426Cost": 1596,
- "ipv427Cost": 1140,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "unitCosts": {
- "giaCost": 142.5,
- "ipCosts": {
- "ipv426Cost": 66.5,
- "ipv427Cost": 47.5,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "contractTotalsAmountSaved": null,
- "unitCostsAmountSaved": null,
- "burstRate": 0.04681165489,
- "duration": {
- "unit": "m",
- "value": 24
}
}
Get Internet On-Demand prices for multiple DCFs in a single call.
OK
entity not found
[- {
- "contractTotals": {
- "giaCost": 3420,
- "ipCosts": {
- "ipv426Cost": 1596,
- "ipv427Cost": 1140,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "unitCosts": {
- "giaCost": 142.5,
- "ipCosts": {
- "ipv426Cost": 66.5,
- "ipv427Cost": 47.5,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "contractTotalsAmountSaved": null,
- "unitCostsAmountSaved": null,
- "burstRate": 0.04681165489,
- "duration": {
- "unit": "m",
- "value": 24
}
}, - {
- "onceOff": {
- "giaCost": 73.97,
- "ipCosts": {
- "ipv426Cost": 34.52,
- "ipv427Cost": 24.66,
- "ipv428Cost": 0,
- "ipv429Cost": null,
- "ipv430Cost": null
}
}, - "burstRate": 0.004050035038912062,
- "duration": {
- "unit": "d",
- "value": 6
}
}
]
Retrieve flex pricing for Internet On-Demand services.
OK
Entity not found
Unprocessable Entity
No Pricing is available for the service's metro.
An error will be returned if there was no pricing found for a flex to the desired bandwidth in this service's metro. If this happens, please contact your BDM or Support.
{- "flexCharge": 42.4,
- "amountSaved": 0
}
CloudRouter Base Charge
companyId required | string The ID of the company. You can check your companyId in your account on Console Connect website or you can query in Auth API |
bandwidth required | string The desired bandwidth for the CloudRouter |
required | object (Duration) |
required | CloudRouterPriceCalcSiteStandard (object) or CloudRouterPriceCalcSiteSIMPool (object) |
discountCode | string |
OK
validations
unauthorized
entity not found
{- "companyId": "66eb1831e49462a7c87e097e",
- "bandwidth": "500MB",
- "duration": {
- "unit": "m",
- "value": 6
}, - "sites": [
- {
- "priceRefId": "1",
- "dcfId": "66eb183694742642e25edb64",
- "rateLimit": {
- "unit": "mbps",
- "value": 100
}, - "classOfService": [
- {
- "name": "BRONZE",
- "value": 100
}
], - "discountId": ""
}
], - "discountCode": ""
}
{- "totalContractCost": 1200,
- "baseL3vpnCost": 200,
- "duration": {
- "from": null,
- "to": null,
- "unit": "m",
- "value": 6
}, - "sites": [
- {
- "site": {
- "portId": "66eb1a9d2778c42f179cdd7d",
- "dcfId": "66eb183694742642e25edb64",
- "discountId": "",
- "rateLimit": {
- "unit": "MBPS",
- "value": 100
}, - "providerInfo": {
- "dcfName": "sampleDcfName",
- "dcfId": "66eb183694742642e25edb64",
- "metroId": "66eb19f1007415be57b333d1",
- "city": "Tokyo",
- "country": "JP",
- "countryDisplayName": "Japan"
}
}, - "priceRefId": "1",
- "prices": {
- "BRONZE": {
- "hourlyCost": 0,
- "hourlyCostAmountSaved": null,
- "dailyCost": 0,
- "monthlyCost": 0
}, - "SILVER": {
- "hourlyCost": 0,
- "hourlyCostAmountSaved": null,
- "dailyCost": 0,
- "monthlyCost": 0
}, - "GOLD": {
- "hourlyCost": 0,
- "hourlyCostAmountSaved": null,
- "dailyCost": 0,
- "monthlyCost": 0
}
}
}
], - "baseL3vpnCostAmountSaved": null,
- "totalContractCostAmountSaved": null,
- "totalHourlySiteCostAmountSaved": 0,
- "bandwidth": "500MB"
}
Find pricing for adding a site to a CloudRouter.
OK
validations
entity not found
{- "site": {
- "simPool": false,
- "portId": "66f2a3055027af9152a0a8c3",
- "rateLimit": {
- "unit": "mbps",
- "value": 100
}, - "classOfService": [
- {
- "name": "BRONZE",
- "value": 100
}
]
}
}
{- "l3vpnId": "66f2a3dbb2ee7c6a60420863",
- "baseL3vpnCost": 500,
- "totalContractCost": 500,
- "totalHourlySiteCost": 20,
- "totalMonthlySiteCost": 14600,
- "sites": [
- {
- "site": {
- "id": "3e67a984-9eb2-4837-842d-6ae405400cf7",
- "companyId": "66f2a394a7a51d430f33bdcb",
- "l3vpnId": "66f2a3dbb2ee7c6a60420863",
- "name": "Sample l3vpn site",
- "type": "COMPANY",
- "portId": "66f2a3c87ee81a5fef8daea9",
- "slVlanId": null,
- "rateLimit": {
- "rate": 10,
- "unit": "Mbps",
- "value": 10
}, - "mtu": null,
- "classOfService": [
- {
- "name": "BRONZE",
- "value": 100
}
], - "redundancySiteType": "primary",
- "redundancyLinkedSiteId": null,
- "status": "ACTIVE",
- "simPoolId": null,
- "company_id": "66f2a394a7a51d430f33bdcb",
- "l3vpn_id": "66f2a3dbb2ee7c6a60420863",
- "sim_pool_id": null,
- "deleted_at": null,
- "created_at": "2024-09-23T06:20:49.897Z",
- "updated_at": "2024-09-23T06:20:49.897Z",
- "port_id": "66f2a3c87ee81a5fef8daea9",
- "discountId": null,
- "priceRefId": "3e67a984-9eb2-4837-842d-6ae405400cf7",
- "providerInfo": {
- "portName": "samplePort",
- "portId": "66f2a3c87ee81a5fef8daea9",
- "portPartner": {
- "type": "NONE",
- "regionName": null,
- "regionNames": null,
- "zone": null,
- "connectionSpeeds": [ ],
- "vlanId": null,
- "partnerPort": null
}, - "companyId": "66f2a394a7a51d430f33bdcb",
- "dcfName": "sampleDcf",
- "dcfId": "66f2a3fe751203ee1020e6f0",
- "metroId": "66f2a40a627b4d86b4883b11",
- "city": "Brisbane",
- "country": "AUS"
}
}, - "hourlyCost": 10,
- "dailyCost": 240,
- "monthlyCost": 7200
}, - {
- "site": {
- "portId": "66f2a428f0d298684fbddf2e",
- "rateLimit": {
- "unit": "mbps",
- "value": 100
}, - "classOfService": [
- {
- "name": "BRONZE",
- "value": 100
}
], - "providerInfo": {
- "portName": "samplePort2",
- "portId": "66f2a428f0d298684fbddf2e",
- "portPartner": {
- "type": "NONE",
- "regionName": null,
- "regionNames": null,
- "zone": null,
- "connectionSpeeds": [ ],
- "vlanId": null,
- "partnerPort": null
}, - "companyId": "66f2a394a7a51d430f33bdcb",
- "dcfName": "sampleDcf",
- "dcfId": "66f2a450116bb784aa0aa749",
- "metroId": "66f2a458e5444065df184b97",
- "city": "Brisbane",
- "country": "AUS"
}
}, - "hourlyCost": 10,
- "dailyCost": 240,
- "monthlyCost": 7200
}
], - "discount": null
}
Find pricing for deleting a CloudRouter site.
OK
validations
entity not found
{- "siteId": "6fcac435-ce01-4fef-b316-bcf80537970f"
}
{- "l3vpnId": "6328f276bb71e4e4ae01e9e9",
- "baseL3vpnCost": 500,
- "totalContractCost": 500,
- "totalHourlySiteCost": 20,
- "totalMonthlySiteCost": 14600,
- "sites": [
- {
- "site": {
- "id": "8def56cf-fe19-4b25-b6b6-f61cee449c21",
- "companyId": "5ea242323962644b52fc4348",
- "l3vpnId": "6328f276bb71e4e4ae01e9e9",
- "name": "Donut l3vpn site",
- "type": "COMPANY",
- "portId": "6328f276bb71e4e4ae01e9e1",
- "slVlanId": null,
- "rateLimit": {
- "rate": 10,
- "unit": "Mbps",
- "value": 10
}, - "mtu": null,
- "classOfService": [
- {
- "name": "BRONZE",
- "value": 100
}
], - "redundancySiteType": "primary",
- "redundancyLinkedSiteId": null,
- "status": "ACTIVE",
- "simPoolId": null,
- "company_id": "5ea242323962644b52fc4348",
- "l3vpn_id": "6328f276bb71e4e4ae01e9e9",
- "deleted_at": null,
- "created_at": "2022-09-19T22:51:34.972Z",
- "updated_at": "2022-09-19T22:51:34.972Z",
- "discountId": null,
- "priceRefId": "8def56cf-fe19-4b25-b6b6-f61cee449c21",
- "providerInfo": {
- "portName": "donutBrisbanePort",
- "portId": "6328f276bb71e4e4ae01e9e1",
- "portPartner": {
- "type": "NONE",
- "regionName": null,
- "regionNames": null,
- "zone": null,
- "connectionSpeeds": [
- {
- "vlanId": null,
- "partnerPort": null
}
]
}, - "companyId": "5ea242323962644b52fc4348",
- "dcfName": "brisbaneDcf",
- "dcfId": "6328f276bb71e4e4ae01e9d8",
- "metroId": "6328f276bb71e4e4ae01e9d0",
- "city": "Brisbane",
- "country": "AUS"
}
}, - "hourlyCost": 10,
- "dailyCost": 240,
- "monthlyCost": 7200
}, - {
- "site": {
- "portId": "6328f276bb71e4e4ae01e9e1",
- "rateLimit": {
- "unit": "mbps",
- "value": 100
}, - "classOfService": [
- {
- "name": "BRONZE",
- "value": 100
}
], - "providerInfo": {
- "portName": "donutBrisbanePort",
- "portId": "6328f276bb71e4e4ae01e9e1",
- "portPartner": {
- "type": "NONE",
- "regionName": null,
- "regionNames": null,
- "zone": null,
- "connectionSpeeds": null,
- "vlanId": null,
- "partnerPort": null
}, - "companyId": "5ea242323962644b52fc4348",
- "dcfName": "brisbaneDcf",
- "dcfId": "6328f276bb71e4e4ae01e9d8",
- "metroId": "6328f276bb71e4e4ae01e9d0",
- "city": "Brisbane",
- "country": "AUS"
}
}, - "hourlyCost": 10,
- "dailyCost": 240,
- "monthlyCost": 7200
}
], - "discount": null
}
Returns the MRC (Monthly Recurring Charge) and NRC (Non-Recurring Charge or One-off Charge) for a potential new order.
The costs were successfully calculated.
The request was invalid because of missing and/or invalid fields.
There was an internal server error.
{- "mrc": 109,
- "nrc": 450.5
}
Generate a PDF with pricing information.
The PDF file that is generated.
{- "portsArray": [
- {
- "status": "CALCULATED",
- "location": "Sydney, Australia",
- "dcfId": "5efbdd1ef4fa0300142101ec",
- "speed": 1,
- "price": 300,
- "resetState": {
- "status": "CALCULATED",
- "location": "Sydney, Australia",
- "dcfId": "5efbdd1ef4fa0300142101ec",
- "speed": 1,
- "price": 300
}
}
], - "connectionsArray": [
- {
- "status": "CALCULATED",
- "bandwidth": 50,
- "duration": {
- "value": 3,
- "unit": "d"
}, - "srcLocation": "Osaka, Japan",
- "category": "datacenter",
- "destLocation": "Tokyo, Japan",
- "classOfService": "SILVER",
- "srcCode": "JAP",
- "destCode": "JAP",
- "price": 11,
- "priceOptions": [
- {
- "price": 11,
- "duration": {
- "from": null,
- "to": null,
- "unit": "d",
- "value": 1
}
}
], - "resetState": {
- "status": "CALCULATED",
- "bandwidth": 50,
- "duration": {
- "value": 3,
- "unit": "d"
}, - "srcLocation": "Osaka, Japan",
- "category": "datacenter",
- "destLocation": "Tokyo, Japan",
- "classOfService": "SILVER",
- "srcCode": "JAP",
- "destCode": "JAP",
- "price": 11,
- "priceOptions": [
- {
- "price": 11,
- "duration": {
- "from": null,
- "to": null,
- "unit": "d",
- "value": 1
}
}
]
}
}
], - "iodArray": [
- {
- "status": "CALCULATED",
- "bandwidth": 10,
- "duration": {
- "value": 12,
- "unit": "m"
}, - "location": "Taipei, Taiwan",
- "price": 100,
- "priceOptions": [
- {
- "price": 7.23,
- "duration": {
- "from": null,
- "to": null,
- "unit": "d",
- "value": 1
}, - "code": "TAI"
}
], - "resetState": {
- "status": "CALCULATED",
- "bandwidth": 10,
- "duration": {
- "value": 12,
- "unit": "m"
}, - "location": "Taipei Taiwan",
- "price": 100,
- "priceOptions": [
- {
- "price": 7.23,
- "duration": {
- "from": null,
- "to": null,
- "unit": "d",
- "value": 1
}, - "code": "TAI"
}
]
}
}
], - "cloudRouterArray": [
- {
- "status": "CALCULATED",
- "duration": {
- "value": 2,
- "unit": "m"
}, - "bandwidth": {
- "value": 500,
- "label": "500MB"
}, - "sites": [
- {
- "category": "datacenter",
- "location": "Buenos Aires Argentina",
- "companyId": "undefined",
- "rateLimit": {
- "value": 100,
- "unit": "mbps"
}, - "priceRefId": 0
}
], - "pricedSites": [
- {
- "selectedClassOfService": "BRONZE",
- "priceRefId": 0,
- "prices": {
- "BRONZE": {
- "hourlyCost": 0.2397,
- "hourlyCostAmountSaved": null,
- "dailyCost": 5.7528,
- "monthlyCost": 174.981
}, - "SILVER": {
- "hourlyCost": 0.2397,
- "hourlyCostAmountSaved": null,
- "dailyCost": 5.7528,
- "monthlyCost": 174.981
}, - "GOLD": {
- "hourlyCost": 0.2397,
- "hourlyCostAmountSaved": null,
- "dailyCost": 5.7528,
- "monthlyCost": 174.981
}
}, - "site": {
- "portId": null,
- "dcfId": "62426d15ff842c00151d9f02",
- "discountId": null,
- "rateLimit": {
- "unit": "MBPS",
- "rate": 100
}, - "providerInfo": {
- "dcfName": "TEST_CR TICTAC DCF",
- "dcfId": "62426d15ff842c00151d9f02",
- "metroId": "77d9f1fbbcaa906f3cddb6d1",
- "city": "Buenos Aires",
- "country": "AR",
- "countryDisplayName": "Argentina"
}, - "type": "COMPANY",
- "displayName": "Data Center"
}
}
], - "baseL3vpnCost": 100,
- "price": 449.98,
- "resetState": {
- "status": "CALCULATED",
- "duration": {
- "value": 2,
- "unit": "m"
}, - "bandwidth": {
- "value": 500,
- "label": "500MB"
}, - "sites": [
- {
- "category": "datacenter",
- "location": "Buenos Aires Argentina",
- "companyId": "undefined",
- "rateLimit": {
- "value": 100,
- "unit": "mbps"
}, - "priceRefId": 0
}
], - "pricedSites": [
- {
- "selectedClassOfService": "BRONZE",
- "priceRefId": 0,
- "prices": {
- "BRONZE": {
- "hourlyCost": 0.2397,
- "hourlyCostAmountSaved": null,
- "dailyCost": 5.7528,
- "monthlyCost": 174.981
}, - "SILVER": {
- "hourlyCost": 0.2397,
- "hourlyCostAmountSaved": null,
- "dailyCost": 5.7528,
- "monthlyCost": 174.981
}, - "GOLD": {
- "hourlyCost": 0.2397,
- "hourlyCostAmountSaved": null,
- "dailyCost": 5.7528,
- "monthlyCost": 174.981
}
}, - "site": {
- "portId": null,
- "dcfId": "62426d15ff842c00151d9f02",
- "discountId": null,
- "rateLimit": {
- "unit": "MBPS",
- "rate": 100
}, - "providerInfo": {
- "dcfName": "TEST_CR TICTAC DCF",
- "dcfId": "62426d15ff842c00151d9f02",
- "metroId": "77d9f1fbbcaa906f3cddb6d1",
- "city": "Buenos Aires",
- "country": "AR",
- "countryDisplayName": "Argentina"
}, - "type": "COMPANY"
}, - "displayName": "Data Center"
}
], - "baseL3vpnCost": 100,
- "price": 449.98
}
}
]
}