---
title: "Credit budgets, what each consumed this period, and the per-question caps"
method: GET
path: "/api/orgs/{orgId}/credit-budgets"
tags: ["credits"]
---

# Credit budgets, what each consumed this period, and the per-question caps

`GET /api/orgs/{orgId}/credit-budgets`

## Request

- Base URL: `https://api.wizbi.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wizbi.ai/api/orgs/{orgId}/credit-budgets`
- Auth: none declared

Needs the `budgets` component.

## Path parameters

- `orgId` string, required

## Response `200`

OK.

- CreditBudgets
  - `budgets` object[], required
    - `budget_id` string, required
    - `org_id` string, required
    - `scope` 'org' | 'group' | 'person' | 'channel' | 'agent', required
    - `scope_id` string, nullable, required
    - `period` 'day' | 'month', required
    - `limit` integer, required
    - `on_exceed` 'warn' | 'cap' | 'block'
    - `overage_pct` integer
    - `alert_pct` integer[]
    - `enabled` boolean
    - `label` string, nullable
    - `created_by` string, required
    - `created_at` string, date-time, required
    - `updated_by` string, required
    - `updated_at` string, date-time, required
  - `usage` object, required: Credits consumed in each budget’s current period, by budget id.
  - `state` object, required
  - `forecast` object, required
  - `caps` CreditCapsView, required
    - `org` object, nullable, required
      - `soft` integer, required
      - `hard` integer, required
    - `ceiling` object, nullable, required
      - `soft` number
      - `hard` number
    - `effective` object, required
      - `soft` integer, required
      - `hard` integer, required
    - `applied` boolean, required
    - `source` 'default' | 'org' | 'ceiling', required

## Other responses

- `401`: No resolved context.
- `403`: Not an org admin (`forbidden`), or the component is off (`feature_disabled`).

---

[API](https://skmtc.dev/wizbi/apis/wizbi-core-api.md) · [All operations](https://skmtc.dev/wizbi/apis/wizbi-core-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wizbi/apis/wizbi-core-api/revisions/5a47416c82ec?raw)