Nexmo

Subaccounts API

The Subaccounts API enables you to create subaccounts under your primary account. Subaccounts facilitate differential product configuration, reporting, and…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 9

Subaccount Management

  • GETRetrieve list of subaccounts/:api_key/subaccountsGet the information of all the subaccounts owned by the primary account.
  • POSTCreate subaccount/:api_key/subaccountsCreate a subaccount for a given primary account.
  • GETRetrieve a subaccount/:api_key/subaccounts/:subaccount_keyGet the information of a subaccount specified with its API key.
  • PATCHModify a subaccount/:api_key/subaccounts/:subaccount_keyChange one or more properties of a subaccount.

Transfers

  • GETRetrieve list of balance transfers/:api_key/balance-transfers?start_date=2019-07-15T13:11:44Z&end_date=2019-07-15T14:11:44Z&subaccount=stringRetrieve a list of balance transfers that have taken place for a primary account within a specified time period.
  • POSTTransfer balance/:api_key/balance-transfersTransfer balance between a primary account and one of its subaccounts. Note that balance_available_for_transfer = |account_balance - credit_limit| of the…
  • GETRetrieve list of credit transfers/:api_key/credit-transfers?start_date=2019-07-15T13:11:44Z&end_date=2019-07-15T14:11:44Z&subaccount=stringRetrieve a list of credit transfers that have taken place for a primary account within a specified time period.
  • POSTTransfer credit/:api_key/credit-transfersTransfer credit limit between a primary account and one of its subaccounts.
  • POSTTransfer number/:api_key/transfer-numberTransfer number from one account to another.

API details

Base URL
https://api.nexmo.com/accounts
Authentication
HTTP Basic authentication (username and password)
Operations
9 operations on 5 pathsGET 4POST 4PATCH 1
Main resources
Transfers 5Subaccount Management 4
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.8
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Subaccounts API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Subaccounts API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve list of subaccounts” (GET /:api_key/subaccounts), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Subaccounts API?

The Subaccounts API enables you to create subaccounts under your primary account. Subaccounts facilitate differential product configuration, reporting, and… It is listed under Other and has 9 endpoints.

Who publishes the Subaccounts API?

It is listed from Nexmo's public API description (an OpenAPI document), not published by Nexmo on Swastik Codes. Anyone who controls nexmo.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Subaccounts API?

Requests go to https://api.nexmo.com/accounts. Endpoint paths are added to this base URL.

How do I authenticate with the Subaccounts API?

With HTTP Basic authentication (username and password).

How many endpoints does the Subaccounts API have?

9 operations on 5 paths (4 GET, 4 POST, 1 PATCH). The largest groups are Transfers, Subaccount Management.

Is forking the Subaccounts API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.