Pricing API

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

Available Operations:

get Retrieve outbound pricing for a specific country.
get Retrieve outbound pricing for all countries.
get Retrieve outbound pricing for a specific dialing prefix.

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

Host


        https://rest.nexmo.com

GET


        /account/get-pricing/outbound/:type

Path Parameters

type

string | Required

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

Query Parameter

api_key

string | Required

Your Nexmo API key.

api_secret

string | Required

Your Nexmo API secret.

country

string | Required

A two letter country code. For example, CA.

Responses

200 Pricing information for a specific country.

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

string

The type of network: mobile or landline.

string

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

string

The currency used for prices for this network.

string

The Mobile Country Code of the operator.

string

The Mobile Network Code of the operator.

string

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

string

The company/organisational name of the operator.

Example Responses

200 400 401 404 429

{
  "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

Host


        https://rest.nexmo.com

GET


        /account/get-full-pricing/outbound/:type

Path Parameters

type

string | Required

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

Query Parameter

api_key

string | Required

Your Nexmo API key.

api_secret

string | Required

Your Nexmo API secret.

Responses

200 Pricing response

count

string

The number of countries retrieved.

countries

array of objects

A list of countries.

string

Readable country name.

string

Readable country name.

string

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

string

The default price.

string

The dialling prefix.

array of objects

An array of network objects

string

The type of network: mobile or landline.

string

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

string

The currency used for prices for this network.

string

The Mobile Country Code of the operator.

string

The Mobile Network Code of the operator.

string

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

string

The company/organisational name of the operator.

Example Responses

200 400 401 404 429

{
  "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

Host


        https://rest.nexmo.com

GET


        /account/get-prefix-pricing/outbound/:type

Path Parameters

type

string | Required

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

Query Parameter

api_key

string | Required

Your Nexmo API key.

api_secret

string | Required

Your Nexmo API secret.

prefix

string | Required

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

Responses

200 Pricing countries response

count

string

The number of countries retrieved.

countries

array of objects

A list of countries.

string

Readable country name.

string

Readable country name.

string

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

string

The default price.

string

The dialling prefix.

array of objects

An array of network objects

string

The type of network: mobile or landline.

string

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

string

The currency used for prices for this network.

string

The Mobile Country Code of the operator.

string

The Mobile Network Code of the operator.

string

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

string

The company/organisational name of the operator.

Example Responses

200 400 401 404 429

{
  "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.