Pricing API

Version 2

The Pricing API enabled the retrieval of Vonage services pricing information. Please note the Pricing API is rate limited to one request per second.

Télécharger la spécification OpenAPI
Opérations disponibles

Retrieve pricing.

Retrieves the pricing information for a certain product.

gethttps://api.nexmo.com/v2/account/pricing/:product

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

product
string
Exigée

The product for which you want to retrieve pricing information.

Il doit s'agir de l'un d'entre eux :sms-outboundvoice-outbound

Demande de renseignements Paramètres

country
string

A two letter country code. For example, CA.

page
integer

The page number of the results to retrieve.

page_size
integer

The number of results to retrieve per page.

Réponses
Type de contenu
application/json

Pricing information for a specific product.

page_size
string
exemple100

The number of results per page.

page
string
exemple1

The page number of the results.

total_items
string
exemple243

The total number of items.

total_pages
string
exemple3

The total number of pages.

_embedded
object
countries
array

A list of countries.

country_name
string
exempleCanada

Country name.

dialing_prefix
string
exemple1

The dialling prefix.

dest_network_type
string
exempleALL

The type of network.

group_internal_start
string
exemple1s

TBD

rate_increment
string
exemple60

The rate increment.

currency
string
exempleUSD

The currency that your account is being billed in.

price
string
exemple0.1

The price.

_links
object
self
object
href
string
exemplehttps://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100

The URL to retrieve the current page.

first
object
href
string
exemplehttps://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100

The URL to retrieve the first page.

last
object
href
string
exemplehttps://api.nexmo.com/account/pricing/sms-outbound?page=3&page_size=100

The URL to retrieve the last page.

next
object
href
string
exemplehttps://api.nexmo.com/account/pricing/sms-outbound?page=2&page_size=100

The URL to retrieve the next page.

prev
object
href
string
exemplehttps://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100

The URL to retrieve the previous page.

Exemple Réponse

{
   "page_size": "100",
   "page": "1",
   "total_items": "243",
   "total_pages": "3",
   "_embedded": {
      "countries": [
         {
            "country_name": "Canada",
            "dialing_prefix": "1",
            "dest_network_type": "ALL",
            "group_internal_start": "1s",
            "rate_increment": "60",
            "currency": "USD",
            "price": "0.1"
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100"
      },
      "first": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=3&page_size=100"
      },
      "next": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=2&page_size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100"
      }
   }
}