usage_estimates

What it shows

Current usage totals per contract right and usage period: quantity, tier position, gross estimate, credit drawn, accrued, billed, difference and late usage. Cursor pages read maintained totals; from/until select periods starting in that window. unbilledEstimates and pending unmatched lines have independent cursors. An unknown contract is not_found; an existing contract on a store without usage tables is empty.

Example MCP App view

The read-only example below uses illustrative demo data and the same report component as the MCP App. These are not your books or the result of the request example.

Open the full example view.

Inputs

Send the fixed kind and these parameters at the top level of the report request, not inside input.

Required means required within its containing object; an optional parent can be omitted.

Field	Type	Required	Meaning and accepted values
`contract_id`	string	Yes	Resolved activity-contract subject ID. Example: `"ctr_example"`.
`from`	string	No	Start date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day. A calendar date means midnight UTC at its start; an explicit timestamp keeps the stated instant. Format: moment.
`until`	string	No	End date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day, so September ends at 2026-09-30; a timestamp includes everything before that moment. A calendar date includes the whole UTC day (exclusive cutoff); an explicit timestamp keeps the stated instant. Format: moment.
`limit`	integer	No	Maximum rows per page, up to 100 (default 100). Minimum: `1`. Maximum: `100`.
`after`	string	No	Opaque nextCursor from the preceding report page with the same filters.
`unbilled_after`	string	No	unbilledNextCursor from the preceding page’s unbilled estimates.
`unmatched_after`	string	No	unmatchedNextCursor from the preceding page’s unmatched invoice lines.

Reading the result

Running this report does not change the books. Its description above distinguishes recorded-book summaries from previews based on supplied facts or assumptions. Interpret its totals, grouping, missing-data indicators and pagination using that description. Monetary amounts are integer strings in the reported unit; ratios and assumptions can be fractional numbers. An empty result is not evidence that the business had no activity.

The public OpenAPI contract does not enumerate this report’s result fields. Fetch GET /v1/reports for its live description and parameters, and inspect the returned JSON rather than assuming an output shape.

Example request

{
  "kind": "usage_estimates",
  "contract_id": "ctr_example"
}

All reports · Operation and errors · Reusable schemas

Keep credentials out of prompts; rehearse writes only in a disposable sandbox.

Exact request schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "kind": {
      "const": "usage_estimates"
    },
    "contract_id": {
      "description": "Resolved activity-contract subject ID.",
      "type": "string",
      "minLength": 1
    },
    "from": {
      "description": "Start date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day.",
      "type": "string",
      "minLength": 1
    },
    "until": {
      "description": "End date (YYYY-MM-DD) or UTC timestamp (RFC 3339). A date is a UTC day and includes that whole day, so September ends at 2026-09-30; a timestamp includes everything before that moment.",
      "type": "string",
      "minLength": 1
    },
    "limit": {
      "description": "Maximum rows per page, up to 100 (default 100).",
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "after": {
      "description": "Opaque nextCursor from the preceding report page with the same filters.",
      "type": "string",
      "minLength": 1
    },
    "unbilled_after": {
      "description": "unbilledNextCursor from the preceding page's unbilled estimates.",
      "type": "string",
      "minLength": 1
    },
    "unmatched_after": {
      "description": "unmatchedNextCursor from the preceding page's unmatched invoice lines.",
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "kind",
    "contract_id"
  ]
}