Get Subaccounts

In this code snippet you will see how to retrieve a list of subaccounts for the parent account.

Example

Ensure the following variables are set to your required values using any convenient method:

Key	Description
`VONAGE_API_KEY`	The API key of the parent account.
`VONAGE_API_SECRET`	The API secret of the parent account.

Write the code

Add the following to get-subaccounts.sh:

curl "https://api.nexmo.com/accounts/$VONAGE_API_KEY/subaccounts" -u $VONAGE_API_KEY:$VONAGE_API_SECRET

View full source

Run your code

Save this file to your machine and run it:

bash get-subaccounts.sh

Prerequisites

npm install @vonage/subaccounts

Create a file named get-subaccounts.js and add the following code:

const { SubAccounts } = require('@vonage/subaccounts');

const subAccountClient = new SubAccounts({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

View full source

Write the code

Add the following to get-subaccounts.js:

subAccountClient.getSubAccounts()
  .then((subAccounts) => console.log(subAccounts))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node get-subaccounts.js

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Create a file named ListSubaccounts and add the following code to the main method:

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

View full source

Write the code

Add the following to the main method of the ListSubaccounts file:

val subaccounts = client.subaccounts.listSubaccounts()

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.kt.subaccounts with the package containing ListSubaccounts:

gradle run -Pmain=com.vonage.quickstart.kt.subaccounts.ListSubaccounts

Prerequisites

Add the following to build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Create a file named ListSubaccounts and add the following code to the main method:

VonageClient client = VonageClient.builder()
		.apiKey(VONAGE_API_KEY)
		.apiSecret(VONAGE_API_SECRET)
		.build();

View full source

Write the code

Add the following to the main method of the ListSubaccounts file:

ListSubaccountsResponse response = client.getSubaccountsClient().listSubaccounts();

View full source

Run your code

We can use the application plugin for Gradle to simplify the running of our application. Update your build.gradle with the following:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Run the following gradle command to execute your application, replacing com.vonage.quickstart.subaccounts with the package containing ListSubaccounts:

gradle run -Pmain=com.vonage.quickstart.subaccounts.ListSubaccounts

Prerequisites

Install-Package Vonage

Create a file named GetSubAccountsRequest.cs and add the following code:

using Vonage;
using Vonage.Request;

View full source

Add the following to GetSubAccountsRequest.cs:

var credentials = Credentials.FromApiKeyAndSecret(VONAGE_API_KEY, VONAGE_API_SECRET);
var client = new VonageClient(credentials);

View full source

Write the code

Add the following to GetSubAccountsRequest.cs:

var response = await client.SubAccountsClient.GetSubAccountsAsync();

View full source

Prerequisites

composer require vonage/client

Create a file named get-subaccounts.php and add the following code:

$basic = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client($basic);

View full source

Write the code

Add the following to get-subaccounts.php:

$subaccounts = $client->subaccount()->getSubaccounts(VONAGE_API_KEY);

View full source

Run your code

Save this file to your machine and run it:

php get-subaccounts.php

Prerequisites

pip install vonage python-dotenv

Write the code

Add the following to list-subaccounts.py:

from vonage import Auth, Vonage
from vonage_subaccounts import ListSubaccountsResponse

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

response: ListSubaccountsResponse = client.subaccounts.list_subaccounts()

print(response)

View full source

Run your code

Save this file to your machine and run it:

python subaccounts/list-subaccounts.py

Prerequisites

gem install vonage

Create a file named list-subaccounts.rb and add the following code:

client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

View full source

Write the code

Add the following to list-subaccounts.rb:

response = client.subaccounts.list

View full source

Run your code

Save this file to your machine and run it:

ruby list-subaccounts.rb

Try it out

When you run the code you will retrieve a list of subaccounts.