Get Phone Number Price
Get the monthly price of a phone number by country and type.
GET
Your role needs the phone_number:view permission. Otherwise the request fails with 403 {"error": "Insufficient permissions"}.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Query Parameters
countrystringrequiredCountry code, for example US, CA, AU or GB.
typestringrequiredlocal or mobile. Toll-free numbers are not sold through the API: tollFree returns 403 with code TOLL_FREE_NOT_AVAILABLE.
Response Fields
countrystringThe country you asked for.
typestringThe type you asked for.
priceobjectPricing details.
Errors
| Status | Body | When |
|---|---|---|
400 | {"error": "Country, type, and workspace ID are required."} | A parameter or x-workspace-id is missing |
403 | {"error": "...", "code": "TOLL_FREE_NOT_AVAILABLE"} | type is toll-free |
500 | {"error": "Failed to retrieve phone number price"} | The price could not be retrieved |
{
"country": "US",
"type": "local",
"price": {
"number_type": "local",
"current_price": "0.79",
"basePrice": 0.79,
"monthlyPrice": 6.79
}
}Last updated on