Docs / API Reference / Credits

Credits

Credits are consumed by lead searches and email enrichment. Use the Credits API to check your available balance and audit transaction history before running automated workflows.

Credits reset monthly on your billing anniversary. Bonus credits (from coupons or adjustments) carry forward and are spent first.

Get Balance

GET/api/v1/credits/balanceauth

Retrieve the current credit balance for your organisation.

json
{
  "success": true,
  "data": {
    "monthlyCredits": 100,
    "bonusCredits": 25,
    "usedCredits": 43,
    "availableCredits": 82,
    "resetDay": 1,
    "lastResetAt": "2026-05-01T00:00:00.000Z"
  }
}

availableCredits = monthlyCredits + bonusCredits − usedCredits. Always check this before triggering large searches or enrichment jobs.

curl
curl https://leadsapi.postorbit.io/api/v1/credits/balance \
  -H "Authorization: Bearer $LOCALLEADS_API_KEY"

List Transactions

GET/api/v1/credits/transactionsauth

Retrieve a paginated history of credit deductions and top-ups.

Query parameters

limit
number
default 50

Number of transactions to return. Max 100.

offset
number
default 0

Number of records to skip (for pagination).

json
{
  "success": true,
  "data": [
    {
      "id": "txn_abc123",
      "type": "DEDUCTION",
      "amount": -12,
      "description": "Lead search: Dentists in Austin, TX (97 results)",
      "createdAt": "2026-05-05T10:01:00.000Z"
    },
    {
      "id": "txn_def456",
      "type": "MONTHLY_RESET",
      "amount": 100,
      "description": "Monthly credit reset",
      "createdAt": "2026-05-01T00:00:00.000Z"
    }
  ],
  "meta": { "total": 28, "limit": 50, "offset": 0 }
}
curl
curl "https://leadsapi.postorbit.io/api/v1/credits/transactions?limit=10" \
  -H "Authorization: Bearer $LOCALLEADS_API_KEY"
Integrate a credit check at the start of your automation pipeline — fetch balance, verify availableCredits >= estimatedCost, then proceed. This prevents partial jobs from running when credits run out mid-way.
←EnrichmentAPI Keys→