Request
|
Endpoint:
|
/api/number-pricing
|
|
Method:
|
GET
|
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
|
Authorization: Bearer <access_token>
|
Required GET request parameters
|
country_iso
|
Description
|
The ISO code for the country. country_iso provided in the Countries Locality API
|
|
Type
|
String
|
|
Example
|
GB
|
|
number_service_type_code
|
Description
|
The code representing the Number Service Type. Permitted values: GEOGRAPHIC, TOLL FREE, PREMIUM, MOBILE, NATIONAL
|
|
Type
|
String
|
|
Example
|
GEOGRAPHIC
|
|
number_product_type_id
|
Description
|
The ID of the Number Product Type. number_product_type_id provided in the Number Product Type API
|
|
Type
|
Integer
|
|
Example
|
1
|
Response
Example:
{
"number_pricing": {
"country": {
"name": "United Kingdom",
"iso": "GB"
},
"number_service_type": {
"id": 2,
"name": "Toll Free",
"code": "TOLL FREE"
},
"number_product_type": {
"id": 1,
"name": "Inbound Numbers"
},
"currency": {
"name": "EUR - Euro",
"symbol": "€",
"html_symbol": "€"
},
"nrc": 2,
"mrc": 2,
"rates": {
"fixed": {
"inbound_rate": 0.01,
"inbound_call_setup_rate": 0
},
"mobile": {
"inbound_rate": 0.04,
"inbound_call_setup_rate": 0
},
"payphone": {
"inbound_rate": 1.04,
"inbound_call_setup_rate": 0
}
}
}
}
|
nrc
|
Description
|
The NRC cost for numbers in the requested currency
|
|
Type
|
Number
|
|
Example
|
10
|
|
mrc
|
Description
|
The MRC cost for numbers in the requested currency
|
|
Type
|
Number
|
|
Example
|
2
|
|
rates
|
Description
|
Inbound minute and setup rates for different origins of the call (fixed, mobile, payphone) in the requested currency
|
|
Type
|
Array
|
|
Example
|
See example above
|