> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ironbee.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> IronBee (ironbee.ai) is an AI QA engineer: it verifies code changes against the running app and keeps the evidence. It is not related to the IronBee open-source web application firewall.
> The console is at https://console.ironbee.ai.
> Install the CLI with `npm install -g @ironbee-ai/cli`, sign in with `ironbee login`, and set up a project with `ironbee install`.
> In GitHub workflows, use the action as `ironbee-ai/ironbee-action@v1` and pass the `IRONBEE_API_KEY` secret as the `ironbee_api_key` input.
> In GitLab pipelines, include the component `gitlab.com/ironbee-ai/ironbee-gitlab/verify@v1`; it reads the `IRONBEE_API_KEY` CI/CD variable by default.
> In Bitbucket Pipelines, run the pipe `docker://ghcr.io/ironbee-ai/ironbee-bitbucket:v1` and pass `IRONBEE_API_KEY: $IRONBEE_API_KEY` and `BITBUCKET_OAUTH_TOKEN: $BITBUCKET_OAUTH_TOKEN` under its `variables:`.
> Console scenarios (https://docs.ironbee.ai/console/scenarios) and CLI saved scenarios (https://docs.ironbee.ai/cli/guides/scenarios) are separate features.
> For plans and prices, link to https://ironbee.ai/pricing; the website is the source of truth for them.

# Credit usage

> See your team's IronBee credits this month, what code review and verification used, what each job costs, and what happens when credits run out.

Code reviews and verification runs on IronBee spend one pool of credits, shared by the whole team. Your plan sets how many credits the team gets each month; see [Pricing](https://docs.ironbee.ai/console/pricing.md).

The **Usage** page shows the credits this month, what each product used, and what each job costs. Everyone in the account can open it: open **Settings**, then **Workspace > Usage**.

![The Usage page with the Credits this month meter and This month by product, split between Code review and Verification](https://mintcdn.com/ironbee/O3ded5Hi5Wvlg-RH/images/console/settings/usage-overview-light.png?fit=max\&auto=format\&n=O3ded5Hi5Wvlg-RH\&q=85\&s=a88da40d44f4afb630a84eeabf71b699)

![The Usage page with the Credits this month meter and This month by product, split between Code review and Verification](https://mintcdn.com/ironbee/O3ded5Hi5Wvlg-RH/images/console/settings/usage-overview-dark.png?fit=max\&auto=format\&n=O3ded5Hi5Wvlg-RH\&q=85\&s=7a4a12871628d15ccac3126c4a71eafb)

***

## Credits this month

The meter at the top shows:

* the credits used and the month's allowance, and how many are left. At zero it reads **No credits left**
* **Resets** and the date the credits reset
* a bar that fills as the team spends

The credits reset once a month, on the date the meter shows. It isn't always the first of the month.

When the team has used 80% of its credits, the meter turns to a warning that says what share of the month's credits is used. When they're all used, it says that new reviews and verifications are refused until the credits reset, with the date.

On a plan with unlimited credits, the meter shows the credits used and **Unlimited**, without a bar.

A run that has already started is never stopped for credits, so the credits used can end up above the allowance.

***

## This month by product

**This month by product** splits the month's credits between **Code review** and **Verification**.

***

## What a job costs

**What a job costs** is the rate card. A sentence at the top says how each product is priced: "A code review is priced by the size of what it reads and the depth chosen. A verification is priced by its started minutes."

* **Code review:** a table with one row for each size, from **S** to **3XL**. **Lines read** gives the range of reviewable lines each size covers, and **Quick**, **Standard** and **Deep** give the credits a review of that size costs at each depth.
* **Verification:** a line with the credits for each started minute of a run.
* **Free:** a line that lists the work that costs nothing.

The rate card always shows the current rates. The plans and their monthly credits are on [Pricing](https://docs.ironbee.ai/console/pricing.md).

***

## What uses credits

### Code review

A code review is priced before it starts, by the reviewable lines it reads and the [depth](https://docs.ironbee.ai/code-review/settings.md) it runs at:

* A review that finishes is charged its price.
* A review cancelled after it started is charged half its price.
* A review that fails, or has nothing new to read, is free.

What starts a review and the work that's free are on [Code review on GitHub pull requests](https://docs.ironbee.ai/code-review/on-github.md#credits). They're the same on [GitLab merge requests](https://docs.ironbee.ai/code-review/on-gitlab.md#credits-and-when-a-review-doesnt-run) and [Bitbucket pull requests](https://docs.ironbee.ai/code-review/on-bitbucket.md#credits-and-when-a-review-doesnt-run).

### Verification

Every verification run on IronBee uses credits, whatever started it: Vercel, Netlify, the [GitHub Action](https://docs.ironbee.ai/github-action/get-started/getting-started.md), the [GitLab component](https://docs.ironbee.ai/gitlab-component/get-started/getting-started.md), the [Bitbucket Pipe](https://docs.ironbee.ai/bitbucket-pipe/get-started/getting-started.md), [`ironbee verify`](https://docs.ironbee.ai/cli/guides/verification-jobs), **Run instant verification**, or a [scenario run](https://docs.ironbee.ai/console/scenario-runs.md).

A run is charged for each started minute, up to a cap set by its time limit. Once the run has started, it's charged for its minutes however it ends: passed, failed or cancelled.

A run isn't charged when:

* it never started: it was refused before it started, or cancelled while it was queued
* it failed for a reason on IronBee's side before the agent started working

### Free work

These use no credits:

* answers to questions, conversation replies, harvests after a merge, rechecks and retractions in code review
* code analysis and the [code wiki](https://docs.ironbee.ai/console/code-wiki.md)
* verification cycles that your AI coding agent reports through the [IronBee CLI](https://docs.ironbee.ai/cli/concepts/how-it-works.md)

Each run shows what it used in the **Credits** column of [Verifications](https://docs.ironbee.ai/console/verifications.md#credits) and on its [verification detail](https://docs.ironbee.ai/console/verification-detail.md#header) page.

***

## When credits run out

When the credits are all used, IronBee refuses new code reviews and new verification runs until the credits reset or the team gets more. Runs that already started finish.

### Across the console

A banner at the top of every console page warns the whole team:

| Banner | When |
| - | - |
| A warning with the share of the month's credits the team has used | 80% or more of the month's credits are used. You can close it; it comes back in a new browser session while it still applies |
| **This team has used all of its IronBee credits for this month.** New reviews and verifications are refused until the credits reset, with the date | No credits are left |

The console shows one banner at a time: a session limit or a payment that's past due comes first, then running out of credits, then more people than seats, then the 80% warning. See [Banners across the console](https://docs.ironbee.ai/console/pricing.md#banners-across-the-console).

For owners and billing admins, the bell in the top bar also shows **IronBee credits: 80% used this month** or **IronBee credits: all used this month**, with **Open the usage page** under it. Click it to come here. The bell marks it unread again when the credits run out, and in the next month.

### Starting runs

* **Run instant verification**, **Run scenario** and **Run again** are disabled. Hover one to see why: "This team's IronBee credits for this month are used up; they reset on" and the date.
* If a run dialog is open, the same sentence shows at the top and its run button stays disabled.
* A run created before the credits ran out, but not started yet, is refused when it would start, and uses no credits. In the list its status is **Failed**, or **Run error** for a scenario run, whose page says **Stopped before it started**. **Run details** on its [verification detail](https://docs.ironbee.ai/console/verification-detail.md#header) page gives the reason under **Refused**.
* A deployment from Vercel or Netlify isn't verified, and no run appears in the list. Its GitHub or Vercel check closes as neutral, and says **IronBee did not run this verification · out of credits this month**. On GitLab, the pipeline status with that description is passed, where IronBee writes one: on a project with **Pipelines must succeed** and **Block merges** off, it writes none. On Bitbucket, the build status with that description is successful.
* `ironbee verify` and `ironbee review` stop with an error. See [When credits run out](https://docs.ironbee.ai/cli/guides/credits.md#when-credits-run-out) in the CLI docs.

For code review, see [When credits run out](https://docs.ironbee.ai/code-review/on-github.md#when-credits-run-out), and for GitLab merge requests and Bitbucket pull requests, Credits and when a review doesn't run on [GitLab](https://docs.ironbee.ai/code-review/on-gitlab.md#credits-and-when-a-review-doesnt-run) and [Bitbucket](https://docs.ironbee.ai/code-review/on-bitbucket.md#credits-and-when-a-review-doesnt-run).

***

## Get more credits

Below the rate card, the page shows what you can do to get more credits. It depends on your role and your plan:

| You are | The page shows |
| - | - |
| An owner or billing admin, on a plan with seats | A link that starts with **Add seats** and says what each seat adds. It opens **Change seats** on [Pricing](https://docs.ironbee.ai/console/pricing.md#change-seats) |
| An owner or billing admin, on a plan you can upgrade | A button that opens [Pricing](https://docs.ironbee.ai/console/pricing.md#upgrade-to-team) to upgrade |
| An owner or billing admin, with a payment past due | **Pay the open invoice**, which opens [Pricing](https://docs.ironbee.ai/console/pricing.md#billing-details-and-payments). While the payment is past due, the allowance is lower |
| An owner or billing admin, on any other plan | "Ask IronBee to change this team's allowance." Email [support@ironbee.ai](mailto:support@ironbee.ai) |
| An admin or member, with a payment past due | "An owner or a billing admin can pay the open invoice." |
| An admin or member, when seats or an upgrade would add credits | "An owner or a billing admin can add credits." |

The same link or sentence appears on the credit banners. When there's nothing to offer, for example on a plan with unlimited credits, the page shows nothing here.

***

## If the page can't load

While the credits load, the page shows placeholders. If they can't be loaded, it says **Couldn't load the credits**, explains why, and offers **Try again**.

***

## Related pages

> [card] [Pricing](https://docs.ironbee.ai/console/pricing.md)
>
> The plans, their monthly credits, and how to change seats.

> [card] [Verifications](https://docs.ironbee.ai/console/verifications.md)
>
> Every run of a project, with the credits it used.

> [card] [Credits in the CLI](https://docs.ironbee.ai/cli/guides/credits.md)
>
> Check the balance with `ironbee credits`, and the credits of each review and verification.

> [card] [Code review](https://docs.ironbee.ai/code-review/overview.md)
>
> How IronBee reviews pull requests and merge requests, and what a review costs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.