Overview of API Usage Limits
Unleashed imposes limits on the number of API requests that can be made within a specific timeframe. These limits apply solely to requests initiated by your application or system. Certain actions, such as webhook events initiated by Unleashed, are exempt from this limitation.
API Actions that count toward API usage limits
Third-party integrations using API ID and key: For example, when connecting external systems to Unleashed via an API ID and key, requests to Unleashed are included in your API call count. This applies to any third-party applications using similar authentication methods.
API Actions that do not count toward API usage limits
Some actions are exempt from API usage limits, ensuring that certain interactions do not increase your API call count. For instance:
Webhook Events: Deliveries of webhook events initiated by Unleashed do not count toward your API usage. These events are automatically excluded as they are initiated by Unleashed, not your application.What are the API Usage thresholds?
As your API usage increases, you'll receive email notifications at three key points:
90% Usage: "Your API usage is at 90% of the limit."
95% Usage: "Watch out! You're at 95% of your API usage limit."
100% Usage: "WARNING: You have reached your API usage limit and requests are blocked."
How API usage impacts your account
At 90% and 95% usage
Your integrations continue to function normally. These notifications serve as proactive alerts, giving you time to assess your usage and take action if needed.
At 100% usage
All API requests will be blocked until your limit resets. This means:
Third-party, non-native integrations will stop syncing data.
Automated processes connected to Unleashed will be interrupted.
No API calls can be made until the new period begins.
When your API limit resets
Your API usage limit automatically resets on the 1st of each calendar month at 12:00 AM UTC:
1:00 PM NZST
11:00 AM AEDT
12:00 AM GMT
Do you need to take action?
If you receive the 90% notification late in the month:
No immediate action is required if there are fewer than 3 days remaining in the current period. With 10% of your quota remaining for just a few days, you should have sufficient capacity to maintain normal operations until the reset.
If you receive a 90% or 95% notification within the first 14 days of a month:
This indicates unusually high API consumption early in the period. Immediate investigation with your third-party integration is recommended.
How to Resolve High API Usage
Purchase additional API calls
If your business operations require more API calls, you can purchase an additional API bundle:
Navigate to Settings > Billing.
Add the available API bundle.
Update your subscription to purchase the bundle.
🤓 Tip: This option is ideal for users with API-intensive operations or multiple custom integrations connected to Unleashed.
Investigate unexpected usage
If you experience high usage unexpectedly, contact your third-party integration developers or platforms for assistance.
Before reaching out to Support, gather the following information to help resolve your issue quickly:
List of active integrations: Note all third-party tools connected to your Unleashed account.
3-PL shipping providers: Include details of any third-party logistics providers you use.
Recent account changes: Document any new integrations, configuration changes, or process modifications.
With this information, your integration partners can identify if their platform is generating excessive API calls and help optimize the connection.