Get your current account balance

You can check the balance of your Vonage account at any time by making an API request and receiving the balance of your account in the response.

Key	Description
`VONAGE_API_KEY`	Your Vonage API key (see it on your dashboard).
`VONAGE_API_SECRET`	Your Vonage API secret (also available on your dashboard).

Write the code

Add the following to account-balance.sh:

curl "https://rest.nexmo.com/account/get-balance" -u "$VONAGE_API_KEY:$VONAGE_API_SECRET"

View full source

Run your code

Save this file to your machine and run it:

bash account-balance.sh

Prerequisites

npm install @vonage/server-sdk

Create a file named account-balance.js and add the following code:

const { Vonage } = require('@vonage/server-sdk');

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
});

View full source

Write the code

Add the following to account-balance.js:

vonage.accounts.getBalance()
  .then((resp) => {
    console.log(`${resp.value.toFixed(2)} EUR`);
  })
  .catch((error) => console.error(error));

View full source

Run your code

Save this file to your machine and run it:

node account-balance.js

Prerequisites

Add the following to build.gradle:

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

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

val balance = client.account.getBalance()
println("Balance: €${balance.value}")

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.account with the package containing GetBalance:

gradle run -Pmain=com.vonage.quickstart.kt.account.GetBalance

Prerequisites

Add the following to build.gradle:

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

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

BalanceResponse response = client.getAccountClient().getBalance();
System.out.printf("Balance: %s EUR\n", response.getValue());
System.out.printf("Auto-reload Enabled: %s\n", response.isAutoReload());

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.account with the package containing GetBalance:

gradle run -Pmain=com.vonage.quickstart.account.GetBalance

Prerequisites

Install-Package Vonage

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

using Vonage;
using Vonage.Request;
using System;

View full source

Add the following to GetBalance.cs:

var response = await client.AccountClient.GetAccountBalanceAsync();

View full source

Write the code

Add the following to GetBalance.cs:

Console.WriteLine($"Current Account Balance: {response.Value}");

View full source

Prerequisites

composer require vonage/client

Create a file named account-balance.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 account-balance.php:

$response = $client->account()->getBalance();
echo round($response->getBalance(), 2) . " EUR\n";

View full source

Run your code

Save this file to your machine and run it:

php account-balance.php

Prerequisites

pip install vonage python-dotenv

Write the code

Add the following to get-balance.py:

from vonage import Auth, Vonage
from vonage_account import Balance

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

balance: Balance = client.account.get_balance()

print(f'{balance.value:0.2f} EUR, auto-reload: {balance.auto_reload}')

View full source

Run your code

Save this file to your machine and run it:

python account/get-balance.py

Prerequisites

gem install vonage

Create a file named get-balance.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 get-balance.rb:

response = client.account.balance

View full source

Run your code

Save this file to your machine and run it:

ruby get-balance.rb

The example will output the current balance of your account in Euro.