nexmo.com

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 documentati

🔑 basic 9 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (9 total)

verify-javascript-sdk ✓ Official

npm install verify-javascript-sdk

GitHub integration →

verify-android-sdk ✓ Official

# Maven: see https://github.com/Nexmo/verify-android-sdk

GitHub integration →

react-native-nexmo-verify

# Maven: see https://github.com/artechsio/react-native-nexmo-verify

GitHub integration →

vonage-php-nexmo-bridge ✓ Official

composer require vonage-php-nexmo-bridge

GitHub integration →

verify-ios-sdk ✓ Official

# See https://github.com/Nexmo/verify-ios-sdk

GitHub integration →

client-sdk-voice-app-to-phone-flutter ✓ Official

# Maven: see https://github.com/nexmo-community/client-sdk-voice-app-to-phone-flutter

GitHub integration →

stitch-js-quickstart ✓ Official

# See https://github.com/Nexmo/stitch-js-quickstart

GitHub integration →

server-sdk-specification ✓ Official

# See https://github.com/Nexmo/server-sdk-specification

GitHub integration →

client-sdk-tutorials ✓ Official

# See https://github.com/nexmo-community/client-sdk-tutorials

GitHub integration →

curl examples

Retrieve list of subaccounts

curl \
  -u "$API_USER:$API_PASS" \
  https://api.nexmo.com/accounts/{api_key}/subaccounts

Retrieve list of credit transfers

curl \
  -u "$API_USER:$API_PASS" \
  https://api.nexmo.com/accounts/{api_key}/credit-transfers

Retrieve list of balance transfers

curl \
  -u "$API_USER:$API_PASS" \
  https://api.nexmo.com/accounts/{api_key}/balance-transfers

Endpoints (9 total)

GET

/{api_key}/subaccounts

Retrieve list of subaccounts

GET

/{api_key}/credit-transfers

Retrieve list of credit transfers

GET

/{api_key}/balance-transfers

Retrieve list of balance transfers

GET

/{api_key}/subaccounts/{subaccount_key}

Retrieve a subaccount

POST

/{api_key}/subaccounts

Create subaccount

POST

/{api_key}/transfer-number

Transfer number

POST

/{api_key}/credit-transfers

Transfer credit

POST

/{api_key}/balance-transfers

Transfer balance

PATCH

/{api_key}/subaccounts/{subaccount_key}

Modify a subaccount