ironbee credits shows what your team has left. Your plan sets the monthly allowance; see Pricing.
What a run costs
- A code review is priced by its size and its depth. The size counts the reviewable lines of the change. Lock files, generated, vendored, minified and binary files, data files under a test or fixture folder, and files the change deletes don’t count.
- A follow-up review is priced by the reviewable lines changed since the review it follows. When the earlier round left files unread, or most of the change is new since, it’s priced as the whole change again. A round that read nothing new isn’t charged, and when nothing changed since the last review, no review is created, unless you pass
--fresh. - A verification job is priced by how long it runs, up to its timeout.
ironbee credits
unlimited, with no such line.
The credential is resolved the same way as for
ironbee review: the flags, the environment, the personal file and the global config, never a file inside the checkout. Outside a checkout, the flags, the environment and the global config are used. ironbee credits prints the balance under CI too. It exits 0, or 1 on an error.
Credits on each run
Code reviews
A review cancelled after it started shows
(half price) next to its credits, and a review that failed shows not charged. The text and TUI headers show the review’s credits next to its depth, and the SARIF and JSON forms carry them too.
Verification jobs
- With
--timeout, thecreated job <id>line also says the most credits the job can use at that timeout. - The finished job’s report, and
ironbee verify status, add acreditsline: the credits used and what’s left this month,not charged, orunlimited.
In CI
WhenCI is set to any non-empty value, false and 0 included, a run’s lines carry only the job’s own credits, never your team’s balance, because a public repository’s job log is public. The JSON forms keep every field, and ironbee credits still prints the balance.
When credits run out
When your team is out of credits, the API refuses to create the job with402 CREDITS_EXHAUSTED. The CLI says when the credits reset, how many are left, and how to raise the allowance, then exits 1:
A review the team can’t afford in full reads
not enough credits left this month for this review. A job that’s refused for credits when it starts fails with credits_exhausted and says why. Under CI, the numbers are left out, and so is a hint about an unpaid invoice.
With --json, the failure envelope carries the numbers as error.credits, next to error.code. ironbee verify and ironbee credits also give the HTTP status; ironbee review doesn’t:
neededappears only on a code review, whose price is known before it’s created.topUpisadd_seats,upgrade,pay_invoice,contact, ornullwhen there’s no way up.
local_size_mismatch: the size the CLI declared didn’t match the change, so the review couldn’t be priced. CLI versions before 0.48 counted the lines of deleted files, which the platform doesn’t price. If a change that deletes files fails this way, update the CLI.
What’s next?
Code review
Review your branch before you open a pull request.
Verification jobs
Verify a deployed app or API from any shell or CI pipeline.