Limits and pricing

API calls are free. You pay for links, and your plan sets how fast and how much you can make. Your exact numbers are one call away.

See your numbers

Open Plan and limits in the API dashboard, or ask the API. The answer always reflects your current plan and anything EFIQ has set just for your account.

bash
curl https://api-rewards.efiqone.com/v1/Limits \
  -u $ACCOUNT_SID:$AUTH_TOKEN
Response (shortened)
{
  "plan":    { "name": "Pro", "subscription": "PRO", "renews": "2026-12-12T00:00:00Z", "api_access": "active" },
  "limits":  {
    "requests_per_second": 50,
    "services":  { "used": 2, "limit": 10 },
    "api_keys":  { "used": 3, "limit": 10 },
    "links_per_set": 1000000,
    "sets_per_minute": 60,
    "link_reads_per_minute": 2000000
  },
  "pricing": { "price_per_link_paise": 100, "credits_bought_this_month": 5000, "slabs": [ ... ], "requests": "free" },
  "balance": { "plan_credits": 1500, "bought_credits": 25000, "total_credits": 26500 }
}

A null limit means no limit. api_access is active, grace (plan ended, a few days to renew) or off, with api_access_reason saying why, and api_access_via says how you have it: plan, addon or efiq (set for you). In balance, plan_credits is what is left from your plan, bought_credits what you bought and total_credits the two together. This call needs the usage:read scope and works even when API access is off, so you can check why.

What is limited

LimitApplies toWhen you go over
Requests per secondEvery call, across all your keys429 / 22901, retry after 1 second
Links read per minuteHanding out links (Allocate) and streaming a set429 / 22901, retry when the minute ends
New sets per minuteCreating and extending sets429 / 22901, retry when the minute ends
Links in one setCount when creating or extending a set403 / 20309, make another set
ServicesActive Services403 / 20309
API keysKeys not revoked or expired403 / 20309

Going over a limit only refuses the new call. Nothing you already made is changed, paused or deleted.

Rate limit headers

Every response has X-RateLimit-Limit (your requests per second) and X-RateLimit-Remaining (left in this second). A refused call also has Retry-After in seconds. Wait that long, then try again; with an Idempotency-Key a retry can never do the work twice.

Retry on 429
async function call(url, init, tries = 3) {
  const res = await fetch(url, init);
  if (res.status !== 429 || tries === 0) return res;
  const wait = Number(res.headers.get('Retry-After') ?? 1);
  await new Promise((r) => setTimeout(r, wait * 1000));
  return call(url, init, tries - 1);
}

What links cost

  1. A link is paid for when it is made: when you create or extend a set, for the whole count.
  2. Links from your plan are used first. Your plan adds links each time it starts or renews, and unused ones carry over.
  3. After that, links you bought are used.
  4. If together they don’t cover the count, the call fails with 402 / 20204 and nothing is used.

Volume prices

The price of links you buy goes down in slabs as you buy more in a calendar month (India time), and starts again on the 1st. pricing.slabs lists yours, and pricing.price_per_link_paise is the price of the next link you buy. Buy them on Buy links; see Paying for links.

Getting links back

When a set is cancelled or expires, links never handed out come back: bought links first, then plan links. Links already handed out don’t come back.

How plans and the API fit together

You buy one plan for your business in the business portal. It decides both what you can do in the portal (customers, reward types, links each period and how much you can spend buying links) and your API limits above. Upgrading starts at once and raises your limits straight away; a smaller plan starts when the current one ends.

Limits and prices can also be set for a single account without changing its plan. GET /v1/Limits always shows what applies to you.