Rhythm 2.0 Specifications

Appearance

CAP-PFM-LLM-017Show administrators their organization’s AI allowance

Markdown

CAP-PFM-LLM-017

Show administrators their organization’s AI allowance

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationPartially observed

Planning

Feature
FEAT-PFM-LLM-06
Exercised by
FAS-PFM-LLM-06-01, FAS-PFM-LLM-06-02, FAS-PFM-LLM-06-03, FAS-PFM-LLM-06-04, FAS-PFM-LLM-06-05
Key concepts
CON-PFM-LLM-003, CON-PFM-LLM-004
Actors
ACT-PFM-007
Journeys
JNY-PFM-LLM-004
Depends on
CAP-PFM-LLM-007, CAP-PFM-LLM-013
Related
CAP-PFM-LLM-018
Open questions
OQ-PFM-LLM-001
Proved by
ATS-PFM-LLM-017

Implementation

Executable suites
TST-PFM-LLM-006, TST-PFM-LLM-013, TST-PFM-LLM-051, TST-PFM-LLM-083, TST-PFM-LLM-084

KindCapabilityProduct areaPlatformModuleAI Requests, Usage and the Jazz AI TeammateRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Show administrators their organization’s AI allowance ​

Purpose ​

Give customer administrators a credit-based view of their own usage without disclosing internal commercial details.

How It Works ​

An administrator uses the organization-scoped usage service to read its current allowance position. The summary combines charged and held credits with remaining capacity and the reset date. It also groups usage by feature and supplies recent monthly history. Feature availability explains disabled AI or exhausted capacity. The current feature-list implementation omits active operation exemptions and can disagree with admission. Queries expose the organization’s request and task reporting data under the same usage authority. Internal money, model and control details stay out of the customer summary. The product should deliver the approved dashboard and resolve its availability mismatch before asking customers to rely on it.

Relationships ​

  • Admit AI work against the organization’s monthly allowance supplies the prerequisite behavior for this outcome.
  • Set an organization’s AI access and recurring limits supplies the prerequisite behavior for this outcome.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
The summary describes the organization’s credit position.Availability entries explain feature restrictions.Organization-scoped datasets support request and task reporting.
Surfaces
consoleapi
Constraints
The summary services and reporting datasets exist; the planned customer page is absent.
Intent sources
services-platform:docs/proposals/llm-observability/11-decisions.md#D-2services-platform:docs/proposals/llm-observability/11-decisions.md#D-7services-platform:docs/milestones/PLAT-M3-ai-usage-organization-page.md#D-2 (proposal)

Controls

20 controls apply, from the corpus control catalogue.

TC-AVL-001 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-003 TC-PI-005 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.llm-usage.readapitenant

Business Rules

9 rules, 9 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
The customer usage routes admit only console users in the organization with its usage key, excluding unkeyed, anonymous, foreign-customer and HQ-only callers.
proved by ATS-PFM-LLM-017-01, TST-PFM-LLM-006
permissionapitest
services-platform:modules/llm/tests/e2e/llm-adjustments-and-organization.e2e.spec.js#is refused to Rhythm staff holding every HQ key, because the routes are console
02must prove
Proposed
The summary contains the current allowance, charged-plus-held usage, remaining credits, percentage, within or warned or limited status, local reset date and zone, AI switch, explanatory messages, six-month history and usage by feature.
proved by ATS-PFM-LLM-007-19, ATS-PFM-LLM-017-02, ATS-PFM-LLM-017-11, TST-PFM-LLM-051
calculationserviceobserved
services-platform:modules/llm/services/usage/organization-usage.ts
03must prove
Proposed
Customer usage summaries expose credits and percentages while withholding money, providers, models, prices, capacity grants and internal limits.
origin: services-platform:docs/proposals/llm-observability/11-decisions.md#D-7
proved by ATS-PFM-LLM-017-03, ATS-PFM-LLM-017-12, TST-PFM-LLM-006, TST-PFM-LLM-083
policyservice, apitest
services-platform:modules/llm/tests/e2e/llm-adjustments-and-organization.e2e.spec.js#carries no key naming money, a provider, a model, an override or a limit on the summary
04must prove
Proposed
The feature list supplies labels, descriptions and availability; disabled AI or all disabled operations takes explanatory precedence over exhausted allowance.
proved by ATS-PFM-LLM-013-11, ATS-PFM-LLM-017-04, ATS-PFM-LLM-017-13, TST-PFM-LLM-006, TST-PFM-LLM-051, TST-PFM-LLM-084
policyserviceobserved
services-platform:modules/llm/services/usage/organization-usage.ts
05must prove
Proposed
Active exemptions are ignored by the customer feature list, so it can label an operation restricted even though admission permits its request.
proved by ATS-PFM-LLM-017-05
policyserviceobserved
services-platform:modules/llm/services/usage/organization-usage.ts:restrictionOf
06must prove
Proposed
Declared operations group under their catalog feature and undeclared historical operations group under Other AI features.
proved by ATS-PFM-LLM-017-06, TST-PFM-LLM-051
calculationserviceobserved
services-platform:modules/llm/services/usage/organization-usage.ts
07must prove
Proposed
Customer usage reads stay within the organization’s own periods.
proved by ATS-PFM-LLM-017-07, TST-PFM-LLM-051
invariantservice, databasetest
services-platform:modules/llm/tests/integration/services/usage/organization-usage.integration.spec.js#does not read another organization’s period
08must prove
Proposed
The usage key also supports local request and task query recipes by period, feature, person and problem outcome; reporting excludes content, storage, refusal snapshots, raw usage and pricing versions and uses UTC reporting dates.
proved by ATS-PFM-LLM-017-08, TST-PFM-LLM-013
permissiondatabase, servicetest
services-platform:modules/llm/tests/integration/db/llm-invocations-query.view.integration.spec.js#offers none of the evidence, payload, refusal, usage or version columns
09must prove
Proposed
The product should provide the approved dashboard with credits, reset date, feature states, six-month history, pause explanation and request-history navigation without internal money, model or control detail.
origin: services-platform:docs/proposals/llm-observability/11-decisions.md#D-2
proved by ATS-PFM-LLM-017-09
policyconsoledocumented
services-platform:docs/milestones/PLAT-M3-ai-usage-organization-page.md#Scope in one paragraph

Scenarios

IdGivenWhenThenProvenance
01The organization is near its allowance threshold.An administrator requests its summary.The response includes the credit position, warning status, local reset date and descending history.test
services-platform:modules/llm/tests/integration/services/usage/organization-usage.integration.spec.js#resets on the first of next month in the organization’s own calendar
02Rhythm disables the query operation.An administrator requests feature availability.The query feature carries the corresponding restriction explanation.test
services-platform:modules/llm/tests/integration/services/usage/organization-usage.integration.spec.js#restricts the feature, with the sentence, once its operation is turned off for the organization

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software