Paying for links
API calls are free. You pay for links: the links in your plan are used first, then the links you buy.
Who can use the API
| Account | API access |
|---|---|
| Business or Enterprise plan | Included |
| Another plan, with an add-on or grant from EFIQ | Included |
| Business portal plans | Not included: 402 / 20203 |
| No plan | Not included: 402 / 20201 |
If a plan lapses you keep read-only access for 3 days (writes return 402 / 20202). Links already sent keep working regardless.
How each link is paid
- If your plan has links left, the link uses one. Your plan adds links each time it starts or renews, and unused ones carry over.
- Otherwise it uses a link you bought.
- With neither, the call fails with
402/20204and nothing is used.
Each successful create returns X-EFIQ-Credits-Remaining: the links you have left, from your plan and bought together.
Sets and batches
Creating or extending a set, or starting a batch, takes links for the whole count up front, all or nothing: plan links first, then bought links. Links that are never handed out come back when a set is cancelled or expires, and so do batch items that don’t make a link (a duplicate, or out of stock): bought links first, then plan links. Links already handed out don’t come back.
Buying links
Open Buy links in the API dashboard or the business portal. Pick a pack of 1,000, 5,000, 10,000 or 50,000, or type any number from 100 to 1,00,00,000, and pay with UPI, cards or net banking. Bought links never expire and work for the API and the portal alike.
The price per link goes down as you buy more in a calendar month (India time) and starts again on the 1st. Your plan also sets how much you can spend on links each plan period; a purchase over that is refused with 403 / 20309. See Limits and pricing for your slabs and GET /v1/Limits.
Every purchase, link used, link returned and change made by EFIQ is listed under History on Buy links.