This article explains how API requests impact your account credits. It covers how requests are deducted from your credit balance and provides insight into special parameters that might incur additional credits.
How Credits Are Deducted
When you make an API request, credits are deducted from your overall total.
Successful Requests: Each successful request, indicated by “success”: true, deducts credits.Please note: only successful requests will be deducted from your total.
- Credits_used: This shows the total number of credits used across all API calls in your account for the subscription period. For example, if your total usage is 5000 credits, it means you have used 5000 credits from your subscription overall.
- Credits_remaining: This indicates the number of credits left in your account for the subscription period. For instance, if you see 96 credits remaining, you have 96 credits available for future requests.
- Credits_used_this_request: This displays the number of credits deducted for a specific API request. For example, if this value is 1, it means 1 credit was used for the request made.
Impact of Special Parameters
Some parameters might incur extra charges. They’re indicated with a question mark icon beside the parameter. Here's an example below:
Pagination Parameters
Requesting additional results pages via our pagination parameters will cost for all pages retrieved. Each page counts as an additional request.
Here’s an example of an API request with pagination set to retrieve up to 5 pages.
Single API Requests vs. Collections
Please note that there is no difference in how Single API Requests and Collections are charged. Collections simply aggregate your requests, while Single API Requests in the playground are charged individually. Both methods follow the same credit deduction structure. If you run a collection with 10,000 requests, this means 10,000 credits will be deducted from your account total.