---
title: "Get AI credit controls"
method: GET
path: "/api/v1/ai/credit-controls"
tags: ["AI"]
---

# Get AI credit controls

`GET /api/v1/ai/credit-controls`

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 so far this billing period, and the period bounds). This is the API mirror of the AI Hub credit controls page and requires the same AI-admin permission.

## Response `200`

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

- AiCreditControlsResponse
  - `accountCreditLimit` number, required — Monthly AI credit limit for the whole Omni account (shared across every org under the same Salesforce account), not just this org. 0 when no limit is configured.
  - `creditsUsed` number, required — This org's credit usage in the current billing period.
  - `downgradeCredits` number, nullable, required — Downgrade threshold, or `null` if the downgrade control is off.
  - `entityGroupDefaultCredits` number, nullable, required — Default per-entity-group AI credit limit, or `null` when embed entity groups are unlimited by default.
  - `periodEnd` integer, required — End of the current billing period as a Unix ms timestamp (UTC calendar-month boundary).
  - `periodStart` integer, required — Start of the current billing period as a Unix ms timestamp (UTC calendar-month boundary).
  - `shutoffCredits` number, nullable, required — Shutoff threshold, or `null` if the shutoff control is off.
  - `userDefaultCredits` number, nullable, required — Default per-user AI credit limit, or `null` when users are unlimited by default.

## Other responses

- `401` — Missing or invalid API key.
- `403` — Insufficient permissions, or AI credit controls are not enabled for the organization. Requires AI-admin access.

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/de7cac8b5983/schema)