Get Subaccount

In this code snippet you will see how to retrieve details of a subaccount.

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.
`SUBACCOUNT_KEY`	The API key of the subaccount you want to retrieve the details of.

Write the code

Add the following to create-getaccount.sh:

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

View full source

Run your code

Save this file to your machine and run it:

bash get-subaccount.sh

Prerequisites

npm install @vonage/subaccounts

Create a file named get-subaccount.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-subaccount.js:

subAccountClient.getSubAccount(SUBACCOUNT_KEY)
  .then((subAccount) => console.log(subAccount))
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node get-subaccount.js

Prerequisites

Add the following to build.gradle:

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

Create a file named GetSubaccount 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 GetSubaccount file:

val subaccount = client.subaccounts.subaccount(SUBACCOUNT_KEY).get()

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 GetSubaccount:

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

Prerequisites

Add the following to build.gradle:

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

Create a file named GetSubaccount 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 GetSubaccount file:

Account subaccount = client.getSubaccountsClient().getSubaccount(SUBACCOUNT_KEY);

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 GetSubaccount:

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

Prerequisites

Install-Package Vonage

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

using Vonage;
using Vonage.Request;

View full source

Add the following to GetSubAccountRequest.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 GetSubAccountRequest.cs:

var request = Vonage.SubAccounts.GetSubAccount.GetSubAccountRequest.Parse(SUBACCOUNT_KEY);
var response = await client.SubAccountsClient.GetSubAccountAsync(request);

View full source

Prerequisites

composer require vonage/client

Create a file named get-subaccount.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-subaccount.php:

$subaccount = $client->subaccount()->getSubaccount(VONAGE_API_KEY, SUBACCOUNT_KEY);

View full source

Run your code

Save this file to your machine and run it:

php get-subaccount.php

Prerequisites

pip install vonage python-dotenv

Write the code

Add the following to get-subaccount.py:

from vonage import Auth, Vonage
from vonage_subaccounts import Subaccount

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

subaccount: Subaccount = client.subaccounts.get_subaccount(SUBACCOUNT_KEY)

print(subaccount)

View full source

Run your code

Save this file to your machine and run it:

python subaccounts/get-subaccount.py

Prerequisites

gem install vonage

Create a file named find-subaccount.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 find-subaccount.rb:

response = client.subaccounts.find(subaccount_key: SUBACCOUNT_KEY)

View full source

Run your code

Save this file to your machine and run it:

ruby find-subaccount.rb

Try it out

When you run the code you will retrieve the details of the specified subaccount.