Skip to content

[codex] add websocket billing callouts#1218

Merged
0xmts merged 3 commits intomainfrom
mc/codex/ws-billing-callouts
Apr 16, 2026
Merged

[codex] add websocket billing callouts#1218
0xmts merged 3 commits intomainfrom
mc/codex/ws-billing-callouts

Conversation

@0xmts
Copy link
Copy Markdown
Contributor

@0xmts 0xmts commented Apr 15, 2026

Summary

Adds measured billing and usage guidance to the core WebSocket guidance docs so builders see bandwidth-based subscription pricing and the right guardrails before they choose a broad stream.

What Changed

  • added a targeted billing/risk warning to the Subscription API overview
  • added a short pricing warning to the subscription endpoint index page
  • added guidance to keep subscription scope narrow in the WebSocket best-practices doc
  • expanded the general Alchemy best-practices page with WebSocket-specific usage guidance

Why

The docs already recommend using WebSockets for subscriptions only, but they did not clearly connect broad subscription scope to bandwidth-based billing or point users to spend caps and alerts where they make the transport choice.

Validation

  • pnpm run lint:eslint content/api-reference/websockets/subscription-api.mdx content/api-reference/websockets/subscription-api-endpoints/subscription-api-endpoints.mdx content/api-reference/websockets/best-practices-for-using-websockets-in-web3.mdx content/tutorials/getting-started/developer-best-practices/best-practices-when-using-alchemy.mdx

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 15, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Apr 15, 2026, 6:51 PM

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 15, 2026

🔍 Link Check

Status: ❌ Failed

Summary

Status Count
🔍 Total 7895
✅ Successful 6758
⏳ Timeouts 0
🔀 Redirected 396
👻 Excluded 677
❓ Unknown 0
🚫 Errors 63
⛔ Unsupported 1
Broken links (63) — click to expand

Errors per input

Errors in ./content/wallets/pages/bundler-api/bundler-faqs.mdx

Errors in ./content/changelog/2026-03-26.md

Errors in ./content/tutorials/alchemy-university/smart-contract-basics/multi-sig-contracts.mdx

Errors in ./content/changelog/2026-04-09.md

Errors in ./content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx

Errors in ./content/api-reference/starknet/starknet-api-faq.mdx

Errors in ./content/api-reference/hyperevm/hyperevm-api-overview.mdx

Errors in ./content/api-reference/arbitrum/arbitrum-api-faq/arbitrum-api-faq.mdx

Errors in ./content/api-reference/pricing-resources/resources/error-reference.mdx

Errors in ./content/api-reference/katana/katana-api-overview.mdx

View workflow run

Moved warning callout after table
@0xmts 0xmts marked this pull request as ready for review April 15, 2026 18:50
@0xmts 0xmts requested a review from a team as a code owner April 15, 2026 18:50
@0xmts 0xmts merged commit 4bdeabb into main Apr 16, 2026
12 of 13 checks passed
@0xmts 0xmts deleted the mc/codex/ws-billing-callouts branch April 16, 2026 22:09
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