Understanding Service Credits and Usage Limits
What is a Service Credit?
A Service Credit is a way to measure API usage in the Beeline Supplier Network. Each credit represents a specific API action that interacts with key data, such as creating records, submitting candidates, or retrieving detailed job information.
Service Credits help ensure fair usage, system efficiency, and scalability, allowing suppliers to manage their API consumption effectively.
This guide outlines where credits apply and how suppliers can manage their API consumption effectively.
Credit Consumption Model
| API Call Type | Credit Cost | Rate Limits |
|---|---|---|
List All Job Postings (GET) |
Included in plan |
100 calls per minute |
GET Job Posting Details |
First 10 calls per job included in plan |
100 calls per minute |
Additional GET Job Posting Details |
1 credit per call |
100 calls per minute |
List All Workers (GET) |
Included in plan |
100 calls per minute |
GET Worker Detail |
Included in plan |
100 calls per minute |
Create Worker |
1 credit per worker |
100 calls per minute |
Update Worker Details |
1 credit per update |
100 calls per minute |
Submit Candidate |
1 credit per submission |
100 calls per minute |
Resubmit Candidate |
1 credit per resubmission |
100 calls per minute |
Rescind Candidate |
1 credit per withdrawal |
100 calls per minute |
GET Candidate Details |
First 10 calls per candidate included in plan |
100 calls per minute |
Additional GET Candidate Details |
1 credit per call |
100 calls per minute |
|
The rate limit of 100 calls per minute applies to the total number of API calls made across all endpoints combined, not per endpoint. For example, if you make 60 calls to list jobs and 50 calls to get worker details within the same minute, you will exceed the rate limit since the total is 110 calls. |
How Credits Work
GET Requests for Listings (Jobs & Workers) Are Free – Suppliers can retrieve lists of available job postings and workers at no cost.
Job and Candidate Details Have a Fair Use Policy – The first 10 GET calls per job or candidate are included in the plan. Additional details beyond that incur 1 credit per call.
Worker Creation, Updates, and Candidate Submissions Are Charged – Creating a worker, updating their details, submitting, resubmitting, or withdrawing a candidate all incur a credit charge per action.
Best Practices to Optimize Credit Usage
-
Use Webhooks – Avoid polling by subscribing to webhook notifications for job and candidate updates.
-
Retrieve Details Only When Needed – Use the first 10 free calls efficiently before making additional API requests.
-
Manage Worker and Candidate Submissions Wisely – Avoid unnecessary updates and only resubmit candidates when necessary.
For more details, visit our Supplier API Documentation or contact our support team for assistance.