Skip to main content
POST
Read individual users' AI credit 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; each ID must be included only once. Duplicated IDs will result in an error.

Required array length: 1 - 1000 elements

Response

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

periodEnd
integer
required

End of the current billing period as a Unix ms timestamp (UTC calendar-month boundary).

Required range: x >= 0
periodStart
integer
required

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

Required range: x >= 0
users
object[]
required