getAiCreditUsage

Why the AI employees stopped, and what AI use costs: burn over a trailing window (windowDays 1..90, default 30), balanceCredits, outOfCredits, planAllowance. THIS IS THE ONLY OPERATION THAT REPORTS THE AI PAYWALL. outOfCredits: true is a CONFIRMED paywall. outOfCredits: false is NOT proof the agents are running: the flag is deliberately narrower than the predicate that actually refuses work (AiAgentBillingGateService.isOutOfCredits), which omits its usage-history condition. TREAT balanceCredits <= 0 AS THE STOP-CONDITION and outOfCredits as the confirmation. lowOnCredits warns (still working); give lowCreditThresholdCredits. balanceCredits can be NEGATIVE, normally. COST: creditsConsumed is window burn, never a bill. planAllowance is this period: usedThisPeriod of includedCredits is in the plan; past it, or in a trial (lockedDuringTrial), use draws purchasedBalance (bought or granted). 1 credit = 1 cent of AI cost. What used them: aiCreditUsageBySource; name causes only from it. To buy: getCreditsPurchaseUrl.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operationId": "getAiCreditUsage",
    "variables": {}
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.billing.getAiCreditUsage({})

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    operationId: 'getAiCreditUsage',
    variables: {}
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

windowDaysInt

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "subscriptionQuery": {
      "aiCreditUsage": {
        "windowDays": 0,
        "creditsConsumed": 0,
        "balanceCredits": 0,
        "outOfCredits": true,
        "lowOnCredits": true,
        "lowCreditThresholdCredits": 0,
        "planAllowance": {
          "includedCredits": 0,
          "usedThisPeriod": 0,
          "includedRemaining": 0,
          "purchasedBalance": 0,
          "lockedDuringTrial": true,
          "periodResetsAt": "2026-01-01T00:00:00.000Z"
        }
      },
      "aiCreditUsageBySource": {
        "windowDays": 0,
        "sources": [
          {
            "label": "…",
            "credits": 0
          }
        ]
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

Behaviour

A read. It rejects an Idempotency-Key header with 400 bad_request.

Variables

Response

Errors

Behaviour

Related