ARCNM Check Quota
arcnm_check_quotaRead-onlyIdempotent
Check this organization's remaining calculation quota for the current billing window BEFORE committing a run — how many calculations are included, used, and remaining, whether the plan hard-caps (over-quota parks as 'blocked') or bills overage, how overage settles ('wallet' = prepaid, so the balance is the ceiling — 'wallet_funded_calculations' is how many more fit), how much of the monthly overage cap is left, and whether billing is suspended. Use it to top up, upgrade or raise the cap up front instead of discovering the wall when a calc parks. Read-only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | ||
| used | No | ||
| window | No | 'month' or 'year'. | |
| guidance | Yes | ||
| included | No | Calculations included per window. | |
| effective | No | Ceiling this window (included + rollover). | |
| remaining | No | Calculations still available this window. | |
| over_quota | No | ||
| hard_capped | No | True: over-quota runs park as blocked. False: they bill as overage. | |
| overage_cents | No | Price of one calculation beyond the included volume, in cents. | |
| payment_blocked | No | True when billing is suspended and nothing will run. | |
| wallet_overdrawn | No | True when the prepaid balance has reached its hard floor — calculations are paused and further runs park as 'blocked' until the balance is topped up. Check this before a bulk run. | |
| overage_cap_cents | No | Monthly overage spend cap in cents, or null when uncapped. Bounds what over-quota runs may cost. | |
| spend_cap_blocked | No | True when the overage cap is reached and set to pause — further over-quota runs park as blocked. | |
| has_payment_method | No | Whether a card is on file. Required before any calculation beyond the included volume on a 'wallet' plan. | |
| overage_settlement | No | How overage is paid: 'wallet' (prepaid — the balance is the ceiling, top up to continue) or 'invoice' (contracted, billed in arrears). | |
| overage_spend_cents | No | Overage already billed this calendar month, in cents. | |
| wallet_balance_cents | No | Prepaid balance in cents ('wallet' settlement only). | |
| wallet_overdraft_cents | No | How far the prepaid balance is below zero, in cents. | |
| activation_runs_remaining | No | Calculations this account may still run before a person reviews it, or null when no review is pending. Separate from 'remaining': a new account can have its whole included volume and still be limited to a handful of runs. Size a batch by the SMALLER of the two — anything past it is saved, not run, and there is nothing to pay or retry to change that. | |
| wallet_funded_calculations | No | How many more overage calculations the balance covers. Check this before a bulk run — past it, calculations park as 'blocked'. | |
| wallet_overdraft_floor_cents | No | Hard floor on the prepaid balance, in cents; the balance can never go below its negation. | |
| overage_budget_remaining_cents | No | Overage spend still inside the cap, in cents; null when uncapped. |