Getting Started
Rate Limiting
The Invoice Falcon API limits traffic per store using a points budget over a fixed 60-second window. Each request deducts points from the window's budget; when the window ends, the budget resets in full.
The Invoice Falcon API limits traffic per store using a points budget over a fixed 60-second window. Each request deducts points from the window's budget; when the window ends, the budget resets in full.
Default limits
| Parameter | Value |
|---|---|
| Budget per window | 40 points |
| Window length | 60 seconds |
| Cost per read (GET) request | 1 point |
| Cost per write (POST/PATCH/DELETE) request | 2 points |
A fresh window lets you burst up to 40 read requests (or 20 writes), after which you must wait for the next window.
Response headers
Every response includes headers so you can track your remaining budget:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum points per window |
X-RateLimit-Remaining | Points still available in the current window |
X-RateLimit-Reset | Unix timestamp (seconds) when the current window resets |
Exceeding the limit
When you run out of points the API returns 429 Too Many Requests. The response includes a Retry-After header and a retry_after field in the JSON body, both giving the number of seconds to wait before retrying.
Best practices
- Cache responses where possible to reduce unnecessary calls.
- Respect the
Retry-Afterheader instead of polling in a tight loop. - If you need higher limits, contact us at support@invoicefalcon.com.
