v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

AI Credit Controls

Get AI credit controls

<Note> **Organization Admin** permissions are required for this endpoint. </Note>

Get the organization's AI credit controls: the downgrade and shutoff thresholds, the default per-user credit limit, plus read-only context (the credit limit, usage for the current billing period, and the period bounds).

get/v1/ai/credit-controls

Response

Current credit controls. Thresholds are null when the corresponding control is off.

accountCreditLimitnumber required

Monthly AI credit limit for the whole Omni account, which is shared across every organization associated with the account. 0 when no limit is configured.

creditsUsednumber required

This organizations's credit usage for the current billing period.

downgradeCreditsnumber nullable required

Downgrade threshold, or null if the downgrade control is off.

periodEndinteger required

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

periodStartinteger required

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

shutoffCreditsnumber nullable required

Shutoff threshold, or null if the shutoff control is off.

userDefaultCreditsnumber nullable required

Default per-user AI credit limit, or null when users are unlimited by default.

Example response

{
  "accountCreditLimit": 2000,
  "creditsUsed": 450,
  "downgradeCredits": 800,
  "shutoffCredits": 1200,
  "userDefaultCredits": 100
}

All 186 operations