GET/usage/ai
Returns the organization's AI usage for the current period, measured in AI credits: allowance (core seats times
quantityPerSeat), used and overage (live, read from the AI service), overageReported (what was last reported
to Stripe), call counts, the policy (HardStop when none is set), and usage by feature. The period is the core
subscription's billing period when it carries the AI meter, otherwise the calendar month (UTC); carriesMeter
false means overage cannot be billed, so usage stops at the allowance whatever the policy says. unpricedCalls
counts calls with no model rate in effect, which add no credits. overagePrice is the price per credit, null when
none is configured. Requires OrganizationAdmin. Change the policy with Usage_UpdateAiPolicy.
Response
| Field | Type | Description |
|---|
| period | GetAiUsageResponsePeriodInfo | |
| policy | string| null | |
| isTrial | boolean | |
| carriesMeter | boolean | |
| coreSeats | integer | |
| quantityPerSeat | integer | |
| allowance | number | |
| used | number | |
| overage | number | |
| overageReported | number| null | |
| lastReportedAt | date-time| null | |
| calls | integer | |
| unpricedCalls | integer | |
| overagePrice | GetAiUsageResponseOveragePriceInfo | |
| features | GetAiUsageResponseFeatureUsage[]| null | |
GetAiUsageResponsePeriodInfo
| Field | Type | Description |
|---|
| start | date-time | |
| end | date-time | |
GetAiUsageResponseOveragePriceInfo
| Field | Type | Description |
|---|
| perCredit | number | |
| currency | string| null | |
GetAiUsageResponseFeatureUsage
| Field | Type | Description |
|---|
| featureKey | string| null | |
| used | number | |
| calls | integer | |
| unpricedCalls | integer | |