Skip to main content
GET
Read the organization's balance

Authorizations

Authorization
string
header
required

A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.

Query Parameters

projectId
string

Also report this project's monthly budget

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response

The organization's balance.

currency
string
required
Allowed value: "USD"
balanceMicroUsd
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
heldMicroUsd
integer | null
required

Reserved for generations that have not settled; a hold is not a charge

Required range: 0 <= x <= 9007199254740991
availableMicroUsd
integer
required

What a new generation's quote must fit within; it can be negative

Required range: -9007199254740991 <= x <= 9007199254740991
unlimited
boolean
required

The funds check is bypassed; usage is still charged

limits
object
required