Units Convention

How to interpret monetary values in responses:

  • Per-commitment / per-plan endpoints (e.g. /commitments, /commitment-plans, /commitments/summary, /metrics/overview): monetary fields are monthly rates based on a 730-hour month (8760 hours / 12 months — an annual-average month, NOT a calendar month, which varies 672-744 hours). A field labeled "monthly" reflects a per-730-hour figure, not a specific calendar month's total.

  • Aggregated metrics / time-series endpoints (e.g. /metrics/daily-savings, /metrics/daily-reservable-cost, /commitments/metrics): top-level monetary fields are sums over the requested date range, and values in daily rows are sums for that day. Neither is a monthly rate; magnitude scales with range length.

  • commitment_upfront_cost (top-level on individual commitments, plans, and plan line items — a sibling of commitment_financials_monthly_rate): one-time total dollars paid at signing — not a rate. Do not sum with monthly-rate fields. Omitted on aggregates (summary, metrics, invoices) where a summed upfront is not meaningful.

Last updated

Was this helpful?