Welcome to Nexmo Developer

We are improving our Documentation, API references, learning resources & tooling to help you more effectively use our services. We want to help you find everything you need to integrate Nexmo APIs into your code.

As we start this transition, we’d love to hear from you with thoughts & suggestions. If you’ve got something, positive or negative, to tell us, please tell us using the feedback tool at the bottom of each guide or file an issue on GitHub. - Nexmo

Developer - Pricing API Reference

Pricing

Pricing by country

Retrieve our outbound pricing for a given country

Request

GET  https://rest.nexmo.com/account/get-pricing/outbound/:type
Parameters

The following shows the parameters you use in the request:

Parameter Description Required
type The type of service you wish to retrieve data about: either sms, sms-transit or voice. No
api_key Your Nexmo API key. Yes
api_secret Your Nexmo API secret. Yes
country A 2 letter country code  . For example, CA Yes

Response

The following shows example Responses in JSON or XML:

{
  "country": "GB",
  "name": "United Kingdom",
  "prefix": "44",
  "mt": "0.03330000",
  "networks": [
    {
      "code": "12345",
      "network": "Acme Telco",
      "mtPrice": "0.03330000"
    },
  ],
  "countryDisplayName": "United Kingdom"
}

Keys and Values

The response contains the following keys and values:

Key Value
dialingPrefix The numerical dialing prefix code for the country in question (e.g. for the United Kingdom, 44, for the United States 1)
currency The currency that your account is being billed in (by default: Euros—EUR). Changeable via the Dashboard to US Dollars—USD.
countryDisplayName The display name for the country you looked up: e.g. United Kingdom, Belgium, Japan.
countryCode The code for the country you looked up: e.g. GB, US, BR, RU.
countryName The name for the country you looked up: e.g. United Kingdom.
networks An array containing networks.

The number prefix ranges refer to who owns the number range. In many countries it is possible to port your number from mobile operator to another: number prefix ranges refer to who owns the number range, but a mobile subscriber using a ported number may be using a network different from the owner of the network. You can use the Number Insight API to look up individual numbers to see if they have been ported.

Pricing for all countries

Retrieve our outbound pricing for all countries.

Request

GET  https://rest.nexmo.com/account/get-full-pricing/outbound/:type
Parameters

The following shows the parameters you use in the request:

Parameter Description Required
type The type of service you wish to retrieve data about: either sms, sms-transit or voice. Yes
api_key Your Nexmo API key. Yes
api_secret Your Nexmo API secret. Yes

Response

The following shows example Responses in JSON or XML:

{
  "count": 243,
  "countries": [
    {
      "dialingPrefix": "93",
      "currency": "EUR",
      "countryDisplayName": "Afghanistan",
      "countryCode": "AF",
      "countryName": "Afghanistan",
      "networks": [
        {
          "type": "mobile",
          "price": "0.10100000",
          "currency": "EUR",
          "aliases": [
            "41280"
          ],
          "mcc": "412",
          "mnc": "88",
          "networkCode": "41288",
          "networkName": "Afghan Telecom"
        }
      ]
    },
    {
      "dialingPrefix": "355",
      "currency": "EUR",
      "countryDisplayName": "Albania",
      "countryCode": "AL",
      "countryName": "Albania",
      "networks": [
        {
          "type": "mobile",
          "price": "0.07732800",
          "currency": "EUR",
          "mcc": "276",
          "mnc": "02",
          "networkCode": "27602",
          "networkName": "Vodaphone Albania"
        }
      ]
    }
  ]
}

Actual responses are quite lengthy; these responses have been shortened.

Keys and Values

The response contains the following keys and values:

Key Value
count The number of countries returned in the response.
countries An array containing each country.

For each country, the following information is provided:

Key Value
dialingPrefix The numerical dialing prefix code for the country in question (e.g. for the United Kingdom, 44, for the United States 1)
currency The currency that your account is being billed in (by default: Euros—EUR). Changeable via the Dashboard to US Dollars—USD.
countryDisplayName The display name for the country you looked up: e.g. United Kingdom, Belgium, Japan.
countryCode The code for the country you looked up: e.g. GB, US, BR, RU.
countryName The name for the country you looked up: e.g. United Kingdom.
networks An array containing networks.

The number prefix ranges refer to who owns the number range. In many countries it is possible to port your number from mobile operator to another: number prefix ranges refer to who owns the number range, but a mobile subscriber using a ported number may be using a network different from the owner of the network. You can use the Number Insight API to look up individual numbers to see if they have been ported.

Pricing by prefix

GET  https://rest.nexmo.com/account/get-prefix-pricing/outbound/:type

Retrieves pricing information based on the numerical prefix used in phone numbers.

In most cases, a number prefix will only be used by one country, but exceptions exist. In the case of 1, it is used by both the United States and Canada, as well as the United States Minor Outlying Islands  , due to the North American Numbering Plan  . All three appear as separate entries in the response.

Parameters

The following shows the parameters you use in the request:

Parameter Description Required
type The type of service you wish to retrieve data about: either sms, sms-transit or voice. Yes
api_key Your Nexmo API key. Yes
api_secret Your Nexmo API secret. Yes
prefix The numerical prefix to look up. Examples: 44, 1 etc.

Response

The following shows example Responses in JSON or XML:

{
  "count": 3,
  "prices": [
    {
      "country": "CA",
      "name": "Canada",
      "prefix": "1",
      "mt": "0.00570000",
      "networks": [
        {
          "code": "302320",
          "network": "Rogers Communications Canada Inc.",
          "mtPrice": "0.00570000"
        }
      ],
      "countryDisplayName": "Canada"
    },
    {
      "country": "US",
      "name": "United States",
      "prefix": "1",
      "mt": "0.00570000",
      "networks": [
        {
          "code": "310004",
          "network": "Verizon Wireless",
          "mtPrice": "0.00570000"
        }
      ],
      "countryDisplayName": "United States"
    },
    {
      "country": "UM",
      "name": "United States Minor Outlying Islands",
      "prefix": "1",
      "countryDisplayName": "United States Minor Outlying Islands"
    }
  ]
}

Actual responses are quite lengthy; these responses have been shortened.

Keys and Values

The response contains the following keys and values:

Key Value
count The number of countries returned in the response.
prices An array of objects.
countries An array containing each country.

For each country, the following information is provided:

Key Value
dialingPrefix The numerical dialing prefix code for the country in question (e.g. for the United Kingdom, 44, for the United States 1)
currency The currency that your account is being billed in (by default: Euros—EUR). Changeable via the Dashboard to US Dollars—USD.
countryDisplayName The display name for the country you looked up: e.g. United Kingdom, Belgium, Japan.
countryCode The code for the country you looked up: e.g. GB, US, BR, RU.
countryName The name for the country you looked up: e.g. United Kingdom.
networks An array containing networks.

The number prefix ranges refer to who owns the number range. In many countries it is possible to port your number from mobile operator to another: number prefix ranges refer to who owns the number range, but a mobile subscriber using a ported number may be using a network different from the owner of the network. You can use the Number Insight API to look up individual numbers to see if they have been ported.

Common elements in responses

Network

The following data is common in a number of the above responses.

Key Value
type The type of network: mobile or landline.
price The cost to send a message or make a call to this network
currency The currency used for prices for this network.
ranges A list of number prefixes that belong to this network.
mcc The Mobile Country Code  of the operator.
mnc The Mobile Network Code of the operator.
networkCode The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.
networkName The company/organisational name of the operator.