Recipe
Rate Limit Doc Design
A clean, readable layout for documenting API rate limits, quotas, and retry guidance.
Overview
This recipe provides a structured template for presenting rate-limit tiers, headers, and backoff strategies. Use it when building developer-facing API documentation that needs clarity around throttling behavior.
Tier Table
| Plan | Requests/min | Burst |
|---|---|---|
| Free | 60 | 10 |
| Pro | 600 | 50 |
| Enterprise | 6,000 | 200 |
Response Headers
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 587
X-RateLimit-Reset: 1716500000
Retry-After: 12
Retry Strategy
When you receive a 429 Too Many Requests, honor the Retry-After header. Use exponential backoff with jitter for subsequent attempts. Do not retry more than 3 times before surfacing the error to the caller.
Pro tip: Combine this layout with the Code Blocks recipe to show SDK examples alongside your rate-limit tables.