Get Budget Remaining
paybond_get_budget_remainingRead-only
Check remaining budget for a tenant-bound intent before authorizing a paid tool. Use this read-only dry-run to avoid overspending.
Instructions
Use this when you need a read-only dry-run of remaining spend budget for a tenant-bound intent before authorizing a paid tool. Do not use this to authorize spend or create decisions; call paybond_authorize_agent_spend when you are ready to gate a side-effecting tool.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | No | Optional task scope hint for policy evaluation. | |
| currency | No | Optional ISO currency code for the proposed spend. | |
| intent_id | Yes | Canonical Harbor intent UUID. | |
| operation | No | Optional delegated operation or tool name. Defaults to * when omitted. | |
| tool_name | No | Optional tool name scope hint for policy evaluation. | |
| vendor_id | No | Optional vendor scope hint for policy evaluation. | |
| workflow_id | No | Optional workflow scope hint for policy evaluation. | |
| tool_call_id | No | Optional tool-call correlation id for policy evaluation. | |
| agent_subject | No | Optional agent subject for agent-scoped caps. | |
| approval_token | No | Optional approval token to evaluate against pending approval state (not consumed). | |
| requested_spend_cents | No | Optional proposed spend in cents for the dry-run evaluation. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spend_scope | No | Spend scope used for the budget evaluation (scope_type and scope_key). | |
| policy_version | No | Active spend-control policy version when a policy is configured. | |
| remaining_cents | No | Remaining spend budget in cents for the evaluated scope, when available. |