Docs / Reference / read: usage statement

read: usage statement.

A period to the tenant's usage of the period by kind, priced, against the plan

Figure 1POST /v1/read/usage_statementspecified

The caller sends UsageStatementInput to /v1/read/usage_statement. The platform returns a card whose body is UsageStatement.

POST/v1/read/usage_statement

Read the usage statement. The call needs the tenant rung under a token with the read grant, and it is served by the platform.

The route takes UsageStatementInput and returns a card whose body is UsageStatement.

Request body#

The request body is UsageStatementInput.

field	type	required	note
`period`	Window	yes

Response#

The route returns a card whose body is UsageStatement. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`Scale-As-True-On`	no	the date the facts must have been true on; defaults to now
`Scale-As-Known-On`	no	the date the facts must have been known on; defaults to now
`Scale-Key`	no	for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the tenant rung and a token with the read grant. The platform serves this route.

Example#

The example sends the smallest body that UsageStatementInput allows. The build validates it against the schema of UsageStatementInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/read/usage_statement \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "period": { "from": "…", "to": "…" } }'

import { client } from "@scale/sdk";
const answer = await client.read.usage_statement({
    "period": {
      "from": "…",
      "to": "…"
    }
  });
// answer.body is a UsageStatement. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/usage_statement",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "period": {
        "from": "…",
        "to": "…"
      }
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/usage_statement")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&UsageStatementInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.read.usage_statement takes the same input and returns the same card. The tool only reads data. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/UsageStatement. The tool’s page describes it.

POST /v1/read/usage_statement
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "period": {
    "from": "…",
    "to": "…"
  }
}

Without a key, this page shows the request only. The request body is UsageStatementInput, and the route returns a card whose body is UsageStatement.

Claims#

claim	state	route or tool
The platform serves the route /v1/read/usage_statement at contract 0476e35e6e275db5.	target	`/v1/read/usage_statement`