Subaccounts API

nexmo · Company

Company No Auth Free & Open API

The Subaccounts API enables you to create subaccounts under your primary account. Subaccounts facilitate differential product configuration, reporting, and billing. The Subaccounts API is released initially with restricted availability. You can read more about the API in the [Subaccounts documentation](/account/subaccounts/overview).

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Retrieve list of balance transfers

Retrieve a list of balance transfers that have taken place for a primary account within a specified time period.

https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers?end_date=2024-12-31&start_date=2024-01-01&subaccount=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers?end_date=2024-12-31&start_date=2024-01-01&subaccount=example"

import requests
params = {
    "end_date": "2024-12-31",
    "start_date": "2024-01-01",
    "subaccount": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers');
url.searchParams.set('end_date', '2024-12-31');
url.searchParams.set('start_date', '2024-01-01');
url.searchParams.set('subaccount', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers")
	q := baseURL.Query()
	q.Set("end_date", "2024-12-31")
	q.Set("start_date", "2024-01-01")
	q.Set("subaccount", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers")
uri.query = URI.encode_www_form({
  "end_date" => "2024-12-31",
  "start_date" => "2024-01-01",
  "subaccount" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/balance-transfers?" . http_build_query([
    "end_date" => "2024-12-31",
    "start_date" => "2024-01-01",
    "subaccount" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve list of credit transfers

Retrieve a list of credit transfers that have taken place for a primary account within a specified time period.

https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers?end_date=2024-12-31&start_date=2024-01-01&subaccount=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers?end_date=2024-12-31&start_date=2024-01-01&subaccount=example"

import requests
params = {
    "end_date": "2024-12-31",
    "start_date": "2024-01-01",
    "subaccount": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers');
url.searchParams.set('end_date', '2024-12-31');
url.searchParams.set('start_date', '2024-01-01');
url.searchParams.set('subaccount', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers")
	q := baseURL.Query()
	q.Set("end_date", "2024-12-31")
	q.Set("start_date", "2024-01-01")
	q.Set("subaccount", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers")
uri.query = URI.encode_www_form({
  "end_date" => "2024-12-31",
  "start_date" => "2024-01-01",
  "subaccount" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/credit-transfers?" . http_build_query([
    "end_date" => "2024-12-31",
    "start_date" => "2024-01-01",
    "subaccount" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Retrieve list of subaccounts

Get the information of all the subaccounts owned by the primary account.

https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/nexmo.com/subaccounts/1.0.8/{api_key}/subaccounts";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Subaccounts API?

Subaccounts API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Subaccounts API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗