OnTime accounts are enforced with a limitation that limits how many requests can be sent to the OnTime API on a daily or monthly basis.
For Grow, Scale, Enterprise, and Enterprise Plus accounts, a total of 86,400 requests can be made every 24 hours. This limit resets at 12:00 AM GMT each day.
For Grow and Enterprise accounts, a total of 100,000 requests can be made each calendar month. This limit resets at 12:00 AM GMT on the 1st of each month. Scale and Enterprise Plus accounts are exempt from this monthly limitation.
Trial accounts are limited to 1,000 transactions per day and 5,000 transactions total during the trial period.
When a daily or monthly limit is exceeded, all further requests will be denied, and the following status code will be returned until the relative limit is reset:
429 (Too Many Requests)
To avoid exceeding any request limitations, it is recommended to follow these guidelines:
- Webhook workflow notifications should be used to detect when an order’s status has changed
- Use as many URL parameters as necessary to limit any accidental processing of returned data
- Limit long-running processes to send one request per second whenever possible
- Ensure the integrity of any uploaded data to minimize costly errors from occurring
When applicable, the following API response headers can assist in tracking the current status of your account’s request limitation status:
Header Name | Data Type | Description |
X-RateLimit-Limit-Daily | Integer | Specifies the maximum number of requests that can be made within a 24-hour period |
X-RateLimit-Remaining-Daily | Integer | Specifies the remaining number of requests that can be made within the current 24-hour period before access is denied |
X-RateLimit-Reset-Daily | Integer | The time at which the current 24-hour request limit period resets in UTC epoch seconds |
X-RateLimit-Limit-Monthly | Integer | Specifies the maximum number of requests that can be made within a calendar month period |
X-RateLimit-Remaining-Monthly | Integer | Specifies the remaining number of requests that can be made within the current calendar month period before access is denied |
X-RateLimit-Reset-Monthly | Integer | The time at which the current calendar month request limit period resets in UTC epoch seconds |
Retry-After | Integer | Indicates how long the user agent should wait before making a follow-up request in seconds |