Pricing API

The API to retrieve pricing information. Please note the Pricing API is rate limited to one request per second.

Download OpenAPI 3 Definition
Improve this specification

Retrieve outbound pricing for a specific country.

Retrieves the pricing information based on the specified country.

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

Path Parameters

Key Description Example Default
type
Required | string

The type of service you wish to retrieve data about: either sms, sms-transit or voice.

 sms None

Query Parameter

Key Description Example Default
api_key
Required | string

Your Nexmo API key.

 None None
api_secret
Required | string

Your Nexmo API secret.

 None None
country
Required | string

A two letter country code. For example, CA.

 None None

View response field descriptions

Response Fields

Field Description
countryCode
string

Two letter country code.
countryName
string

Readable country name.
countryDisplayName
string

Readable country name.
currency
string

The currency that your account is being billed in (by default Euros—EUR). Can change in the Dashboard to US Dollars—USD.
defaultPrice
string

The default price.
dialingPrefix
string

The dialling prefix.
networks
array of objects

An array of network objects
Field Description
type
string

The type of network: mobile or landline.
price
string

The cost to send a message or make a call to this network
currency
string

The currency used for prices for this network.
mcc
string

The Mobile Country Code of the operator.
mnc
string

The Mobile Network Code of the operator.
networkCode
string

The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.
networkName
string

The company/organisational name of the operator.

 
{
  "countryCode": "CA",
  "countryName": "Canada",
  "countryDisplayName": "Canada",
  "currency": "EUR",
  "defaultPrice": "0.00620000",
  "dialingPrefix": "1",
  "networks": [
    {
      "type": "mobile",
      "price": "0.00590000",
      "currency": "EUR",
      "mcc": "302",
      "mnc": "530",
      "networkCode": "302530",
      "networkName": "Keewaytinook Okimakanak"
    }
  ]
}
{
  "type": "BAD_REQUEST",
  "error_title": "Bad Request",
  "invalid_parameters": {
    "parameter": "country",
    "message": "Is required"
  }
}
{
  "currency": "EUR",
  "code": "401",
  "error-code-label": "authentication failed"
}
The page you requested was not found
You made too many requests. The API is rate limited to one request per second.

Retrieve outbound pricing for all countries.

Retrieves the pricing information for all countries.

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

Path Parameters

Key Description Example Default
type
Required | string

The type of service you wish to retrieve data about: either sms, sms-transit or voice.

 sms None

Query Parameter

Key Description Example Default
api_key
Required | string

Your Nexmo API key.

 None None
api_secret
Required | string

Your Nexmo API secret.

 None None

View response field descriptions

Response Fields

Field Description
count
string

The number of countries retrieved.
countries
array of objects

A list of countries.
Field Description
countryName
string

Readable country name.
countryDisplayName
string

Readable country name.
currency
string

The currency that your account is being billed in (by default Euros—EUR). Can change in the Dashboard to US Dollars—USD.
defaultPrice
string

The default price.
dialingPrefix
string

The dialling prefix.
networks
array of objects

An array of network objects
Field Description
type
string

The type of network: mobile or landline.
price
string

The cost to send a message or make a call to this network
currency
string

The currency used for prices for this network.
mcc
string

The Mobile Country Code of the operator.
mnc
string

The Mobile Network Code of the operator.
networkCode
string

The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.
networkName
string

The company/organisational name of the operator.

 
{
  "count": "243",
  "countries": [
    {
      "countryName": "Canada",
      "countryDisplayName": "Canada",
      "currency": "EUR",
      "defaultPrice": "0.00620000",
      "dialingPrefix": "1",
      "networks": [
        {
          "type": "mobile",
          "price": "0.00590000",
          "currency": "EUR",
          "mcc": "302",
          "mnc": "530",
          "networkCode": "302530",
          "networkName": "Keewaytinook Okimakanak"
        }
      ]
    }
  ]
}
{
  "type": "BAD_REQUEST",
  "error_title": "Bad Request",
  "invalid_parameters": {
    "parameter": "country",
    "message": "Is required"
  }
}
{
  "currency": "EUR",
  "code": "401",
  "error-code-label": "authentication failed"
}
The page you requested was not found
You made too many requests. The API is rate limited to one request per second.

Retrieve outbound pricing for a specific dialing prefix.

Retrieves the pricing information based on the dialing prefix.

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

Path Parameters

Key Description Example Default
type
Required | string

The type of service you wish to retrieve data about: either sms, sms-transit or voice.

 sms None

Query Parameter

Key Description Example Default
api_key
Required | string

Your Nexmo API key.

 None None
api_secret
Required | string

Your Nexmo API secret.

 None None
prefix
Required | string

The numerical dialing prefix to look up pricing for. Examples include 44, 1 and so on.

 None None

View response field descriptions

Response Fields

Field Description
count
string

The number of countries retrieved.
countries
array of objects

A list of countries.
Field Description
countryName
string

Readable country name.
countryDisplayName
string

Readable country name.
currency
string

The currency that your account is being billed in (by default Euros—EUR). Can change in the Dashboard to US Dollars—USD.
defaultPrice
string

The default price.
dialingPrefix
string

The dialling prefix.
networks
array of objects

An array of network objects
Field Description
type
string

The type of network: mobile or landline.
price
string

The cost to send a message or make a call to this network
currency
string

The currency used for prices for this network.
mcc
string

The Mobile Country Code of the operator.
mnc
string

The Mobile Network Code of the operator.
networkCode
string

The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.
networkName
string

The company/organisational name of the operator.

 
{
  "count": "243",
  "countries": [
    {
      "countryName": "Canada",
      "countryDisplayName": "Canada",
      "currency": "EUR",
      "defaultPrice": "0.00620000",
      "dialingPrefix": "1",
      "networks": [
        {
          "type": "mobile",
          "price": "0.00590000",
          "currency": "EUR",
          "mcc": "302",
          "mnc": "530",
          "networkCode": "302530",
          "networkName": "Keewaytinook Okimakanak"
        }
      ]
    }
  ]
}
{
  "type": "BAD_REQUEST",
  "error_title": "Bad Request",
  "invalid_parameters": {
    "parameter": "country",
    "message": "Is required"
  }
}
{
  "currency": "EUR",
  "code": "401",
  "error-code-label": "authentication failed"
}
The page you requested was not found
You made too many requests. The API is rate limited to one request per second.