Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required

Response

Overage usage summary

Customer-facing overage usage summary for the current credits period.

used_credits = invoiced_credits + pending_credits. invoiced_credits is the real metered overage billed on finalized invoices this period (see [overage_summary]); pending_credits is the headline "extra usage you'll be billed for" number, and a non-zero invoiced_credits means an interim (threshold-driven) invoice has already billed part of this period.

enabled
boolean
required

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

invoiced_credits
integer<int64>
required

Overage credits already included on a finalized invoice this period.

pending_credits
integer<int64>
required

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

used_credits
integer<int64>
required

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

cap_credits
integer<int64> | null

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

period_end
string<date-time> | null

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

period_start
string<date-time> | null

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_1k
integer<int64> | null

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

threshold_usd
integer<int64> | null

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