billing
team

Billing Usage

Return billing usage summary for current user.

Optional ?breakdown=1 query (METER-04): include the per-action rollup that powers the Usage page's "where did my credits go?" section. Identical shape to /api/billing/usage/breakdown items.

get/api/billing/usage

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/billing/usage
  • Auth: none declared

Query parameters

breakdowninteger

If 1, include per-action 30-day breakdown in breakdown field. Saves a round-trip vs calling /api/billing/usage/breakdown. METER-04 (UX_audit_2026_05_10).

Response

Successful Response

tierstring required
usageinteger required
limitinteger required
tier_displaystring nullable
overageinteger nullable
capnumber nullable
spentnumber nullable
cap_reachedboolean nullable
period_startstring nullable
period_endstring nullable
billing_periodstring nullable
billing_modestring nullable
credit_balancenumber nullable
trial_endstring nullable
authenticatedboolean nullable
breakdownobject[] nullable
dunningobject nullable
effective_tierstring nullable
consumer_tierstring nullable
agent_planstring nullable

Changes

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