List fleet billing periods

Billing contract periods across every visible brand.

GET /v1/fleet/billing/periods

cURL

curl --request GET \
  --url 'https://api.workstream.stateset.com/v1/fleet/billing/periods' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_slug": "acme-outdoors",
      "brand_display_name": "string",
      "contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "period_start": "2026-08-31T14:22:05Z",
      "period_end": "2026-08-31T14:22:05Z",
      "status": "pending",
      "currency": "USD",
      "commitment_fee_minor": 4900,
      "included_quantity": 1,
      "consumed_quantity": 1,
      "covered_quantity": 1,
      "overage_quantity": 1,
      "estimated_overage_minor": 1,
      "estimated_savings_minor": 1,
      "amount_minor": 4900,
      "outcome_count": 1,
      "billable_count": 1,
      "closed_at": "2026-08-31T14:22:05Z",
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "total": 102,
  "limit": 20,
  "offset": 1,
  "count": 2
}

Query parameters

limit · integer

Max items (capped at 1000).

offset · integer

status · string

Filter by status.

Response

object

items · object[] · required

Show items

id · string (uuid) · required

tenant_id · string (uuid) · required

brand_id · string (uuid) · required

brand_slug · string · required

brand_display_name · string · required

contract_id · string (uuid) · required

period_start · string (date-time) · required

period_end · string (date-time) · required

status · string · required

currency · string · required

commitment_fee_minor · integer · required

included_quantity · integer · required

consumed_quantity · integer · required

covered_quantity · integer · required

overage_quantity · integer · required

estimated_overage_minor · integer · required

estimated_savings_minor · integer · required

amount_minor · integer · required

outcome_count · integer · required

billable_count · integer · required

closed_at · string (date-time)

created_at · string (date-time) · required

updated_at · string (date-time) · required

total · integer · required

limit · integer · required

offset · integer · required

count · integer · required

Status codes

Code	Meaning
200	Billing contract periods across every visible brand.
400	Validation error
401	Unauthorized
404	Not found
429	Rate limited
500	Internal error

cURL

curl --request GET \
  --url 'https://api.workstream.stateset.com/v1/fleet/billing/periods' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_slug": "acme-outdoors",
      "brand_display_name": "string",
      "contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "period_start": "2026-08-31T14:22:05Z",
      "period_end": "2026-08-31T14:22:05Z",
      "status": "pending",
      "currency": "USD",
      "commitment_fee_minor": 4900,
      "included_quantity": 1,
      "consumed_quantity": 1,
      "covered_quantity": 1,
      "overage_quantity": 1,
      "estimated_overage_minor": 1,
      "estimated_savings_minor": 1,
      "amount_minor": 4900,
      "outcome_count": 1,
      "billable_count": 1,
      "closed_at": "2026-08-31T14:22:05Z",
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "total": 102,
  "limit": 20,
  "offset": 1,
  "count": 2
}