Suspend a Subaccount

In this code snippet you will see how to suspend 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 to be suspended.

Write the code

Add the following to suspend-subaccount.sh:

curl -X "PATCH" "https://api.nexmo.com/accounts/$VONAGE_API_KEY/subaccounts/$SUBACCOUNT_KEY" -u $VONAGE_API_KEY:$VONAGE_API_SECRET \
     -H "Content-Type: application/json"  \
     -d $'{"suspended":true}'

View full source

Run your code

Save this file to your machine and run it:

bash suspend-subaccount.sh

Prerequisites

npm install @vonage/subaccounts

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

subAccountClient.updateSubAccount(
  SUBACCOUNT_KEY,
  { suspended: true },
)
  .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 suspend-subaccount.js

Prerequisites

Add the following to build.gradle:

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

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

val subaccount = client.subaccounts.subaccount(SUBACCOUNT_KEY).suspended(true)

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

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

Prerequisites

Add the following to build.gradle:

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

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

Account subaccount = client.getSubaccountsClient().updateSubaccount(
		UpdateSubaccountRequest.builder(SUBACCOUNT_KEY).suspended(true).build()
);

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

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

Prerequisites

Install-Package Vonage

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

using Vonage;
using Vonage.Request;
using Vonage.SubAccounts.UpdateSubAccount;

View full source

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

var request = UpdateSubAccountRequest.Build().WithSubAccountKey(SUBACCOUNT_KEY)
    .SuspendAccount()
    .Create();
var response = await client.SubAccountsClient.UpdateSubAccountAsync(request);

View full source

Prerequisites

composer require vonage/client

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

$account = new \Vonage\Subaccount\SubaccountObjects\Account();
$account->setSuspended(true);

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

View full source

Run your code

Save this file to your machine and run it:

php suspend-subaccount.php

Prerequisites

pip install vonage python-dotenv

Write the code

Add the following to suspend-subaccount.py:

from vonage import Auth, Vonage
from vonage_subaccounts import ModifySubaccountOptions, Subaccount

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

response: Subaccount = client.subaccounts.modify_subaccount(
    subaccount_api_key=SUBACCOUNT_KEY,
    options=ModifySubaccountOptions(suspended=True),
)

print(response)

View full source

Run your code

Save this file to your machine and run it:

python subaccounts/suspend-subaccount.py

Prerequisites

gem install vonage

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

client.subaccounts.update(
  subaccount_key: SUBACCOUNT_KEY,
  suspended: true
)

View full source

Run your code

Save this file to your machine and run it:

ruby suspend-subaccount.rb

Try it out

When you run the code you will suspend the specified subaccount of the parent account.