Nexmo Subaccounts API
Browse all Nexmo APIs44
AI ReadinessFoundational (D)44/100
Agent-ready OpenAPI document · curated by JenticCommunicationsSms Messagingbasic9 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Create child subaccounts under a primary Vonage account, list and update their settings, and move balance, credit, or virtual numbers between accounts.
Use for: I need to create a subaccount for a new client tenant, List every subaccount under my primary Vonage account, Transfer 100 EUR of balance from my primary account to a subaccount, Move a virtual number from one subaccount to another
Not supported: Does not send messages, place calls, or run identity verification - use for primary-account subaccount lifecycle, balance and credit transfers, and number reassignment only.
Jentic publishes the only available OpenAPI specification for Subaccounts API, keeping it validated and agent-ready. The Vonage Subaccounts API lets a primary Vonage account create and manage child subaccounts with isolated configuration, reporting, and billing. The 9 endpoints cover subaccount CRUD, balance and credit transfers between primary and subaccount, and number transfers so a virtual number can be reassigned from one subaccount to another. The API is currently released with restricted availability - primary accounts must be enabled by Vonage before the endpoints will respond.
Install Jentic One Beta
Connect the Subaccounts API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Subaccounts API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fsubaccounts-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fsubaccounts-api" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Subaccounts API.
Provision a new subaccount under a primary Vonage account with a chosen name and use_primary_account_balance flag
List all subaccounts on the primary account and fetch a single subaccount by its API key
Suspend, reactivate, or rename an existing subaccount via PATCH on the subaccount resource
Transfer prepaid balance between the primary account and any of its subaccounts for budget control
Move postpaid credit limits between primary and subaccount through dedicated credit-transfer endpoints
Reassign a Vonage virtual number from one subaccount to another with a single transfer-number call
List historical balance and credit transfers for audit and reconciliation against billing exports
Use Cases
Patterns agents use Subaccounts API for, with concrete tasks.
★ Multi-Tenant Reseller Provisioning
Resellers and platforms that resell Vonage capacity create one subaccount per end-customer so usage and billing remain isolated. POST /{api_key}/subaccounts provisions the new account, GET /{api_key}/subaccounts lists existing tenants, and PATCH supports renaming or suspending. Each subaccount has its own API key, allowing per-tenant credential rotation without touching the primary account.
POST /{api_key}/subaccounts with name='ClientCorp' and use_primary_account_balance=false to provision a budget-isolated subaccount, then capture the returned api_key for the new tenant
Budget Top-Up and Cost Control
Move prepaid balance or postpaid credit between the primary account and individual subaccounts to enforce budgets without waiting for end-of-month reconciliation. POST /{api_key}/balance-transfers shifts prepaid funds, POST /{api_key}/credit-transfers shifts credit limits, and the matching GET endpoints provide a transfer history for audit. Pair with the Subaccounts PATCH endpoint to suspend a tenant whose budget has been exhausted.
POST /{api_key}/balance-transfers with amount=100, currency=EUR, from=primary, and to=<subaccount_api_key> to move funds, then GET /{api_key}/balance-transfers to confirm the entry was logged
Number Portfolio Reassignment
Move a purchased Vonage virtual number from one subaccount to another when a customer churns, renames, or merges. POST /{api_key}/transfer-number takes the number and target subaccount and reassigns it without releasing and repurchasing. The previous subaccount immediately stops billing for the number and the new one takes over inbound configuration.
POST /{api_key}/transfer-number with number=+447700900100, country=GB, and to=<target_subaccount_api_key> to reassign the number to the new tenant
AI Agent Tenant Operations
Through Jentic, an AI agent provisions subaccounts and rebalances funds without holding the primary Vonage credentials. The agent searches Jentic with the intent 'create a Vonage subaccount', loads the POST /{api_key}/subaccounts schema, and executes with structured arguments. Balance transfers and number transfers can be chained as additional Jentic calls, with primary-account Basic auth resolved from your Jentic One instance.
Use Jentic search query 'create a Vonage subaccount' to load POST /{api_key}/subaccounts, execute with name and use_primary_account_balance, then chain a balance-transfer call to seed the new tenant
Key Endpoints
9 endpoints — jentic publishes the only available openapi specification for subaccounts api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/{api_key}/subaccounts
List all subaccounts under the primary account
POST
/{api_key}/subaccounts
Create a new subaccount
GET
/{api_key}/subaccounts/{subaccount_key}
Retrieve a single subaccount
PATCH
/{api_key}/subaccounts/{subaccount_key}
Modify a subaccount's name or status
POST
/{api_key}/balance-transfers
Transfer prepaid balance between accounts
POST
/{api_key}/credit-transfers
Transfer credit limit between accounts
POST
/{api_key}/transfer-number
Reassign a virtual number to another subaccount
GET
/{api_key}/subaccounts
List all subaccounts under the primary account
POST
/{api_key}/subaccounts
Create a new subaccount
GET
/{api_key}/subaccounts/{subaccount_key}
Retrieve a single subaccount
PATCH
/{api_key}/subaccounts/{subaccount_key}
Modify a subaccount's name or status
POST
/{api_key}/balance-transfers
Transfer prepaid balance between accounts
POST
/{api_key}/credit-transfers
Transfer credit limit between accounts
POST
/{api_key}/transfer-number
Reassign a virtual number to another subaccount
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
S
Subaccounts API
- Foundational (D)44/100
90
Foundational Compliance74
Developer Experience & Jentic Compatibility74
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
90
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
60%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
74
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
48%
Example Density
How richly the API is illustrated with examples.
97%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
74
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: A-Signals: 4
42%
Description Coverage
Coverage of descriptions across API elements.
89%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
64%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Vonage Subaccounts API by hand means encoding your primary account key and secret as HTTP Basic and building account, balance-transfer, credit-transfer, and number-reassignment calls against api.nexmo.com/accounts yourself. Through Jentic you install once, import the Subaccounts API from the API Directory, store the key and secret once, and your agent calls it.
Permission scoping
The Subaccounts API puts the subaccount key in the URL path (/{api_key}/subaccounts/{subaccount_key}), so a rule can pin your agent to reading and updating one subaccount. You choose the operations it may call, so balance and credit transfers or number reassignment are not included unless you add them.
Credential isolation
Your primary account's Vonage key and secret are stored once, encrypted, by your own Jentic One instance and assembled into the Basic auth header at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a Vonage subaccount' or 'transfer Vonage balance' and Jentic returns the matching operation with its input schema so the agent populates the request without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Subaccounts API through Jentic.
Why is there no official OpenAPI spec for Subaccounts API?
Vonage does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Subaccounts API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Vonage Subaccounts API use?
Subaccounts uses HTTP Basic auth with the primary account's API key and secret. Subaccount-specific operations are still called from the primary credentials and reference the subaccount via the subaccount_key path parameter. Jentic stores the Basic auth pair in your Jentic One instance and injects it at execution time.
How do I create a subaccount through the Vonage API?
Call POST /{api_key}/subaccounts with the primary account's api_key in the path and a JSON body containing name and use_primary_account_balance. The response includes the new subaccount's api_key and api_secret, which become the credentials for that tenant's traffic.
Can I move a virtual number from one Vonage subaccount to another?
Yes. POST /{api_key}/transfer-number with the number, country, and target subaccount key reassigns the number in place without releasing it. Inbound configuration follows the new subaccount immediately and billing on the old subaccount stops.
Is the Vonage Subaccounts API generally available?
Vonage notes that the Subaccounts API is released with restricted availability - primary accounts have to be enabled for subaccounts before the 9 endpoints will respond with anything other than an authorization error. Contact Vonage account management to opt in before integrating.
How do I provision a Vonage subaccount through Jentic?
Run pip install jentic, then use the Jentic search query 'create a Vonage subaccount' to load POST /{api_key}/subaccounts. Execute with a name and use_primary_account_balance flag, then chain POST /{api_key}/balance-transfers to seed the new tenant. Run it through Jentic One, the self-hosted execution layer.
Can I limit what my agent is allowed to do with the Vonage Subaccounts API?
Yes. Because you run Jentic One yourself, your own rules decide which Subaccounts operations and credentials the agent may use. Since the subaccount key sits in the URL path (/{api_key}/subaccounts/{subaccount_key}), you can pin the agent to reading and updating a single subaccount. You choose the operations it can call, so balance transfers, credit transfers, and number reassignment stay unavailable to the agent unless you explicitly grant them.
GET STARTED