Usage and spend

Current-period usage, included allowances and cap state of an organization

Totals come from the usage ledger (hourly, finalized after the lateness window); measurement.measured_through says how far usage is complete. Billable units are whole units (floor per workspace-hour); allowance usage counts billable units. allowance_exhausted true means new opens/resumes answer 402 allowance_exhausted with exhausted_reason as details.reason. spend_cap is opt-in overage this period: while it is on, a CPU-hours or RAM GiB-hours allowance past included is in cap state overage (starts admitted, usage past it charged) until the spend cap is reached.

get/v1/organizations/{organization_id}/usage/summary

Request

  • Base URL: https://api.shardflux.dev
  • URL: https://api.shardflux.dev/v1/organizations/{organization_id}/usage/summary
  • Auth: HTTP bearer

Path parameters

organization_idstring uuid required

UUIDv7, lowercase canonical form.

Response

Default Response

organization_idstring uuid required

UUIDv7, lowercase canonical form.

allowance_exhaustedboolean required
alert_thresholdsinteger[] required

Changes

No recorded changes to this operation across all 1 revision of this API.