UsageRefreshResult

Experimental

usage/refresh result (experimental, ADR 32563 D6): the same usage member as usage/read after ONE fresh read, plus the mint’s tier display name. A sibling method, not a usage/read param: a stable method cannot reference an experimental params type, so a param would change the stable surface.

Fields and variants

• subscriptionActive — Experimental
• tierName — Experimental
• usage — Experimental

Source

schema/msp/experimental/msp.schema.json#/types/UsageRefreshResult

{
  "description": "`usage/refresh` result (experimental, ADR 32563 D6): the same `usage`\nmember as `usage/read` after ONE fresh read, plus the mint's tier display\nname. A sibling method, not a `usage/read` param: a stable method cannot\nreference an experimental params type, so a param would change the\nstable surface.",
  "properties": {
    "subscriptionActive": {
      "description": "Whether the refresh mint stamped an active subscription. With `usage`\nomitted, `false` is a login with no subscription (pay-as-you-go or\nnone) and `true` is a subscriber whose mint carried no usage object,\nwhich a client reports as \"no usage data\", never as no allowance\n(ADR 32563 D6 item 6).",
      "type": "boolean"
    },
    "tierName": {
      "description": "The subscription tier's display name from the refresh mint, when it\nreturned one. Clients print this, never `usage.tier`.",
      "type": "string"
    },
    "usage": {
      "$ref": "#/$defs/SubscriptionUsage",
      "description": "The observation after the refresh, when one exists."
    }
  },
  "type": "object",
  "x-msp-descriptor": "usage/refresh",
  "x-msp-stability": "experimental"
}