account

Get Account

Report the key's plan and what it has used: verifications this month, watches, and a free key's searches today.

Reading it is free: it counts no verification and no search.

Args: key: Injected: the caller's key and plan (any key, free included). caller: Injected caller, for where its searches are counted. keys: Injected ApiKeyRepository, for the month's verifications. monitoring: Injected MonitoringRepository, for the watch count. searches: Injected SearchCountRepository, for a free key's searches today.

Returns: The plan and its usage.

get/account

Request

  • Base URL: https://api.licenscheck.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.licenscheck.com/account
  • Auth: none declared

Response

Successful Response

plan'partner' | 'api' | 'starter' | 'free' required

The plan an API key is on, which sets its rate limits and included verifications (see app/access/limits.py).

verifications_usedinteger required

Verifications this UTC month: each license whose verdict, links or watch the key read, once a day.

verifications_includedinteger nullable required

Verifications a month the plan includes before overage; null for no cap.

overage_centsinteger nullable required

What each verification past the included ones costs, in US cents; null for a plan without overage.

month_resets_onstring date required

The UTC day the month's verification count starts again.

watches_usedinteger required

Contractors the key watches now.

watches_includedinteger nullable required

Contractors the plan may watch at once (0 on a free key); null for no cap.

searches_left_todayinteger nullable required

Searches left before midnight UTC on a free key; null on a paid plan, which has no daily search limit.

searches_per_dayinteger nullable required

A free key's searches a day; null on a paid plan.

Changes

No recorded changes to this operation across all 1 revision of this API.