Skip to main content

Glossary

Realm​

Project boundary. All data is isolated by realm. Every request includes X-Realm-Id.

Billing account​

Payor/account boundary for billing details, invoices, payments, subscriptions, checkout, portal, contracts, and account administration. Identified by billing_account_id.

Billing user​

Runtime subject for usage, grants, wallet balance, limits, events, and self-service reports under a billing account. Identified internally by billing_user_id.

Principal​

Your billing principal identifier (principal_id). Typically an org, team, or customer id.

User​

Your runtime user identifier (user_id) under a principal. Runtime service calls provide it with principal_id.

Service key​

Server-to-server credentials for /mgt/v1. Consists of service_key_id and service_key_secret.

Bearer token​

Short-lived access token used by end-user clients to call /api/v1 endpoints.

Feature​

What is being used. Identified by feature_code.

Feature Family​

Optional stable grouping for selling tiers. Identified by feature_family_code.

Meter​

Unit of measurement for usage. Identified by meter_code.

Quantity (minor units)​

Integer usage value in the smallest unit you choose (for example, token count). Passed as a string in APIs.

Idempotency key​

Idempotency-Key header used to safely retry write requests.

Hint​

Machine-readable signal returned by APIs to indicate risk, enforcement conditions, or pricing state.