Skip to main content
POST
Read individual users' AI credit usage
A removed embed user’s usage still 404s, even for a past month, because removing an embed user deletes its membership. To read usage that includes a departed embed user, use the Read individual entity groups’ AI credit usage endpoint instead — an entity group’s total keeps a former member’s usage.

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Body

application/json
userIds
string<uuid>[]
required

Users to read usage for, at most 1000 per request. Each entry is a user's ID within this organization, whether a current or a removed member; each ID must be included only once. Duplicated IDs will result in an error.

Required array length: 1 - 1000 elements
period
string

UTC calendar month to read, as YYYY-MM, from 2000-01 to 2099-12. Omit it to read the current billing period. A month after the current one is rejected; a month before AI credit metering began reports 0 for every ID.

Pattern: ^20\d{2}-(0[1-9]|1[0-2])$
Example:

"2026-09"

Response

Each requested user's credit usage for the billing period read, in request order.

periodEnd
integer
required

Start of the month after the billing period read, as a Unix ms timestamp (UTC calendar-month boundary, exclusive).

Required range: x >= 0
Example:

1790812800000

periodStart
integer
required

Start of the billing period read, as a Unix ms timestamp (UTC calendar-month boundary).

Required range: x >= 0
Example:

1788220800000

users
object[]
required