MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Account

Get account balance

Read your organization's wallet: the remaining balance, the minutes it buys at your rates, your plan, your concurrency headroom, and whether auto-recharge will refill it.

GET/account/balance
No parameters needed for GET /account/balance. Press Run.
curl -X GET 'https://omnidim.io/api/v1/account/balance' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{
  "success": true,
  "organization": {
    "id": 14,
    "name": "Demo Organization"
  },
  "balance": {
    "amount": 42.5137,
    "currency": "USD"
  },
  "estimated_minutes_remaining": 212.6,
  "rates_per_minute_usd": 0.2,
  "plan": {
    "id": 3,
    "name": "Growth",
    "billing_interval": "Monthly",
    "is_usage_based": false,
    "subscription_status": "active",
    "renews_at": "2026-10-15T09:31:00Z"
  },
  "concurrency": {
    "limit": 10,
    "in_use": 2,
    "available": 8
  },
  "auto_recharge": {
    "enabled": true,
    "threshold_usd": 5,
    "amount_usd": 20
  }
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Response body

application/json

Response Body

The account's wallet and the limits around it.

application/json

Your organization's wallet: what is left, what it buys, and the limits around it. Every money figure marked USD is USD, because that is the currency the balance and all platform rates are held in.

success?boolean

Always true on a 200.

organization?
balance?
estimated_minutes_remaining?number

How many minutes of conversation the balance buys at rates_per_minute_usd. An estimate at today's rate; rates can change.

It counts the voice-AI rate only. The rate used is the highest your calls can bill at, so for web calls the real figure is this or better. Phone calls also pay telephony out of the same balance, so for phone calls the real figure is lower.

null means no rate is set for your organization, so no honest estimate exists. Treat it as unknown rather than as zero or unlimited. 0 means the balance buys nothing, which is also the answer when the balance is negative.

rates_per_minute_usd?number

A single rate, not a basic/premium pair: the highest voice-AI rate per minute your calls can bill at, in USD. A call bills at your premium rate whenever the agent uses a premium model for its language, speech-to-text or text-to-speech, which varies per agent. Reporting the higher of the two means estimated_minutes_remaining never overstates your voice-AI minutes. Telephony is not included.

outbound_telephony_per_minute_usd?number

Present only when your account has a negotiated telephony rate. When it is absent, telephony is billed at the live carrier rate for the destination, which varies by country and is not one number.

plan?
concurrency?

Simultaneous calls. available is your real headroom: where a further ceiling applies to your account, it is already accounted for, so you never need to combine this with anything else.

auto_recharge?

Whether a low balance will top itself up. Never includes the saved instrument.

Was this page helpful?

Generate test scenarios

Write test scenarios for an agent from its prompt. Each scenario has a name, the steps the simulated caller follows, and how the agent should respond. Nothing is saved: pass the ones you want to `createSimulation`.

List child organizations

List all child organizations and their users under the reseller account. Returns each organization's balance, cost-per-minute rate, and concurrency limit, plus the dashboard menu access flags scoped to your reseller's permissions for every user.