billing

Changed on

Get overage credit usage for the current billing period.

get/orgs/{org_id}/billing/overage

Request

  • Base URL
    https://api.timbal.ai
  • URL
    https://api.timbal.ai/orgs/{org_id}/billing/overage
  • Auth
    HTTP bearer

Path parameters

org_idstring required

Response

Overage usage summary

cap_creditsinteger nullable

Org-configured ceiling on overage credits for the period. null means unlimited (or no cap configured); only meaningful when enabled.

enabledboolean required

Whether usage-based overage billing is currently enabled for the org.

invoiced_creditsinteger required

Overage credits already included on a finalized invoice this period.

pending_creditsinteger required

Overage credits accrued this period that have not been invoiced yet.

period_endstring date-time nullable

End of the current credits period — when pending overage bills if no interim invoice fires first. null when there is no metered window.

period_startstring date-time nullable

Start of the current credits period. null when the org has no metered billing window (e.g. free plan with no period anchor).

rate_cents_per_1kinteger nullable

Metered overage rate in cents per 1,000 credits. null when overage pricing is unavailable for the plan.

threshold_usdinteger nullable

Outstanding overage value (whole USD) that triggers an interim invoice. null means overage bills only at the end of the period.

used_creditsinteger required

Total overage credits consumed this period (invoiced + pending).

Changes