Pricing

Look up pricing

Ports and Connections.

Request
header Parameters
portal-token
required
string

Authentication token.

Request Body schema: application/json
Array of objects
Array of objects
discountCode
string
Responses
200

OK

204

No price was found for this combination.

400

error

post/api/pricing/calculate
Request samples
application/json
{
  • "ports": [
    ],
  • "connections": [ ]
}
Response samples
application/json
{
  • "results": [
    ]
}

Connections - flex pricing

Request
path Parameters
username
required
string

The username of the company.

Example: company_co
header Parameters
portal-token
required
string

Authentication token.

Request Body schema: application/json
connectionId
required
string

The connection ID of the connection you want to get flex pricing for.

flexBandwidth
required
string

The additional bandwidth to be added to the connection.

discountCode
string

Any discount code you may have been provided.

Responses
200

OK

204

No price was found for this combination.

400

error

post/api/company/{username}/pricing/calculate/flex
Request samples
application/json
{
  • "connectionId": "95908593icTTl895393135Y7K",
  • "flexBandwidth": "100"
}
Response samples
application/json
{
  • "connectionId": "95908593icTTl895393135Y7K",
  • "flexBandwidth": 100,
  • "flexCharge": 97
}

Internet on Demand - Company and Port

Get Internet on Demand Pricing by Company and Port

Request
query Parameters
companyId
required
string

The ID of the Company.

Example: companyId=507f1f77bcf86cd799439011
portId
required
string

The ID of the Port.

Example: portId=507f191e810c19729de860ea
bandwidth
required
string

The desired bandwidth for the GIA service.

Example: bandwidth=10
durationValue
required
string

The ID of the company.

Example: durationValue=12
durationUnit
required
string

A unit of time such as days, months, and years. Value can be one of: d, w, m, y.

Example: durationUnit=m
discountCode
string

Optional discount code.

header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

400

Validation errors

404

entity not found

get/api/v2/pricing/gia/byCompanyAndPort
Response samples
application/json
{
  • "duration": {
    },
  • "contractTotals": {
    },
  • "unitCosts": {
    }
}

Internet on Demand - DCF

An error will be returned if there was no pricing found for a GIA Service with the desired bandwidth. Please contact your BDM or Support if this happens.

Request
query Parameters
dcfId
required
string

The ID of the Data Center Facility.

Example: dcfId=507f191e810c19729de860ea
bandwidth
required
string

The desired bandwidth for the GIA Service.

Example: bandwidth=10
durationValue
required
string

The ID of the company.

Example: durationValue=12
durationUnit
required
string

A unit of time such as days, months, and years. Value can be one of: d, w, m, y.

Example: durationUnit=m
discountCode
string

Optional discount code.

companyId
string

The ID of the Company.

Example: companyId=507f1f77bcf86cd799439011
header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

400

Validation errors

404

entity not found

get/api/v2/pricing/gia/byDcf
Response samples
application/json
{
  • "duration": {
    },
  • "contractTotals": {
    },
  • "unitCosts": {
    }
}

Internet on Demand - DCF (bulk)

Get IoD prices for multiple DCFs in a single call.

Request
query Parameters
dcfId
required
string

The ID of the Data Center Facility.

Example: dcfId=507f191e810c19729de860ea
required
Array of objects

An array of objects with the price request details as a JSON serialised string.

Example: priceRequests=[{"bandwidth":10,"durationValue":2,"durationUnit":"y"},{"bandwidth":10,"durationValue":1,"durationUnit":"y"}]
header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

404

entity not found

get/api/v2/pricing/gia/bulkByDcf
Response samples
application/json
[
  • {
    },
  • {
    }
]

Internet on Demand - flex

Request
path Parameters
giaServiceId
required
string

The ID of the IoD service to flex.

Example: ae913a22-d9ae-4022-9016-edb58575e39b
query Parameters
bandwidth
required
string

The desired bandwidth to flex the service to.

Example: bandwidth=10
discountCode
required
string

Optional discount code.

Example: discountCode=20PERCENT
header Parameters
portal-token
required
string

Authentication token.

Responses
200

OK

404

Entity not found

422

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.

get/api/v2/pricing/flex-iod/{giaServiceId}
Response samples
application/json
{
  • "flexCharge": 42.4
}

CloudRouter

Find pricing for CloudRouters

Request
header Parameters
portal-token
required
string

Authentication token.

Request Body schema: application/json
companyId
string
bandwidth
string
object (Duration)
object (CloudRouterPriceCalcSite)
discountCode
string
Responses
200

OK

400

validations

401

unauthorized

404

entity not found

post/v2/pricing/l3vpn
Request samples
application/json
{
  • "companyId": "string",
  • "bandwidth": "string",
  • "duration": {
    },
  • "sites": {
    },
  • "discountCode": "string"
}
Response samples
application/json
{
  • "totalContractCost": null,
  • "baseL3vpnCost": null,
  • "duration": {
    },
  • "sites": [
    ],
  • "bandwidth": "500MB"
}

CloudRouter - add site

Find pricing for adding a site to a CloudRouter

Request
path Parameters
l3vpnId
required
string
header Parameters
portal-token
required
string

Authentication token.

Request Body schema: application/json
object
Responses
200

OK

400

validations

404

entity not found

post/v2/pricing/l3vpn/{l3vpnId}/add-site
Request samples
application/json
{
  • "site": {
    }
}
Response samples
application/json
{
  • "l3vpnId": "6328f276bb71e4e4ae01e9e9",
  • "baseL3vpnCost": 500,
  • "totalContractCost": 500,
  • "totalHourlySiteCost": 20,
  • "sites": [
    ],
  • "discount": null
}

CloudRouter - delete site

Find pricing for deleting a CloudRouter site

Request
path Parameters
l3vpnId
required
string
header Parameters
portal-token
required
string

Authentication token.

Request Body schema: application/json
siteId
string
Responses
200

OK

400

validations

404

entity not found

post/v2/pricing/l3vpn/{l3vpnId}/delete-site
Request samples
application/json
{
  • "siteId": "string"
}
Response samples
application/json
{
  • "l3vpnId": "6328f276bb71e4e4ae01e9e9",
  • "baseL3vpnCost": 500,
  • "totalContractCost": 500,
  • "totalHourlySiteCost": 20,
  • "sites": [
    ],
  • "discount": null
}

Generate a pdf with pricing information

PDF will be returned.

Request
Request Body schema: application/json
sendEMail
boolean

Send pricing calculator result via email.

Array of objects

An array of ports objects.

Array of objects

An array of connection objects.

Array of objects

An array of Internet on Demand objects.

Array of objects

An array of CloudRouter site. objects.

Responses
200

The pdf that is generated

post/pricing/generate-pdf
Request samples
application/json
{
  • "portsArray": [
    ],
  • "connectionsArray": [
    ],
  • "iodArray": [
    ],
  • "cloudRouterArray": [
    ]
}