Report a credit balance
report_balanceRecords the balance a provider shows for one program the founder keeps on their Programscape plan and has marked approved: the amount left, in the unit the provider reports it (US dollars, credits or requests), when it was read, and whether the founder’s own router or their assistant reported it. Optionally sets the number under which the founder wants an email reminder, in the same unit. Returns the balance as stored on the plan, with when it was read and who reported it. It is a report, never an estimate or a total, and it is never added to other programs or set against the amount awarded. Changes nothing else on the plan. Needs the founder’s Programscape sign-in.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asOf | No | When the balance was read from the provider, as an ISO 8601 date and time. Leave out to mean now. | |
| unit | Yes | The unit the provider reports the balance in: usd, credits or requests. | |
| amount | Yes | What the provider shows as left, in `unit`, exactly as reported: dollars to the cent, or a whole number of credits or requests. Never an estimate, a conversion or a sum. | |
| planId | No | The selected saved plan. Required when the account has more than one plan; an omitted id never chooses the most recently updated one. | |
| source | No | Who is reporting: "router" for the founder’s own credit router, "assistant" for an AI assistant the founder asked. Defaults to "assistant". Only a connection made from a program on the founder’s own computer (a loopback sign-in, as the router’s) can report as "router"; any other reports as "assistant". | |
| estimate | No | Router only (0151): how long this balance lasts at the recent pace. Shown on the plan labelled as an estimate, with when it was worked out. It never sets an expiration date or a date reminder. Leave out when there is no pace yet. | |
| programId | Yes | The id of a program the founder keeps on their plan and has marked approved, for example "firecrawl.startup-deal". | |
| lowBalanceAt | No | Optional: the number under which the founder asked to be reminded, in the balance’s unit. Replaces the reminder number on the plan. |