Skip to main content
GET
Get Usage Estimate
Beta. This is an estimate of what past traffic would cost on the published credit schedule — not a bill, an invoice, or a commitment. The response shape may still change.

Overview

Prices the authenticated organization’s recorded API traffic at the published credit schedule and shows which plan that traffic lands on. Use it to answer “what would last month have cost” before anything is charged. Requests recorded before the credit cutover carry the old placeholder weights, so they are re-priced from their route; requests recorded after it already carry credits and are reported at face value. Traffic the launch beta gives away is metered at its full list price and reported separately under credits.beta_free, so credits.charged is always what you would actually pay. plan_for, packs_needed and offer are derived from credits.per_month — the window scaled to 30 days — so a two-day window and a quarter recommend comparable plans rather than plans two sizes apart. Defaults to the last 30 days. Requires the billing:read scope. Querying the estimate is not billed.

Query Parameters

string
Start of the window (YYYY-MM-DD). Must be provided together with to. Omit both for the last 30 days.
string
End of the window (YYYY-MM-DD), inclusive. Must be provided together with from, may not be in the future, and the window may not exceed 92 days. Today is accepted; the window then ends at the moment you ask, so the projection divides only by time that has elapsed.

Response

string
Always "usage_estimate".
object
integer
Version of the credit schedule used to price the window.
object
object
object[]
object[]
object | null
object | null
boolean
true when the projected month is beyond what the plan ladder plus top-up packs sells; plan_for is then null and the right next step is a conversation.
object | null
object
string
Request ID for debugging.

Code Examples

Errors