[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage Subaccounts # Vonage Sub Accounts 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/subaccounts?label=%40vonage%2Fsubaccounts&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 Sub Accounts 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.vonage.com](https://developer.vonage.com/). - [Installation](#installation) - [Usage](#usage) - [Promises](#promises) - [Testing](#testing) ## Installation ### With NPM ```bash npm install @vonage/subaccounts ``` ### With Yarn ```bash yarn add @vonage/subaccounts ``` ## Usage Unlike the other SDK's this package is not include in the [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) ```js const { Auth } = require('@vonage/auth') const { SubAccounts } = require('@vonage/subaccounts') const credentials = new Auth({ applicationId: APP_ID, privateKey: PRIAVTE_KEY, }) const options = {} const subAccountClient = new SubAccounts(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 subAccountClient.listSubAccounts() subAccountClient .listSubAccounts() .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 ## Classes ### SubAccounts Defined in: [subaccounts/lib/subaccount.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L29) Represents a client for interacting with Vonage Subaccounts API. This class provides methods for managing subaccounts, credit transfers, balance transfers, and number transfers. #### Extends - [`Client`](Vonage-Server-Client.md#client) #### Constructors ##### Constructor ```ts new SubAccounts(credentials, options?): SubAccounts; ``` 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. [`AuthInterface`](Vonage-Auth.md#authinterface) | [`AuthParams`](Vonage-Auth.md#authparams) ###### options? [`ConfigParams`](Vonage-Server-Client.md#configparams) Optional configuration settings for the client. ###### Returns [`SubAccounts`](#subaccounts) ###### 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: [subaccounts/lib/subaccount.ts:30](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L30) The type of authentication used for the client's requests. ###### 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) ##### createSubAccount() ```ts createSubAccount(subAccount): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:73](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L73) Creates a new subaccount under the primary account. ###### Parameters ###### subAccount [`SubAccountCreateParameters`](#subaccountcreateparameters) The parameters for creating the subaccount. ###### Returns `Promise`\<[`SubAccount`](#subaccount-1)\> A promise that resolves to the created subaccount information. ##### 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) ##### getPrimaryAccount() ```ts getPrimaryAccount(): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:60](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L60) Retrieves information about the primary account associated with the subaccounts. ###### Returns `Promise`\<[`Account`](#account)\> A promise that resolves to information about the primary account. ##### getSubAccount() ```ts getSubAccount(subAccountId): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:90](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L90) Retrieves information about a specific subaccount by its ID. ###### Parameters ###### subAccountId `string` The ID of the subaccount to retrieve. ###### Returns `Promise`\<[`SubAccount`](#subaccount-1)\> A promise that resolves to the subaccount information. ##### getSubAccountPage() ```ts getSubAccountPage(): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L37) Retrieves a page of subaccounts associated with the primary account. ###### Returns `Promise`\<[`SubAccountResponsePage`](#subaccountresponsepage)\> A promise that resolves to a page of subaccount information. ##### listBalanceTransfers() ```ts listBalanceTransfers(params): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:159](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L159) Retrieves a list of balance transfers that have taken place for a primary account within a specified time period. ###### Parameters ###### params [`BalanceTransferListParameters`](#balancetransferlistparameters) The parameters for filtering balance transfers. ###### Returns `Promise`\<[`BalanceTransfer`](#balancetransfer)[]\> A promise that resolves to an array of balance transfer information. ##### listCreditTransfers() ```ts listCreditTransfers(params): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:123](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L123) Retrieves a list of credit transfers that have taken place for a primary account within a specified time period. ###### Parameters ###### params [`CreditTransferListParameters`](#credittransferlistparameters) The parameters for filtering the list of credit transfers. ###### Returns `Promise`\<[`CreditTransfer`](#credittransfer)[]\> A promise that resolves to an array of credit transfer information. ##### listSubAccounts() ```ts listSubAccounts(): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:50](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L50) Retrieves a list of subaccounts associated with the primary account. ###### Returns `Promise`\<[`SubAccount`](#subaccount-1)[]\> A promise that resolves to an array of subaccount information. ##### 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) ##### transferBalance() ```ts transferBalance(params): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:178](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L178) Transfers balance between a primary account and one of its subaccounts. ###### Parameters ###### params [`BalanceTransferParameters`](#balancetransferparameters) The parameters for the balance transfer. ###### Returns `Promise`\<[`BalanceTransfer`](#balancetransfer)\> A promise that resolves to the details of the balance transfer. ##### transferCredit() ```ts transferCredit(params): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:142](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L142) Transfers credit limit between a primary account and one of its subaccounts. ###### Parameters ###### params [`CreditTransferParameters`](#credittransferparameters) The parameters for transferring credit. ###### Returns `Promise`\<[`CreditTransfer`](#credittransfer)\> A promise that resolves to information about the credit transfer. ##### transferNumber() ```ts transferNumber(params): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:197](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L197) Transfers a phone number from one account to another. ###### Parameters ###### params [`NumberTransfer`](#numbertransfer) The parameters for the number transfer. ###### Returns `Promise`\<[`NumberTransfer`](#numbertransfer)\> A promise that resolves to the details of the number transfer. ##### updateSubAccount() ```ts updateSubAccount(subAccountId, params): Promise; ``` Defined in: [subaccounts/lib/subaccount.ts:105](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/subaccount.ts#L105) Modifies one or more properties of a specific subaccount. ###### Parameters ###### subAccountId `string` The ID of the subaccount to modify. ###### params [`SubAccountModifyParameters`](#subaccountmodifyparameters) The parameters for modifying the subaccount. ###### Returns `Promise`\<[`SubAccount`](#subaccount-1)\> A promise that resolves to the modified subaccount information. ## Type Aliases ### Account ```ts type Account = object; ``` Defined in: [subaccounts/lib/types/account.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L5) Type definition representing an account, which includes properties such as `apiKey`, `name`, `createdAt`, `suspended`, `balance`, and `creditLimit`. #### Properties ##### apiKey ```ts apiKey: string; ``` Defined in: [subaccounts/lib/types/account.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L9) The API key associated with the account. ##### balance ```ts balance: number; ``` Defined in: [subaccounts/lib/types/account.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L29) The balance of the account. ##### createdAt ```ts createdAt: string; ``` Defined in: [subaccounts/lib/types/account.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L19) The creation date and time of the account. ##### creditLimit ```ts creditLimit: number; ``` Defined in: [subaccounts/lib/types/account.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L34) The credit limit of the account. ##### name ```ts name: string; ``` Defined in: [subaccounts/lib/types/account.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L14) The name of the account. ##### suspended ```ts suspended: boolean; ``` Defined in: [subaccounts/lib/types/account.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/account.ts#L24) The suspension status of the account. *** ### AccountResponse ```ts type AccountResponse = object & Omit; ``` Defined in: [subaccounts/lib/types/responses/accountResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/accountResponse.ts#L13) Type definition for the response representing an account, which includes properties such as `api_key`, `created_at`, `balance`, and `credit_limit`. This type combines properties from the account response with the properties of a subaccount (excluding specific subaccount-related properties). #### Type declaration ##### api\_key ```ts api_key: string; ``` The API key associated with the account. ##### balance ```ts balance: number; ``` The balance of the account. ##### created\_at ```ts created_at: string; ``` The creation date and time of the account. ##### credit\_limit ```ts credit_limit: number; ``` The credit limit of the account. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### BalanceTransfer ```ts type BalanceTransfer = object; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L5) Type definition representing a balance transfer, which includes properties such as `balanceTransferId`, `amount`, `from`, `to`, `reference`, and `createdAt`. #### Properties ##### amount ```ts amount: number; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L14) The amount of the balance transfer. ##### balanceTransferId ```ts balanceTransferId: string; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L9) The unique identifier for the balance transfer. ##### createdAt ```ts createdAt: string; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L34) The date and time when the balance transfer was executed. ##### from ```ts from: string; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L19) The source account from which the balance is transferred. ##### reference ```ts reference: string; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L29) A reference for the balance transfer. ##### to ```ts to: string; ``` Defined in: [subaccounts/lib/types/balanceTransfer.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/balanceTransfer.ts#L24) The destination account to which the balance is transferred. *** ### BalanceTransferListParameters ```ts type BalanceTransferListParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferListParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferListParameters.ts#L4) Type definition for parameters used to retrieve a list of balance transfers for a primary account. #### Properties ##### endDate? ```ts optional endDate: string; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferListParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferListParameters.ts#L13) The end date of the retrieval period. If absent, all transfers until now are returned. ##### startDate ```ts startDate: string; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferListParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferListParameters.ts#L8) The start date of the retrieval period. ##### subaccount? ```ts optional subaccount: string; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferListParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferListParameters.ts#L18) Subaccount to filter by. You may send this multiple times to filter on multiple subaccounts. *** ### BalanceTransferPageResponse ```ts type BalanceTransferPageResponse = object & APILinks; ``` Defined in: [subaccounts/lib/types/responses/balanceTransferPageResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/balanceTransferPageResponse.ts#L12) Type definition for the response representing a page of balance transfers, which includes an array of `balance_transfers` and APILinks. #### Type declaration ##### \_embedded ```ts _embedded: object; ``` An object containing an array of `balance_transfers`. ###### \_embedded.balance\_transfers ```ts _embedded.balance_transfers: BalanceTransferResponse[]; ``` #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### BalanceTransferParameters ```ts type BalanceTransferParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferParameters.ts#L4) Type definition for parameters used to transfer balance between accounts. #### Properties ##### amount ```ts amount: number; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferParameters.ts#L18) The amount of balance to transfer. ##### from ```ts from: string; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferParameters.ts#L8) The account ID from which the balance is transferred. ##### reference? ```ts optional reference: string; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferParameters.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferParameters.ts#L23) (Optional) A reference for the balance transfer. ##### to ```ts to: string; ``` Defined in: [subaccounts/lib/types/parameters/balanceTransferParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/balanceTransferParameters.ts#L13) The account ID to which the balance is transferred. *** ### BalanceTransferResponse ```ts type BalanceTransferResponse = object & Omit; ``` Defined in: [subaccounts/lib/types/responses/balanceTransferResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/balanceTransferResponse.ts#L12) Type definition for the response representing a balance transfer, which includes properties such as `balance_transfer_id` and `created_at`. This type combines properties from the balance transfer response with the properties of a `BalanceTransfer` (excluding specific properties). #### Type declaration ##### balance\_transfer\_id ```ts balance_transfer_id: string; ``` The unique identifier for the balance transfer. ##### created\_at ```ts created_at: string; ``` The date and time when the balance transfer was executed. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### CreditTransfer ```ts type CreditTransfer = object; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L5) Type definition representing a credit transfer, which includes properties such as `creditTransferId`, `amount`, `from`, `to`, `reference`, and `createdAt`. #### Properties ##### amount ```ts amount: number; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L14) The amount of the credit transfer. ##### createdAt ```ts createdAt: string; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:34](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L34) The date and time when the credit transfer was executed. ##### creditTransferId ```ts creditTransferId: string; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L9) The unique identifier for the credit transfer. ##### from ```ts from: string; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L19) The source account from which the credit is transferred. ##### reference ```ts reference: string; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:29](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L29) A reference for the credit transfer. ##### to ```ts to: string; ``` Defined in: [subaccounts/lib/types/creditTransfer.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/creditTransfer.ts#L24) The destination account to which the credit is transferred. *** ### CreditTransferListParameters ```ts type CreditTransferListParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferListParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferListParameters.ts#L4) Type definition for parameters used to retrieve a list of credit transfers for a primary account. #### Properties ##### endDate? ```ts optional endDate: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferListParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferListParameters.ts#L13) (Optional) The end date of the retrieval period. If absent, all transfers until now are returned. ##### startDate ```ts startDate: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferListParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferListParameters.ts#L8) The start date of the retrieval period. ##### sub? ```ts optional sub: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferListParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferListParameters.ts#L18) (Optional) Subaccount to filter by. You may send this multiple times to filter on multiple subaccounts. *** ### CreditTransferParameters ```ts type CreditTransferParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferParameters.ts#L4) Type definition for parameters used to perform a credit transfer between accounts. #### Properties ##### amount ```ts amount: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferParameters.ts#L18) The amount of credit to transfer. ##### from ```ts from: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferParameters.ts#L8) The account ID from which the credit is transferred. ##### reference? ```ts optional reference: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferParameters.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferParameters.ts#L23) (Optional) A reference for the credit transfer. ##### to ```ts to: string; ``` Defined in: [subaccounts/lib/types/parameters/creditTransferParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/creditTransferParameters.ts#L13) The account ID to which the credit is transferred. *** ### CreditTransferResponse ```ts type CreditTransferResponse = object & Omit; ``` Defined in: [subaccounts/lib/types/responses/creditTransferResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/creditTransferResponse.ts#L13) Type definition for the response representing a credit transfer, which includes properties such as `credit_transfer_id` and `created_at`. This type combines properties from the credit transfer response with the properties of a `CreditTransfer` (excluding specific properties). #### Type declaration ##### created\_at ```ts created_at: string; ``` The date and time when the credit transfer was executed. ##### credit\_transfer\_id ```ts credit_transfer_id: string; ``` The unique identifier for the credit transfer. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### CreditTransferResponsePage ```ts type CreditTransferResponsePage = object; ``` Defined in: [subaccounts/lib/types/responses/creditTransferResponsePage.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/creditTransferResponsePage.ts#L11) Type definition for the response representing a page of credit transfers, which includes an array of `credit_transfers`. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### \_embedded ```ts _embedded: object; ``` Defined in: [subaccounts/lib/types/responses/creditTransferResponsePage.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/creditTransferResponsePage.ts#L15) An object containing an array of `credit_transfers`. ###### credit\_transfers ```ts credit_transfers: CreditTransferResponse[]; ``` *** ### NumberTransfer ```ts type NumberTransfer = object; ``` Defined in: [subaccounts/lib/types/numberTransfer.ts:5](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/numberTransfer.ts#L5) Type definition representing a number transfer, which includes properties such as `number`, `country`, `from`, and `to`. #### Properties ##### country ```ts country: string; ``` Defined in: [subaccounts/lib/types/numberTransfer.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/numberTransfer.ts#L14) The two-character country code in ISO 3166-1 alpha-2 format. ##### from ```ts from: string; ``` Defined in: [subaccounts/lib/types/numberTransfer.ts:19](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/numberTransfer.ts#L19) The source account from which the number is transferred. ##### number ```ts number: string; ``` Defined in: [subaccounts/lib/types/numberTransfer.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/numberTransfer.ts#L9) The number being transferred. ##### to ```ts to: string; ``` Defined in: [subaccounts/lib/types/numberTransfer.ts:24](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/numberTransfer.ts#L24) The destination account to which the number is transferred. *** ### SubAccount ```ts type SubAccount = object & Account; ``` Defined in: [subaccounts/lib/types/subAccount.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/subAccount.ts#L8) Type definition representing a subaccount, which includes properties such as `primaryAccountApiKey` and `usePrimaryAccountBalance`, in addition to properties from the `Account` type. #### Type declaration ##### primaryAccountApiKey ```ts primaryAccountApiKey: string; ``` The API key associated with the primary account. ##### usePrimaryAccountBalance ```ts usePrimaryAccountBalance: boolean; ``` Flag indicating whether to use the primary account balance (true) or not (false). *** ### SubAccountCreateParameters ```ts type SubAccountCreateParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/subAccountCreateParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountCreateParameters.ts#L4) Type definition for parameters used to create a subaccount for a primary account. #### Properties ##### name ```ts name: string; ``` Defined in: [subaccounts/lib/types/parameters/subAccountCreateParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountCreateParameters.ts#L8) Name of the subaccount. ##### secret? ```ts optional secret: string; ``` Defined in: [subaccounts/lib/types/parameters/subAccountCreateParameters.ts:20](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountCreateParameters.ts#L20) API secret of the subaccount. - At least 8 characters and no more than 25 characters - Contains at least 1 lower-case letter - Contains at least 1 capital letter - Contains at least 1 digit - Must be unique If this parameter is not provided, a secret will be automatically generated and you can check it on the dashboard. ##### usePrimaryAccountBalance? ```ts optional usePrimaryAccountBalance: boolean; ``` Defined in: [subaccounts/lib/types/parameters/subAccountCreateParameters.ts:26](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountCreateParameters.ts#L26) Flag indicating whether to use the primary account balance (true) or not (false). Default value is true. *** ### SubAccountCreateRequest ```ts type SubAccountCreateRequest = object & Omit; ``` Defined in: [subaccounts/lib/types/requests/subAccountCreateRequest.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/requests/subAccountCreateRequest.ts#L8) Type definition for the request used to create a subaccount for a primary account. It combines the `use_primary_account_balance` property with the properties from `SubAccountCreateParameters` while omitting the `usePrimaryAccountBalance` property. #### Type declaration ##### use\_primary\_account\_balance ```ts use_primary_account_balance: boolean; ``` Flag indicating whether to use the primary account balance (true) or not (false). *** ### SubAccountModifyParameters ```ts type SubAccountModifyParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/subAccountModifyParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountModifyParameters.ts#L4) Type definition for parameters used to modify a subaccount's properties. #### Properties ##### name? ```ts optional name: string; ``` Defined in: [subaccounts/lib/types/parameters/subAccountModifyParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountModifyParameters.ts#L13) (Optional) New name for the subaccount. ##### suspended? ```ts optional suspended: boolean; ``` Defined in: [subaccounts/lib/types/parameters/subAccountModifyParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/subAccountModifyParameters.ts#L8) (Optional) Indicates whether the subaccount should be suspended (true) or not (false). *** ### SubAccountResponse ```ts type SubAccountResponse = object & AccountResponse; ``` Defined in: [subaccounts/lib/types/responses/subAccountResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/subAccountResponse.ts#L13) Type definition for the response representing a subaccount, which includes properties such as `primary_account_api_key` and `use_primary_account_balance`. This type combines properties from the subaccount response with the properties of an `AccountResponse`. #### Type declaration ##### primary\_account\_api\_key ```ts primary_account_api_key: string; ``` The API key associated with the primary account. ##### use\_primary\_account\_balance ```ts use_primary_account_balance: boolean; ``` Flag indicating whether to use the primary account balance (true) or not (false). #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### SubAccountResponsePage ```ts type SubAccountResponsePage = object & APILinks; ``` Defined in: [subaccounts/lib/types/responses/subAccountResponsePage.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/responses/subAccountResponsePage.ts#L14) Type definition for the response representing a page of subaccounts, which includes properties such as `total_balance`, `total_credit_limit`, `_embedded` with `primary_account`, `subaccounts`, and APILinks. #### Type declaration ##### \_embedded ```ts _embedded: object; ``` An object containing the primary account information and an array of `subaccounts`. ###### \_embedded.primary\_account ```ts _embedded.primary_account: AccountResponse; ``` ###### \_embedded.subaccounts ```ts _embedded.subaccounts: SubAccountResponse[]; ``` ##### total\_balance ```ts total_balance: number; ``` The total balance of the subaccounts. ##### total\_credit\_limit ```ts total_credit_limit: number; ``` The total credit limit of the subaccounts. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### TransferListParameters ```ts type TransferListParameters = object; ``` Defined in: [subaccounts/lib/types/parameters/transferListParameters.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/transferListParameters.ts#L4) Type definition for parameters used to retrieve a list of transfers for a primary account. #### Properties ##### endDate? ```ts optional endDate: string; ``` Defined in: [subaccounts/lib/types/parameters/transferListParameters.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/transferListParameters.ts#L13) (Optional) The end date of the retrieval period. If absent, all transfers until now are returned. ##### startDate ```ts startDate: string; ``` Defined in: [subaccounts/lib/types/parameters/transferListParameters.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/transferListParameters.ts#L8) The start date of the retrieval period. ##### subAccount? ```ts optional subAccount: string; ``` Defined in: [subaccounts/lib/types/parameters/transferListParameters.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/subaccounts/lib/types/parameters/transferListParameters.ts#L18) (Optional) Subaccount to filter by. You may send this multiple times to filter on multiple subaccounts.