Get Enterprise Balance
/enterprise/v1/billing/balanceRead the authenticated enterprise account balance and credit. No user/tenant selector is accepted.
Authentication
Use Authorization: Bearer <MANAGEMENT_KEY> with tenant:billing:read. Inference keys, PROVISIONING keys and JWT sessions are not accepted. The authenticated owner must still hold enterprise-owner privileges.
Enterprise API guide · Get enterprise balance
Postpaid funding semantics
All amounts are USD. Under POSTPAY, positive wallet top-up funds are spent first and the remainder uses enterprise credit. Promotional Credit/vouchers are neither spent nor included in the total.
credit_limit_usd: approved credit limit.current_exposure_usd: credit used in the current open billing period.credit_remaining_usd:max(credit_limit_usd - current_exposure_usd, 0).credit_available: remaining enterprise credit under POSTPAY; available vouchers under PREPAY. These meanings are different.total_spendable:max(wallet_available, 0) + credit_remaining_usdfor POSTPAY; the existingwallet_available + credit_availablefor PREPAY.
Historical unpaid invoices are not deducted from remaining credit a second time. Balances are snapshots of recorded billing data, not real-time reservations. Exhausted credit, key limits, account spend protection or other policies can still reject requests. Exhausted credit blocks new POSTPAY calls even if wallet funds remain, so the total is not a guarantee of callable capacity.
Success uses code: 200 with snake_case fields in data; error envelope fields use serviceCode / traceId. Responses include Cache-Control: no-store. Missing scope yields API_KEY_SCOPE_DENIED; wrong credential types receive no data.
Response
codeinteger200 on success
dataobjectdata.currencystringCurrency: usd
data.payment_modestringPREPAY or POSTPAY
data.wallet_availablenumberAvailable wallet balance, possibly negative
data.wallet_frozennumberFrozen wallet balance
data.credit_availablenumberPREPAY vouchers; POSTPAY remaining credit
data.credit_limit_usdnumberCredit limit; 0 for PREPAY
data.credit_remaining_usdnumberRemaining credit; 0 for PREPAY
data.current_exposure_usdnumberOpen-period credit usage; 0 for PREPAY
data.total_spendablenumberAccount total according to payment mode
data.checked_atstringUTC ISO-8601 observation time