GET
Get Credits

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

topup
string<uuid> | null

A top-up to report the payment processor's own status for.

Response

Successful Response

This region's balance for the workspace, what it buys, and top-up prices.

Per region, because the balance is a data-plane table. A caller reading this is reading the balance of whichever region's API they called, and the dashboard labels it with that region's name — a bare number is what makes a customer with $50 in one region and $0 in another think the money vanished.

balance
number
required
currency
string
default:USD
required
Allowed value: "USD"
low_balance_threshold
number
required
packs
CreditPackResponse · object[]
required
topup_status
enum<string> | null
required
Available options:
pending,
paid,
failed,
cancelled,
refunded
video_minutes_remaining
integer
required
voice_minutes_remaining
integer
required