Me Usage
Return the calling account's credit balance and what it can still buy.
credits is the balance. One pool funds every billable capability, at the weights in costs — today verify 10, assess 1, ask 1. It has two buckets: the monthly allowance for the current plan, which resets at resets_at, and non-expiring extra credits from grants and top-ups, spent only once the allowance is gone. remaining is the sum, and is what a call is actually checked against.
The current shape is credits, costs, cost_options, extract, plan, plan_label and has_webhook_secret. Callers on API version 2026-05-13 also get the deprecated fields below, which are kept for them: credits.bonus, quota_resets_at (the same as credits.resets_at) and the verify / ask / assess blocks.
credits.bonus (2026-05-13 only) is the deprecated old name of credits.extra, the same number. Read extra.
plan is the stable slug to branch on; plan_label is the same tier as display copy ("Pro"). Two fields rather than one humanised string, so a reworded label cannot break a client comparing tiers. The Pro plan's plan is pro; it read developer before 2026-09-15, while plan_label already read "Pro".
The per-capability blocks are deprecated (2026-05-13 only). verify / ask / assess are projections of that one pool into each capability's own unit — "how many of these could I still make" — not separate allowances. Spending on one moves all of them, and they are floor divisions, so a verify block ticks once per 10 credits spent anywhere.
Read credits and costs instead; the blocks and the per-block credits alias stay for 2026-05-13 callers. Derive them::
remaining = credits.remaining // costs[capability]
total = credits.total // costs[capability]
used = total - remaining
Two capabilities at the same price emit identical blocks — ask and assess are both 1 credit — which is the clearest sign the shape describes an allowance that no longer exists.
bonus in each block is credits.extra in that capability's unit. The older key credits is its deprecated alias, kept for the same callers.
costs is one entry per capability at its DEFAULT price. Prices that depend on a request parameter live in cost_options, nested capability → parameter → value — {"verify": {"depth": {"standard": 10, "low": 5}}}. Two maps rather than a flat one with a verify_low key, so a future tuning parameter nests instead of adding an entry that reads like a fifth capability. Every capability in cost_options also appears in costs at its default, so reading only costs is always correct.
extract is free at the pool (costs.extract is 0) and is bounded by a per-account daily fair-use cap instead, reported separately here and rejected with 429 rather than 402.
Versions. 200: 2026-10-11 receives MeUsageOut, 2026-05-13 receives MeUsageOutLegacy; default: 2026-10-11 receives ErrorOut, 2026-05-13 receives ErrorOutLegacy.
Request
- Base URL: https://lenz.io
- URL: https://lenz.io/api/v1/me/usage
- Auth: HTTP bearer
Headers
The API version to answer in, as a date. A date before 2026-10-11 (or a value that is not a date) gets 2026-05-13. See https://lenz.io/docs/api-versions.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.