Preview. The API is shared with design partners and may change before launch. Register interest for sandbox access.
Rate limits
Rate limits protect the platform and every partner on it. Limits apply per credential and, for partners, per merchant.
| Mode | Endpoint group | Limit |
|---|---|---|
| Live | POST /v1/offers |
100 requests per second |
| Live | Everything else | 50 requests per second |
| Sandbox | All endpoints | 25 requests per second |
| Any | POST /oauth2/token |
10 requests per minute per client |
Payment providers and platforms with higher volumes get limits sized to their traffic during onboarding. Tell us your expected peak, for example Black Friday, and we’ll plan for it with you.
Headers
Section titled “Headers”Every response includes the current state of your limit, following the IETF RateLimit header fields draft:
RateLimit-Policy: 100;w=1RateLimit: limit=100, remaining=87, reset=1When you exceed the limit you get 429 rate_limited with Retry-After in seconds. Wait that long, then retry with the
same Idempotency-Key.
Good practice
Section titled “Good practice”- Reuse offers for the same cart until they expire instead of requesting new ones on every page view.
- Cache OAuth access tokens until shortly before they expire.
- Don’t poll for claim updates. Subscribe to events instead.