OMomni
AI Credit Controls

Get AI credit controls

Changed on
<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 and per-entity-group credit limits, plus read-only context (the credit limit, usage for the current billing period, and the period bounds). This endpoint can be used for embedded instances.

get/v1/ai/credit-controls

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/credit-controls
  • Auth
    • HTTP bearer
    • or HTTP bearer

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.

entityGroupDefaultCreditsnumber nullable required

Default per-entity-group AI credit limit, or null when entity groups are unlimited by default.

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,
  "entityGroupDefaultCredits": 100,
  "shutoffCredits": 1200,
  "userDefaultCredits": 100
}

Changes