Get account balance - DGrid AI Docs

curl -sS -i "https://api.dgrid.ai/v1/management/balance" \
  -H "Authorization: Bearer $DGRID_MANAGEMENT_KEY"

{
  "code": 200,
  "message": "ok",
  "data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "balance": "123.45678912",
    "subscriptionBalance": "100.00000000",
    "rechargeBalance": "23.45678912",
    "currency": "USD",
    "planName": "Pro"
  }
}

curl -sS -i "https://api.dgrid.ai/v1/management/balance" \
  -H "Authorization: Bearer $DGRID_MANAGEMENT_KEY"

{
  "code": 200,
  "message": "ok",
  "data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "balance": "123.45678912",
    "subscriptionBalance": "100.00000000",
    "rechargeBalance": "23.45678912",
    "currency": "USD",
    "planName": "Pro"
  }
}

Retrieve the balance of the account associated with your Management API Key. Use this endpoint to distinguish total balance, available subscription balance, and recharge balance.

Authenticate with a Management API Key, rather than a Model API Key. Auto Deposit and deposit balance alerts use rechargeBalance, which excludes subscription balance.

Endpoint

GET https://api.dgrid.ai/v1/management/balance

Property	Value
Authentication	`Authorization: Bearer <DGRID_MANAGEMENT_KEY>`
Query parameters	None
Response	`application/json`

Request example

Set DGRID_MANAGEMENT_KEY to your Management API Key.

curl -sS -i "https://api.dgrid.ai/v1/management/balance" \
  -H "Authorization: Bearer $DGRID_MANAGEMENT_KEY"

Response

{
  "code": 200,
  "message": "ok",
  "data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "balance": "123.45678912",
    "subscriptionBalance": "100.00000000",
    "rechargeBalance": "23.45678912",
    "currency": "USD",
    "planName": "Pro"
  }
}

Response fields

Field	Type	Description
`userId`	string	Account ID associated with the Management API Key.
`balance`	string	Total balance: `subscriptionBalance + rechargeBalance`.
`subscriptionBalance`	string	Available subscription balance; zero when none is available.
`rechargeBalance`	string	Recharge balance, exactly `balance - subscriptionBalance`.
`currency`	string	Currency of the amounts; currently `USD`.
`planName`	string	Subscription plan name; an empty string when no name is available.

Amount precision

All amounts are decimal strings to preserve precision. Do not assume a fixed number of decimal places; use a decimal numeric type for calculations. Total and recharge balances can be negative. Display the returned values without clamping them to zero. See Auto Deposit for automatic funding and Notifications for balance alerts.