Check Balance
check_balanceReturn customer-facing billing status: active contract, rated current-period spend, available/committed/promotional cents, active reservations, accepted pending usage, auto-recharge status, payment readiness, and projection staleness. For parent-billed orgs, consumer_money is only that child's attributed usage; agency balances and invoices are not exposed. Requires 'account-read' scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| billing | Yes | ||
| guidance | No | Interpretation or recovery guidance for this result | |
| count_unit | No | ||
| page_count | No | Number of objects on this page, not the organization total | |
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| operational | Yes | ||
| billing_mode | Yes | Who bills this account, or native_setup_required | |
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| money_display | No | Currency amounts formatted once from source paths ending in _cents. Use verbatim; do not divide again. Null/missing source amounts are omitted, not zero. | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions |