Get account balance

Returns the current account balance and credit grant summary for the authenticated API key's account.

GET
/public/v1/balance

Authorization

AuthorizationBearer <token>

Use an Atlas Cloud API key in the form Authorization: Bearer apikey-....

In: header

Response Body

curl -X GET "https://api.atlascloud.ai/public/v1/balance"
{
  "object": "balance",
  "scope": "account",
  "account": {
    "id": "acc_123",
    "name": "Production",
    "type": "team"
  },
  "available": {
    "value": "125.500000",
    "currency": "usd"
  },
  "cash": {
    "value": "100.000000",
    "currency": "usd"
  },
  "bonus": {
    "value": "25.500000",
    "currency": "usd"
  },
  "subscription_bonus": {
    "value": "0.000000",
    "currency": "usd"
  },
  "frozen": {
    "value": "0.000000",
    "currency": "usd"
  },
  "credit_grant": {
    "status": "active",
    "granted": {
      "value": "0.000000",
      "currency": "usd"
    },
    "used": {
      "value": "0.000000",
      "currency": "usd"
    },
    "remaining_overdraft": {
      "value": "0.000000",
      "currency": "usd"
    },
    "overdrawn": {
      "value": "0.000000",
      "currency": "usd"
    }
  },
  "request_id": "req_123"
}
{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "string",
    "param": "string"
  },
  "request_id": "string"
}
{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "string",
    "param": "string"
  },
  "request_id": "string"
}
{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "string",
    "param": "string"
  },
  "request_id": "string"
}
{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "string",
    "param": "string"
  },
  "request_id": "string"
}