GET

Customer billing

Get usage

/api/v2/billing/usage

AUTHENTICATIONBearer token · billing:readService ownerbilling-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Return aggregate metered credit usage, pending events, and reconciliation counters for the authenticated workspace's active billing period.

When to use it

Call this to reconcile metered credit consumption and pending events for the active billing period before reporting usage, investigating drift, or making an availability decision.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to discover usage.
Lets clients distinguish commercial catalog terms, available credits, metered events, pending reconciliation, subscription state, and financial settlement before presenting spend or availability.

ISOLATION + AUTHORITY

Workspace, product, price, currency, credit grant, allowance, credit pool, subscription, usage event, pending event, invoice, payment, and settlement authorities remain distinct. A displayed balance or product does not reserve credits, purchase service, move money, settle an invoice, or authorize another domain action.

BEFORE YOU CALL

Authenticate at the documented boundary: bearer+scope.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Resolve the authenticated workspace, active billing period, product or subscription context, currency precision, credit-pool order, and pending reconciliation posture.

WHAT TO DO NEXT

Reconcile consumed and pending events with the same workspace, billing period, and subscription before reporting remaining availability.
Investigate nonzero reconciliation counters or stale pending events through the owning metering workflow rather than adjusting totals locally.

AGENT GUIDANCE

Use usage only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Use the live OpenAPI schema as the authority for the exact request shape and response model.
Preserve credit quantities and minor-unit prices exactly; distinguish granted, available, committed, consumed, pending, expired, reconciled, invoiced, paid, and settled states.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

AuthorizationheaderRequired

Bearer tokenCredential containing the billing:read scope.EXAMPLEBearer hc_live_…

RESPONSES

Status and payload examples

200Current billing-period usage totals and ingest-time reconciliation posture.Read completed · JSON RESPONSE+

{
  "period": {
    "started_at": "2026-08-01T00:00:00Z",
    "ends_at": "2026-09-01T00:00:00Z"
  },
  "rated_usage_credits": "125",
  "usage_events": 25,
  "pending_usage_events": 0,
  "reconciliation": {
    "mode": "INGEST_TIME",
    "checked": 25,
    "posted": 25,
    "pending": 0
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then reconcile consumed and pending events with the same workspace, billing period, and subscription before reporting remaining availability.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the billing account, subscription and entitlement versions, usage period, and invoice or provider reference before another billing-dependent action.

401The bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+

{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing, expired, or invalid."
}

INTEGRATION DECISIONinvalid_credentials

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. Do not replay an expired signature.
STATE RECONCILIATION: Authentication failed before an authoritative read was returned for workspace billing account, subscription, entitlement, invoice summary, and usage projections.
ESCALATE WHEN: Escalate when entitlement, subscription, invoice, usage, or provider evidence remains inconsistent after a fresh Core billing read.

403The credential lacks billing:read.Authority or policy denied · JSON RESPONSE+

{
  "code": "insufficient_scope",
  "message": "The credential lacks billing:read."
}

INTEGRATION DECISIONinsufficient_scope

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for workspace billing account, subscription, entitlement, invoice summary, and usage projections.
ESCALATE WHEN: Escalate when entitlement, subscription, invoice, usage, or provider evidence remains inconsistent after a fresh Core billing read.

503The authoritative Core billing projection is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "billing_unavailable",
  "message": "The authoritative Core billing projection is unavailable."
}

INTEGRATION DECISIONbilling_unavailable

CALLER ACTION: Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY: Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
STATE RECONCILIATION: Refresh the billing account, subscription and entitlement versions, usage period, and invoice or provider reference before another billing-dependent action.
ESCALATE WHEN: Escalate when entitlement, subscription, invoice, usage, or provider evidence remains inconsistent after a fresh Core billing read.

OPERATIONAL NOTES

Security and lifecycle guarantees

Use this compact projection for usage dashboards, budget checks, and agent guardrails without downloading the full account or ledger.
rated_usage_credits is a decimal string; event and reconciliation fields are integer counts. The period uses RFC 3339 timestamps.
reconciliation reports metering ingestion and posting posture. It is not an invoice, payment, balance-transfer, or external-settlement receipt.
The endpoint exposes no individual usage-event payloads, processor identifiers, workspace UUIDs, or administrative data. No query parameters or request body are accepted; responses are no-store.

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory