Request
|
Endpoint:
|
/api/services/pricing
|
|
Method:
|
GET
|
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
|
Authorization: Bearer <access_token>
|
Example Request:
{
"port_id": 1018,
"service_port_id": 1017,
"protected": 1
}
Request Values - Optional
|
port_id
|
Description
|
The ID of the port
|
|
Type
|
Integer
|
|
Example
|
1023
|
|
service_port_id
|
Description
|
The ID of the service port
|
|
Type
|
Integer
|
|
Example
|
1744
|
|
a_datacentre
|
Description
|
The ID of the A end datacentre
|
|
Type
|
Integer
|
|
Example
|
15
|
|
z_datacentre
|
Description
|
The ID of the Z end datacentre
|
|
Type
|
Integer
|
|
Example
|
25
|
|
protected
|
Description
|
Whether the service is protected
|
|
Type
|
Boolean
|
|
Example
|
1 (default value is 0)
|
Response
Example:
{
"products": [
{
"id": 11241,
"speed": "10Mbps",
"speed_raw": 10000,
"period_length": 12,
"period_type": "month",
"price": 41.14,
"currency": "GBP"
},
{
"id": 11242,
"speed": "10Mbps",
"speed_raw": 10000,
"period_length": 24,
"period_type": "month",
"price": 82.28,
"currency": "GBP"
},
...
]
}
|
id
|
Description
|
ID of the service product
|
|
Type
|
Integer
|
|
Example
|
11241
|
|
speed
|
Description
|
The speed of the service
|
|
Type
|
String
|
|
Example
|
"10Mbps"
|
|
speed_raw
|
Description
|
The speed of the service in kilobytes
|
|
Type
|
Integer
|
|
Example
|
10000
|
|
period_length
|
Description
|
The number of period units which defines the duration of the service. See period_type below for the unit type.
|
|
Type
|
Integer
|
|
Example
|
1
|
|
period_type
|
Description
|
The unit type of the period period_length.
|
|
Type
|
String
|
|
Example
|
"month"
|
|
price
|
Description
|
The numerical value cost for the service
|
|
Type
|
Float
|
|
Example
|
41.14
|
|
currency
|
Description
|
The currency related to the price value
|
|
Type
|
String
|
|
Example
|
"GBP"
|