> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get account and credit balances

> Get your account identity, effective plan, included and purchased minute balances, text-to-speech character balance, and the permissions of this connection.

Get your account identity, effective plan, included and purchased minute balances, text-to-speech character balance, and the permissions of this connection.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/account_get
```

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `account:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

Send an empty JSON object. This action has no input fields.

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```json theme={null}
  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }
  ```
</Accordion>

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/account_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{}'
  ```

  ```javascript JavaScript theme={null}
  const input = {};
  const response = await fetch('https://api.voicecheap.ai/v1/actions/account_get', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/account_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Returns the caller’s public profile, effective plan, active workspace, available media credits, connection permissions, and translation limits.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "userId": "user_123",
      "email": "developer@example.com",
      "displayName": "Studio owner",
      "companyName": "Studio",
      "plan": "pro",
      "workspace": {
        "ownerUserId": "user_123",
        "teamId": null,
        "isTeamMember": false
      },
      "credits": {
        "availableMinutes": 150,
        "includedMinutes": 120,
        "purchasedMinutes": 30,
        "textToSpeech": {
          "limit": 4000000,
          "used": 125000,
          "remaining": 3925000,
          "includedRemaining": 3875000,
          "purchasedRemaining": 50000,
          "resetsAt": 1793491200000
        }
      },
      "permissions": {
        "scopes": [
          "account:read"
        ],
        "canManageOwnTeam": false,
        "canEditSharedSettings": true
      },
      "limits": {
        "maxConcurrentTranslations": 5,
        "accessToLipSyncPro": false
      }
    }
  }
  ```
</ResponseExample>

## Result fields

| Field | Description |
| - | - |
| `data.userId` | Authenticated account identifier. |
| `data.email` | Authenticated account email address. |
| `data.displayName` | Authenticated account display name. |
| `data.companyName` | Saved company name, or null. |
| `data.plan` | Effective plan used by this connection. |
| `data.workspace.ownerUserId` | Account that owns the projects and minute credits in the active workspace. |
| `data.workspace.teamId` | Active team identifier, or null for a personal workspace. |
| `data.workspace.isTeamMember` | Whether this connection acts in a team owner’s workspace as a member. |
| `data.credits.availableMinutes` | Total available whole minutes, including purchased credits. |
| `data.credits.includedMinutes` | Available whole minutes from the included balance. |
| `data.credits.purchasedMinutes` | Available whole minutes from purchased minute credits. |
| `data.credits.textToSpeech.limit` | Included text-to-speech character allowance for the current allowance period. |
| `data.credits.textToSpeech.used` | Included text-to-speech characters used in the current period. |
| `data.credits.textToSpeech.remaining` | Available included plus purchased text-to-speech characters. |
| `data.credits.textToSpeech.includedRemaining` | Available included text-to-speech characters. |
| `data.credits.textToSpeech.purchasedRemaining` | Available purchased text-to-speech characters. |
| `data.credits.textToSpeech.resetsAt` | Current text-to-speech allowance period end in milliseconds, or null when no period is active. |
| `data.permissions.scopes` | Permissions granted to this API key or MCP connection. |
| `data.permissions.canManageOwnTeam` | Whether the authenticated account already owns a team. |
| `data.permissions.canEditSharedSettings` | Whether the caller may edit workspace vocabulary and account translation instructions. |
| `data.limits.maxConcurrentTranslations` | Effective concurrent translation allowance. |
| `data.limits.accessToLipSyncPro` | Whether this connection’s effective account has access to Pro lip sync. |

## Operation notes

* Minute credits belong to the active personal or team workspace. Text-to-speech history and character credits belong to the authenticated account.
* Text-to-speech allowance periods last 30 days from the first generation after the previous period ended; their reset is independent of calendar-month integration calls.
* This action does not return saved API keys, webhook signing secrets, or external account credentials.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | The JSON object contains an unsupported field, an invalid value, or a missing required argument. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | The account’s current team membership does not match this connection’s workspace. Refresh the membership and reconnect. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `ACCOUNT_NOT_FOUND` | The account or active workspace account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["account:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.