Check Quota
check_quotaCheck this organization's calculation allowance for the current period: included, used and remaining calculations, whether more runs are blocked or billed as overage, the remaining overage budget and whether runs are paused. Use it before starting several billable calculations with upload_and_quote or quote_part. Read-only and free.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | ||
| used | No | ||
| bonus | No | Thank-you calculations granted on top of the plan this window. | |
| window | No | 'month' or 'year'. | |
| guidance | Yes | ||
| included | No | Calculations included per window. | |
| rollover | No | Unused calculations carried in from last window. | |
| effective | No | Ceiling this window (included + rollover + bonus). | |
| 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. | |
| window_start | No | ISO 8601 start of the current quota window. | |
| 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. | |
| 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 payment method is on file; a 'wallet' plan needs one for calculations beyond the included volume. | |
| overage_settlement | No | How overage is paid: 'wallet' (a prepaid balance that is the ceiling) 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. | |
| wallet_funded_calculations | No | How many more overage calculations the current balance covers; beyond 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. |