Account

Your allowance, credit balance, limits and callback settings.

Returned byaccount.getaccount.update

Fields #

FieldTypeNotes
org_idstring
quota.unlimitedbooleanWhen true, no monthly ceiling applies and limit is not meaningful. remaining may still be bounded - by balance.
quota.limitnumberThe monthly ceiling in credits.
quota.usednumberMonth to date, UTC.
quota.remainingnumberThe number to plan against: the smaller of what the month still allows and what has been paid for, so it is always the one that will refuse the next request. Never negative.
quota.balancenumberPrepaid credits, which do not expire and no month resets. Present only where credits have been bought - absent is not zero, so read it for presence. It may go negative: a little, because work is charged after it is done, and by whatever is owed on an account that has arranged to be invoiced in arrears. Plan against remaining, which is the distance to the line this account actually stops at; at that line, submissions answer 402 insufficient_credits.
webhook_urlstringThe default completion destination.
webhook_secretstringWhat signs your deliveries, wherever they go - the standing URL or a per-batch callback_url. Returned in full, because you need it to verify. Present even when webhook_url is empty.
rate_limit.requests_per_minuteintegerPer key. Null means no limit.
rate_limit.concurrent_batchesintegerPer organization. Null means no limit.
rate_limit.sync_requests_per_minuteintegerRequests a minute to the /sync routes, per organization. Null means no limit.
rate_limit.sync_concurrent_requestsintegerSynchronous requests in flight at once, per organization. Usually the one that binds. Null means no limit.
rate_limit.credits_per_hournumberAn agreed spend ceiling per rolling hour, in credits. Null unless one was agreed - it is not the monthly allowance, and only new submissions wait on it.

Absent is not null: a field we did not get is omitted rather than sent as an empty string, so you can tell "LinkedIn does not have this" from "this person left it blank".

Sample #

JSON
{
  "org_id": "6b1f0e2a-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
  "quota": {
    "unlimited": false,
    "limit": 25000,
    "used": 4182.5,
    "remaining": 20817.5,
    "balance": 95817.5
  },
  "webhook_url": "https://app.example.com/hooks/enrichment",
  "webhook_secret": "whsec_9f2k3jd82ka0...",
  "rate_limit": {
    "requests_per_minute": 300,
    "concurrent_batches": 5,
    "sync_requests_per_minute": 60,
    "sync_concurrent_requests": 2,
    "credits_per_hour": null
  }
}