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

Authentication and permissions

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.
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.
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.

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.

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.

Result fields

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