List brand rated outcomes

Rated outcomes for the brand.

GET /v1/brands/{brand_id}/billing/rated-outcomes

cURL

curl --request GET \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/billing/rated-outcomes' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "outcome_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billing_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "provider": "string",
      "outcome_type": "string",
      "occurred_at": "2026-08-31T14:22:05Z",
      "rating_kind": "string",
      "currency": "USD",
      "quantity": 2,
      "included_quantity": 1,
      "committed_quantity": 1,
      "overage_quantity": 1,
      "unit_amount_minor": 4900,
      "committed_unit_amount_minor": 4900,
      "subtotal_minor": 4900,
      "savings_minor": 1,
      "commitment_applied": true,
      "rated_at": "2026-08-31T14:22:05Z",
      "metadata": {},
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "total": 102,
  "limit": 20,
  "offset": 1
}

Path parameters

brand_id · string (uuid) · required

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

brand_id · string (uuid) · required

outcome_id · string (uuid) · required

billing_profile_id · string (uuid)

contract_id · string (uuid)

period_id · string (uuid)

provider · string · required

outcome_type · string · required

occurred_at · string (date-time) · required

rating_kind · string · required

currency · string · required

quantity · integer · required

included_quantity · integer · required

committed_quantity · integer · required

overage_quantity · integer · required

unit_amount_minor · integer · required

committed_unit_amount_minor · integer

subtotal_minor · integer · required

savings_minor · integer · required

commitment_applied · boolean · required

rated_at · string (date-time) · required

metadata · object · required

created_at · string (date-time) · required

updated_at · string (date-time) · required

total · integer · required

limit · integer · required

offset · integer · required

Status codes

Code	Meaning
200	Rated outcomes for the 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/brands/{brand_id}/billing/rated-outcomes' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "outcome_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "billing_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "period_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "provider": "string",
      "outcome_type": "string",
      "occurred_at": "2026-08-31T14:22:05Z",
      "rating_kind": "string",
      "currency": "USD",
      "quantity": 2,
      "included_quantity": 1,
      "committed_quantity": 1,
      "overage_quantity": 1,
      "unit_amount_minor": 4900,
      "committed_unit_amount_minor": 4900,
      "subtotal_minor": 4900,
      "savings_minor": 1,
      "commitment_applied": true,
      "rated_at": "2026-08-31T14:22:05Z",
      "metadata": {},
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "total": 102,
  "limit": 20,
  "offset": 1
}