Skip to main content
GET
Get the payer's credit balance
Returns the payer’s credit pools: minutes (with the schedule of grants that expire, including minutes that end with the subscription), free lip-sync minutes and project credits. The workspace owner pays for all work in the workspace, and all workspaces of one owner share these pools. When to use: to check funds before spending. For the price of one action, call its estimate operation: it also reports balance_after. Side effects: None. Cost: Free. Idempotency: safe and pure (never writes); retry freely. Required scopes: account:read

Authorizations

Authorization
string
header
required

API key from Settings -> API keys, sent as Authorization: Bearer <key> (SDK environment variable RASK_API_KEY). Bound to one workspace and one acting user. Operations list the scopes they need (OpenAPI 3.1 scopes on a bearer scheme).

Scopes

account:read

Response

OK: Balance.

The payer's credit pools. All workspaces of one owner share them.

object
enum<string>
required

Always balance.

Available options:
balance
workspace_id
string
required

Workspace id.

payer
object
required

The payer of the workspace.

minutes
object
required

Minute pool.

lipsync_free_minutes
object
required

Free lip-sync pool.

projects
object
required

Project-credit pool; counts projects, not minutes.

as_of
string<date-time>
required

Read time.