API calls limits and optimization
To understand the basic limits of your account, check out Pricing and Fair Use Policy. Now, let's navigate through what we limit and how to monitor your usage.
|API requests per hour||Free plan: 100,|
Startup plan: 1000,
Growth plan: 2000,
Professional plan: 5000
|Bulk API requests per hour||Free plan: 1,|
Startup plan: 10,
Growth plan: 20,
Professional plan: 50
|Billing cycle API requests|
Bulk API requests are not added to the billing cycle limit.
|Free plan: 500,|
Startup plan: 10000,
Growth plan: 30000,
Professional plan: 100000
|Client-side requests (e.g., validate) from a single IP address||5 requests per 5 seconds|
What happens if you exceed your limits?
You can't exceed the number of API calls (both hourly and monthly) defined in your pricing plan. Exceeding this limit will block your access to the API immediately.
Users with an Enterprise plan have custom API requests limits. Depending on the case, it can be counted per hour or per minute. Bulk API requests are counted in hour periods in both cases.
Webhook calls coming from integrations are counted in separate daily buckets.
The size of the daily bucket is derived from the API request limit.
Webhooks used per day:
- Free: 7 200
- Startup: 21 600
- Growth: 50 400
- Professional: 122 400
Webhook calls are gathered in a queue, so their number per hour can exceed the API hourly limit, and they will still be processed. However, if their number exceeds the daily limit, they will get rejected.
Each API response coming from the Voucherify platform has a couple of headers informing about the current status of the API limits.
These headers are:
X-Rate-Limit-Limit- maximum API requests that can be made in a period (an hour or a minute)
X-Rate-Limit-Remaining- number of API requests that can still be made in a current period
X-Rate-Limit-Retry- the time when the next API request can be made, in Unix epoch format (in seconds)
Retry-After- (optional) number of seconds left before the next API request can be made, shown after a limit is reached
X-Rate-Limit-Type- (optional) type of API limit that was reached, possible values: api_calls / bulk_api_calls / api_calls_cycle / webhook_calls
Voucherify will send an email with the notification whenever the number of API calls reaches a safety threshold.
The project owner can configure these thresholds and notifications in the
Project settings > API Usage tab.
Notifications for webhooks usage will be sent if the usage exceeds the limit for an hour, even though they are counted in daily periods. It is a measure to inform you in advance about any suspicious user activity.
API calls optimization
Voucherify follows the usage-based pricing model. This means that we charge you for the number of API calls that you make to our platform. What is noteworthy is that we operate on a fixed quota model, which means that you should be able to predict the average number of API calls that you will need per month.
Besides working out the scenarios that Voucherify can help you achieve, the sooner you start to think about your platform usage optimization, the better. This short guide will give a quick rundown of the most popular ways to scale down your platform usage and save money in the long run.
Stackable discounts API
Voucherify API for stackable discounts lets you validate and redeem up to 5 objects using a single API request. You can combine coupons, gift cards, promotion tiers, loyalty, and referral codes.
In the redemption request, you need to provide a list of redeemables that define what discounts or codes will be redeemed/validated. By integrating stackable discount API into your app, you can make a single call with up to 5 redeemables, instead of 5 separate redemption calls.
For more information, go here.
When you are getting started with Voucherify and decide to import customer data or legacy vouchers into our platform, you can do so in two ways -- using API or a CSV import. To limit the number of API calls consumed, it is best to use CSV import which you can initiate via API or manually with the Dashboard.
For more information on preparing a CSV file for data import, go here.
As developers ourselves, we know which tasks are the most time-consuming and repetitive. That's why we have automated them for you. With the use of API, you can update the following properties in bulk:
By using these endpoints, you can update multiple entities (customers, vouchers, products) in a single asynchronous operation. It is possible to update a maximum of 100 records in a single request. In the response body, you get a unique async action identifier. To check the status of the operation, you can use the GET Async Actions API.
The biggest benefit of using asynchronous actions for big updates is that you can maintain platform stability (as the action is spread over time) and consume fewer API calls in the long run.
Validation and redemption
Voucherify supports both incentive validation and redemption. The validation process checks if the incentive (promo code) can be used (redeemed) in a given context and returns an updated price which can be displayed at the checkout to motivate customers to finish the purchase before actually utilizing the code.
On the other hand, redemption is the promo code usage, therefore if a code is placed at the checkout, it will be marked as used by Voucherify. If a customer changes their mind about the purchase and comes back later, they won't be able to use the code again (unless the code doesn't have any redemption limits attached).
If you are looking for a quick way to limit the number of API calls, you can call the redemption API endpoint without sending the preceding validation request. It is safe in the sense that the same validation will be applied as a first step. However, using it that way may offer a worse customer experience.
Validation rules and Dashboard usage
Validation rules define the eligibility conditions for your incentives. It is possible to build them manually in the Dashboard or via API. We highly recommend creating validation rules using the Dashboard. The Rules Builder in the Dashboard helps you configure desired limits in a convenient way. The API should not be used as a preferable way to create and manage validation rules due to the bigger complexity and additional resources it would consume.
For more information on validation rules, go here.
Generally speaking, the more activities you perform via Dashboard the better as they do not consume your API calls limit this way.
Webhooks enable Voucherify to send real-time updates to your app or URL endpoints. In some cases (e.g., code publication), you can use a webhook to avoid calling our API.
Also, instead of polling data from some endpoints, you can configure webhooks to get notified about triggered events, distribution channels, loyalty programs, and referral programs.
For more information on webhooks, go here.
Updated 3 months ago