billing

Billing summary

Return balances and the current-period draft invoice.

get/v2/billing/summary

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

force_refreshboolean

Response

Successful Response

tier'payg' | 'postpaid' | 'enterprise' | 'legacy' required

Stuut-owned commercial policy; only PAYG is balance-gated.

spendstring decimal required

GROSS spend this period — every metered (USAGE) line summed, BEFORE any credit/commit coverage; consumption regardless of who pays. Scheduled fees excluded.

uncovered_totalstring decimal required

Usage net of applied credits (USAGE + CREDIT lines summed; scheduled fees excluded) — ~$0 while funds cover everything, the uncovered remainder once they run out.

net_balancestring decimal required

The spendable position. balances.prepaid.balance while there's one; once that's exhausted (PAYG only), the overdraw as a NEGATIVE amount — Metronome clamps instrument balances at 0, so uncovered usage exists only on the draft (uncovered_total, negated here so overdrawn reads below zero).

Changes

No recorded changes to this operation across all 1 revision of this API.