Get brand billing contract

The brand’s billing contract, or null when none is configured.

GET /v1/brands/{brand_id}/billing/contract

cURL

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

200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billing_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": "string",
  "contract_type": "string",
  "status": "pending",
  "currency": "USD",
  "period": "string",
  "display_name": "Ada Lovelace",
  "commitment_label": "string",
  "commitment_fee_minor": 4900,
  "default_unit_amount_minor": 4900,
  "included_quantity": 1,
  "starts_at": "2026-08-31T14:22:05Z",
  "ends_at": "2026-08-31T14:22:05Z",
  "metadata": {},
  "rates": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "outcome_type": "string",
      "display_name": "Ada Lovelace",
      "unit_amount_minor": 4900,
      "included_quantity": 1,
      "committed_unit_amount_minor": 4900,
      "metadata": {},
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "created_at": "2026-08-31T14:22:05Z",
  "updated_at": "2026-08-31T14:22:05Z"
}

Path parameters

brand_id · string (uuid) · required

Response

object

id · string (uuid) · required

brand_id · string (uuid) · required

tenant_id · string (uuid) · required

billing_profile_id · string (uuid)

provider · string · required

contract_type · string · required

status · string · required

currency · string · required

period · string · required

display_name · string · required

commitment_label · string · required

commitment_fee_minor · integer · required

default_unit_amount_minor · integer · required

included_quantity · integer · required

starts_at · string (date-time)

ends_at · string (date-time)

metadata · object · required

rates · object[] · required

Show rates

id · string (uuid) · required

contract_id · string (uuid) · required

outcome_type · string · required

display_name · string

unit_amount_minor · integer · required

included_quantity · integer · required

committed_unit_amount_minor · integer

metadata · object · required

created_at · string (date-time) · required

updated_at · string (date-time) · required

created_at · string (date-time) · required

updated_at · string (date-time) · required

Status codes

Code	Meaning
200	The brand’s billing contract, or null when none is configured.
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/contract' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"

200

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "brand_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenant_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "billing_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "provider": "string",
  "contract_type": "string",
  "status": "pending",
  "currency": "USD",
  "period": "string",
  "display_name": "Ada Lovelace",
  "commitment_label": "string",
  "commitment_fee_minor": 4900,
  "default_unit_amount_minor": 4900,
  "included_quantity": 1,
  "starts_at": "2026-08-31T14:22:05Z",
  "ends_at": "2026-08-31T14:22:05Z",
  "metadata": {},
  "rates": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "outcome_type": "string",
      "display_name": "Ada Lovelace",
      "unit_amount_minor": 4900,
      "included_quantity": 1,
      "committed_unit_amount_minor": 4900,
      "metadata": {},
      "created_at": "2026-08-31T14:22:05Z",
      "updated_at": "2026-08-31T14:22:05Z"
    }
  ],
  "created_at": "2026-08-31T14:22:05Z",
  "updated_at": "2026-08-31T14:22:05Z"
}