Skip to content

docs: add credit balance monitoring section#7952

Merged
michaelneale merged 1 commit intomainfrom
rizel/docs-credit-balance-monitoring
Mar 17, 2026
Merged

docs: add credit balance monitoring section#7952
michaelneale merged 1 commit intomainfrom
rizel/docs-credit-balance-monitoring

Conversation

@blackgirlbytes
Copy link
Contributor

Summary

Documents the low balance detection feature from #7166 that warns users when their API provider credits are running low or exhausted.

What's Added

New Credit Balance Monitoring section in docs/getting-started/providers.md that explains:

  • The Insufficient Credits notification users will see when balance is low
  • The Add credits button for supported providers (like Tetrate)
  • How to continue conversations after topping up credits
  • Which providers support this feature (Tetrate, OpenRouter, and others using HTTP 402)

Related

Document the low balance detection feature that warns users when their
API provider credits are running low or exhausted. This feature:

- Displays an 'Insufficient Credits' notification when balance is low
- Provides a direct 'Add credits' button for supported providers (Tetrate)
- Allows users to continue their conversation after topping up

Added to smart-context-management.md alongside token usage and cost tracking.

Related to: #7166

Signed-off-by: Rizel Scarlett <rizel@squareup.com>
@blackgirlbytes blackgirlbytes force-pushed the rizel/docs-credit-balance-monitoring branch from b460048 to 47a4a3c Compare March 17, 2026 05:13
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b460048ef8

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


## Credit Balance Monitoring

goose monitors your API provider balance and warns you when credits are running low or exhausted. When this happens, you'll see an **Insufficient Credits** notification.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Describe credits warnings as exhaustion-only

This sentence overstates the feature by saying goose warns when credits are "running low or exhausted"; in the current implementation, the notification is only emitted after provider errors are mapped to CreditsExhausted (primarily HTTP 402), so there is no proactive low-balance monitoring before a request fails. This can mislead users into expecting an early warning that never appears.

Useful? React with 👍 / 👎.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://block.github.io/goose/pr-preview/pr-7952/

Built to branch gh-pages at 2026-03-17 05:19 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@michaelneale michaelneale added this pull request to the merge queue Mar 17, 2026
Merged via the queue into main with commit 7e36ebc Mar 17, 2026
23 checks passed
@michaelneale michaelneale deleted the rizel/docs-credit-balance-monitoring branch March 17, 2026 06:42
jh-block added a commit that referenced this pull request Mar 17, 2026
* origin/main:
  feat: adversarial agent for preventing leaking of info and more  (#7948)
  Update contributing.md (#7927)
  docs: add credit balance monitoring section (#7952)
  docs: add Cerebras provider to supported providers list (#7953)
  docs: add TUI client documentation to ACP clients guide (#7950)
  fix: removed double dash in pnpm command (#7951)
  docs: polish ACP docs (#7946)
  claude adaptive thinking (#7944)
  feat: new onboarding flow (#7266)
  Add DCO git commit command to AGENTS.md (#7945)
  fix(claude-code): remove incorrect agent_visible filter on user message (#7931)
  No Check do Check (#7942)
  Log 500 errors and also show error for direct download (#7936)
  fix: retry on authentication failure with credential refresh (#7812)
  Remove java/.ai-usage-marker directory (#7925)
  test(acp): add terminal delegation fixtures and fix shell singleton (#7923)
  fix: bump pctx_code_mode to 0.3.0 for iterator type checking fix (#7892)
  feat: persist GooseMode per-session via session DB (#7854)
jh-block added a commit to rabi/goose that referenced this pull request Mar 18, 2026
* main: (32 commits)
  Revert message flush & test (block#7966)
  docs: add Remote Access section with Telegram Gateway documentation (block#7955)
  fix: update webmcp blog post metadata image URL (block#7967)
  fix: clean up OAuth token cache on provider deletion (block#7908)
  fix: hard-coded tool call id in code mode callback (block#7939)
  Fix SSE parsers to accept optional space after data: prefix (block#7929)
  docs: add GOOSE_INPUT_LIMIT to config-files.md (block#7961)
  Add WebMCP for Beginners blog post (block#7957)
  Fix download manager (block#7933)
  Improve the formatting of tool calls, show thinking, treat Reasoning and Thinking as the same thing (sorry Kant) (block#7626)
  don't imply running builds all the time in AGENTS.md (block#7865)
  fix: unregister goosed child process's  listener (block#7956)
  feat: adversarial agent for preventing leaking of info and more  (block#7948)
  Update contributing.md (block#7927)
  docs: add credit balance monitoring section (block#7952)
  docs: add Cerebras provider to supported providers list (block#7953)
  docs: add TUI client documentation to ACP clients guide (block#7950)
  fix: removed double dash in pnpm command (block#7951)
  docs: polish ACP docs (block#7946)
  claude adaptive thinking (block#7944)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants