Read the organization's balance

The organization’s funds and monthly limits, shared by every member and project. A new generation’s quote must fit within availableMicroUsd.

Needs the account:read scope.

GET /balance

Read the organization's balance

cURL

curl --request GET \
  --url https://api.zerogen.com/v1/balance \
  --header 'Authorization: Bearer <token>'

200

{
  "currency": "USD",
  "balanceMicroUsd": 0,
  "heldMicroUsd": 4503599627370495,
  "availableMicroUsd": 0,
  "unlimited": true,
  "limits": {
    "organizationMonthly": {
      "limitMicroUsd": 4503599627370495,
      "spentMicroUsd": 0,
      "enforced": true
    },
    "projectMonthly": {
      "limitMicroUsd": 4503599627370495,
      "spentMicroUsd": 0
    }
  }
}

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

200

application/json

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

Show child attributes