Error

A valid request URL is required to generate request examples

{
  "environment_id": "…",
  "month": "2026-07",
  "active_contacts": 1842,
  "limit": 50000,
  "period_ends_at": "2026-08-01T00:00:00Z"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Contacts (panel)

Read active-contact usage

Requires customers:read. Active contacts this calendar month, the free-tier ceiling, and when the meter resets.

It reads the same query the bill reads — the number shown here is the number charged. Live environment only, because only live contacts count at all.

A contact becomes active for a month when a session JWT is minted for them at POST /v1/contact/token; a session issued in January and refreshed in February is active in both. The month is UTC, decided once in the schema: display may translate it, a bill may not be ambiguous.

GET

organization

usage

active-contacts

Error

A valid request URL is required to generate request examples

{
  "environment_id": "…",
  "month": "2026-07",
  "active_contacts": 1842,
  "limit": 50000,
  "period_ends_at": "2026-08-01T00:00:00Z"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Authorizations

Authorization

string

header

required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Headers

X-Organization-Id

string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Response

The meter.

environment_id

string<uuid>

Always the live environment.

month

string

YYYY-MM, UTC.

active_contacts

integer<int64>

limit

integer

The free tier's ceiling.

period_ends_at

string<date-time>

Let people in List contacts

⌘I

Overview

Endpoints

Read active-contact usage

Authorizations

Headers

Response