Skip to main content
GET
Get credits balance

Authorizations

Authorization
string
header
required

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.

totalAmount
number
required

Total credits allocated across subscription, add-on, and gift buckets.

totalBalance
number
required

Total credits currently available to spend across all buckets.

subscriptionAmount
number
required

Credits allocated by the current subscription period.

subscriptionBalance
number
required

Subscription credits currently available to spend.

addonAmount
number
required

Total credits allocated through add-on purchases.

addonBalance
number
required

Add-on credits currently available to spend.

addonExpireAt
number | null
required

Unix timestamp for add-on credit expiry, or null when no expiry applies.

giftAmount
number
required

Total promotional or gifted credits allocated.

giftBalance
number
required

Promotional or gifted credits currently available to spend.

resetAt
number | null
required

Unix timestamp for the next subscription-credit reset, or null when unavailable.