[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage Pricing # Vonage Pricing SDK for Node.js ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/pricing?label=%40vonage%2Fpricing&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license] Vonage This is the Vonage Pricing SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup]. For full API documentation refer to [developer.nexmo.com](https://developer.nexmo.com/). If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/pricing/v2_TO_v3_MIGRATION_GUIDE.md) * [Installation](#installation) * [Usage](#usage) * [Promises](#promises) * [Testing](#testing) ## Installation We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation. You can also use this SDK standalone if you only need access to just the Pricing API. ### With NPM ```bash npm install @vonage/pricing ``` ### With Yarn ```bash yarn add @vonage/pricing ``` ## Usage ### As part of the Vonage Server SDK If you are using this SDK as part of the Vonage Server SDK, you can access it as the `pricing` property off of the client that you instantiate. ```js const { Vonage, Auth } = require('@vonage/server-sdk'); const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET }); const options = {}; const vonage = new Vonage(credentials, options); vonage.pricing.listCountryPricing('sms') .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ### Standalone The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Pricing API. All you need to do is `require('@vonage/pricing')`, and use the returned object to create your own client. ```js const { Auth } = require('@vonage/auth'); const { Pricing } = require('@vonage/pricing'); const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET }); const options = {}; const pricingClient = new Pricing(credentials, options); ``` Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options) ## Promises Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response. ```js const resp = await vonage.pricing.basicLookup(PHONE_NUMBER) vonage.pricing.getAvailablePricing() .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ## Testing Run: ```bash npm run test ``` [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk [license]: _media/LICENSE.txt ## Enumerations ### ServiceType Defined in: [pricing/lib/enums/ServiceType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/enums/ServiceType.ts#L4) Enum representing different service types for pricing information. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `SMS` | `"sms"` | SMS service. | [pricing/lib/enums/ServiceType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/enums/ServiceType.ts#L8) | | `SMS_TRANSIT` | `"sms-transit"` | SMS Transit service. | [pricing/lib/enums/ServiceType.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/enums/ServiceType.ts#L13) | | `VOICE` | `"voice"` | Voice service. | [pricing/lib/enums/ServiceType.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/enums/ServiceType.ts#L18) | ## Classes ### Pricing Defined in: [pricing/lib/pricing.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/pricing.ts#L39) The Pricing API allows you to retrieve pricing information for all countries and a specific service type, for a specific country and service type, or for a specific prefix and service type. #### Examples Create a standalone Pricing client ```ts import { Pricing } from '@vonage/pricing'; const pricingClient = new Pricing({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); ``` Create an Pricing client from the Vonage client ```ts import { Vonage } from '@vonage/server-client'; const vonage = new Vonage({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); const pricingClient = vonage.pricing; ``` #### Extends - [`Client`](Vonage-Server-Client.md#client) #### Constructors ##### Constructor ```ts new Pricing(credentials, options?): Pricing; ``` Defined in: server-client/dist/lib/client.d.ts:35 Creates a new instance of the Client. ###### Parameters ###### credentials The authentication credentials or an authentication instance. [`AuthParams`](Vonage-Auth.md#authparams) | [`AuthInterface`](Vonage-Auth.md#authinterface) ###### options? [`ConfigParams`](Vonage-Server-Client.md#configparams) Optional configuration settings for the client. ###### Returns [`Pricing`](#pricing) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor) #### Properties ##### auth ```ts protected auth: AuthInterface; ``` Defined in: server-client/dist/lib/client.d.ts:24 The authentication instance responsible for generating authentication headers and query parameters. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth) ##### authType ```ts protected authType: AuthenticationType = AuthenticationType.BASIC; ``` Defined in: [pricing/lib/pricing.ts:43](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/pricing.ts#L43) ###### See [Client.authType](Vonage-Messages.md#messages#authtype) ###### Overrides [`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype) ##### config ```ts protected config: ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:28 Configuration settings for the client, including default hosts for various services and other request settings. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config) ##### transformers ```ts static transformers: object; ``` Defined in: server-client/dist/lib/client.d.ts:11 Static property containing utility transformers. ###### camelCaseObjectKeys ```ts camelCaseObjectKeys: PartialTransformFunction; ``` ###### kebabCaseObjectKeys ```ts kebabCaseObjectKeys: PartialTransformFunction; ``` ###### omit() ```ts omit: (keys, obj) => TransformedObject; ``` ###### Parameters ###### keys `string`[] ###### obj [`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform) ###### Returns [`TransformedObject`](Vonage-Server-Client.md#transformedobject) ###### snakeCaseObjectKeys ```ts snakeCaseObjectKeys: PartialTransformFunction; ``` ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers) #### Methods ##### addAuthenticationToRequest() ```ts addAuthenticationToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:43 Adds the appropriate authentication headers or parameters to the request based on the authentication type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addAuthenticationToRequest`](Vonage-Server-Client.md#client#addauthenticationtorequest) ##### addBasicAuthToRequest() ```ts protected addBasicAuthToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:71 Adds basic authentication headers to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addBasicAuthToRequest`](Vonage-Server-Client.md#client#addbasicauthtorequest) ##### addJWTToRequest() ```ts protected addJWTToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:64 Adds a JWT to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addJWTToRequest`](Vonage-Server-Client.md#client#addjwttorequest) ##### addQueryKeySecretToRequest() ```ts protected addQueryKeySecretToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:57 Adds API key and secret to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequest`](Vonage-Server-Client.md#client#addquerykeysecrettorequest) ##### addQueryKeySecretToRequestBody() ```ts protected addQueryKeySecretToRequestBody(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:50 Adds API key and secret to the request body. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequestBody`](Vonage-Server-Client.md#client#addquerykeysecrettorequestbody) ##### getConfig() ```ts getConfig(): ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:36 ###### Returns [`ConfigParams`](Vonage-Server-Client.md#configparams) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`getConfig`](Vonage-Server-Client.md#client#getconfig) ##### listAllCountriesPricing() ```ts listAllCountriesPricing(type): Promise; ``` Defined in: [pricing/lib/pricing.ts:85](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/pricing.ts#L85) Retrieves pricing information for all countries and a specific service type. ###### Parameters ###### type [`ServiceType`](#servicetype) The service type. ###### Returns `Promise`\<[`OutboundAllCountriesPricingResponse`](#outboundallcountriespricingresponse)\> - Pricing information for all countries. ###### Example ```ts import { ServiceType } from '@vonage/pricing'; const pricing = await pricingClient.listAllCountriesPricing(ServiceType.SMS); for (const country in pricing.countries) { console.log(`The current price for ${country.countryName} is ${country.defaultPrice}`); } ``` ##### listCountryPricing() ```ts listCountryPricing(type, country): Promise; ``` Defined in: [pricing/lib/pricing.ts:60](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/pricing.ts#L60) Retrieves pricing information for a specific country and service type. ###### Parameters ###### type [`ServiceType`](#servicetype) The service type. ###### country `string` The country for which pricing information is requested. ###### Returns `Promise`\<[`OutboundCountryPricingResponse`](#outboundcountrypricingresponse)\> - Pricing information for the specified country. ###### Example ```ts import { ServiceType } from '@vonage/pricing'; const pricing = await pricingClient.listCountryPricing(ServiceType.SMS, 'GB'); console.log(`The current price for Great Britian is ${pricing.defaultPrice}`); ``` ##### listPrefixPricing() ```ts listPrefixPricing(type, prefix): Promise; ``` Defined in: [pricing/lib/pricing.ts:108](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/pricing.ts#L108) Retrieves pricing information for a specific prefix and service type. ###### Parameters ###### type [`ServiceType`](#servicetype) The service type. ###### prefix `string` The prefix for which pricing information is requested. ###### Returns `Promise`\<[`OutboundAllCountriesPricingResponse`](#outboundallcountriespricingresponse)\> - Pricing information for the specified prefix. ###### Example ```ts import { ServiceType } from '@vonage/pricing'; const pricing = await pricingClient.listPrefixPricing(ServiceType.SMS, '44'); console.log(`The current price for Great Britian is ${pricing.defaultPrice}`); ``` ##### parseResponse() ```ts protected parseResponse(request, response): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:168 Parses the response based on its content type. ###### Type Parameters ###### T `T` The expected type of the parsed response data. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### response `Response` The raw response from the request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`parseResponse`](Vonage-Server-Client.md#client#parseresponse) ##### prepareBody() ```ts protected prepareBody(request): undefined | string; ``` Defined in: server-client/dist/lib/client.d.ts:158 Prepares the body for the request based on the content type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### Returns `undefined` \| `string` - The prepared request body as a string or undefined. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareBody`](Vonage-Server-Client.md#client#preparebody) ##### prepareRequest() ```ts protected prepareRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:151 Prepares the request with necessary headers, authentication, and query parameters. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The initial request options. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The modified request options. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareRequest`](Vonage-Server-Client.md#client#preparerequest) ##### sendDeleteRequest() ```ts sendDeleteRequest(url): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:78 Sends a DELETE request to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the DELETE request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the DELETE request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendDeleteRequest`](Vonage-Server-Client.md#client#senddeleterequest) ##### sendFormSubmitRequest() ```ts sendFormSubmitRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:86 Sends a POST request with form data to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? `Record`\<`string`, `undefined` \| `string`\> Optional payload containing form data to send with the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendFormSubmitRequest`](Vonage-Server-Client.md#client#sendformsubmitrequest) ##### sendGetRequest() ```ts sendGetRequest(url, queryParams?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:94 Sends a GET request to the specified URL with optional query parameters. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the GET request. ###### queryParams? Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the GET request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendGetRequest`](Vonage-Server-Client.md#client#sendgetrequest) ##### sendPatchRequest() ```ts sendPatchRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:104 Sends a PATCH request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PATCH request. ###### payload? Optional payload to be sent as the body of the PATCH request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PATCH request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPatchRequest`](Vonage-Server-Client.md#client#sendpatchrequest) ##### sendPostRequest() ```ts sendPostRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:114 Sends a POST request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? Optional payload to be sent as the body of the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPostRequest`](Vonage-Server-Client.md#client#sendpostrequest) ##### sendPutRequest() ```ts sendPutRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:124 Sends a PUT request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PUT request. ###### payload? Optional payload to be sent as the body of the PUT request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PUT request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPutRequest`](Vonage-Server-Client.md#client#sendputrequest) ##### sendRequest() ```ts sendRequest(request): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:144 Sends a request adding necessary headers, handling authentication, and parsing the response. ###### Type Parameters ###### T `T` ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The options defining the request, including URL, method, headers, and data. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequest`](Vonage-Server-Client.md#client#sendrequest) ##### sendRequestWithData() ```ts sendRequestWithData( method, url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:135 Sends a request with JSON-encoded data to the specified URL using the provided HTTP method. ###### Type Parameters ###### T `T` ###### Parameters ###### method The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable). [`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch) ###### url `string` The URL endpoint for the request. ###### payload? Optional payload to be sent as the body of the request, JSON-encoded. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequestWithData`](Vonage-Server-Client.md#client#sendrequestwithdata) ## Type Aliases ### Network ```ts type Network = object; ``` Defined in: [pricing/lib/types/Network.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L4) Type representing a network within a specific country's pricing information. #### Properties ##### currency ```ts currency: string; ``` Defined in: [pricing/lib/types/Network.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L18) The currency used for prices for this network ##### mcc ```ts mcc: string; ``` Defined in: [pricing/lib/types/Network.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L23) The Mobile Country Code (MCC) of the operator ##### mnc ```ts mnc: string; ``` Defined in: [pricing/lib/types/Network.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L28) The Mobile Network Code (MNC) of the operator ##### networkCode ```ts networkCode: string; ``` Defined in: [pricing/lib/types/Network.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L33) The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator ##### networkName ```ts networkName: string; ``` Defined in: [pricing/lib/types/Network.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L38) The company/organizational name of the operator ##### price ```ts price: string; ``` Defined in: [pricing/lib/types/Network.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L13) The cost to send a message or make a call on this network. ##### type ```ts type: string; ``` Defined in: [pricing/lib/types/Network.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Network.ts#L8) The type of network *** ### OutboundAllCountriesPricingResponse ```ts type OutboundAllCountriesPricingResponse = object; ``` Defined in: [pricing/lib/types/Response/OutboundAllCountriesPricingResponse.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundAllCountriesPricingResponse.ts#L6) Type representing the response for pricing information of all countries. #### Properties ##### count ```ts count: number; ``` Defined in: [pricing/lib/types/Response/OutboundAllCountriesPricingResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundAllCountriesPricingResponse.ts#L10) The number of countries in the response. ##### countries ```ts countries: OutboundCountryPricingResponse[]; ``` Defined in: [pricing/lib/types/Response/OutboundAllCountriesPricingResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundAllCountriesPricingResponse.ts#L15) An array of objects containing pricing information for individual countries. *** ### OutboundCountryPricingResponse ```ts type OutboundCountryPricingResponse = object; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L5) Type representing the response for pricing information of a specific country. #### Properties ##### countryCode ```ts countryCode: string; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L9) Two-letter country code. ##### countryDisplayName ```ts countryDisplayName: string; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L19) Readable country name. ##### countryName ```ts countryName: string; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L14) Readable country name. ##### currency ```ts currency: string; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L24) The currency that your account is being billed in. ##### defaultPrice ```ts defaultPrice: string; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L29) The default price for services in this country. ##### dialingPrefix ```ts dialingPrefix: string; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L34) The dialing prefix for this country. ##### networks ```ts networks: Network[]; ``` Defined in: [pricing/lib/types/Response/OutboundCountryPricingResponse.ts:39](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/Response/OutboundCountryPricingResponse.ts#L39) An array of network objects representing different networks in this country. *** ### PricingClassParameters ```ts type PricingClassParameters = AuthParams & VetchOptions & object; ``` Defined in: [pricing/lib/types/PricingClassParameters.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/PricingClassParameters.ts#L7) Type representing parameters for a pricing class, including authentication and Vetch options. #### Type declaration ##### auth? ```ts optional auth: AuthInterface; ``` An optional authentication interface. ###### Returns - The authentication interface if provided, otherwise undefined. *** ### PricingResponse\ ```ts type PricingResponse = VetchResponse; ``` Defined in: [pricing/lib/types/PricingResponse.ts:3](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/pricing/lib/types/PricingResponse.ts#L3) #### Type Parameters ##### T `T`