Get credits balance
Return the current credit position for the authenticated API key owner without spending credits.
Use this endpoint before and after any workflow that can consume credits, including event access, Visitor access, contact enrichment, and charged company searches. The response separates subscription, add-on, and gift balances so a client can show both the usable total and the buckets that contribute to it.
This is a read-only account check. A successful response does not reserve credits or guarantee that a later paid action will still have sufficient balance, so refresh the balance immediately before user-confirmed spending and again after the action completes.
Authorizations
Send the full Business API key from Settings -> API Keys, for example Authorization: Bearer sk_your_api_key.
Response
Credits balance
Current total and per-bucket Lensmor credit amounts for the API key owner.
Total credits allocated across subscription, add-on, and gift buckets.
Total credits currently available to spend across all buckets.
Credits allocated by the current subscription period.
Subscription credits currently available to spend.
Total credits allocated through add-on purchases.
Add-on credits currently available to spend.
Unix timestamp for add-on credit expiry, or null when no expiry applies.
Total promotional or gifted credits allocated.
Promotional or gifted credits currently available to spend.
Unix timestamp for the next subscription-credit reset, or null when unavailable.