Skip to main content
GET
Get your balance

Authorizations

Authorization
string
header
required

An Intent Leads API key, e.g. il_live_ followed by 32 letters and digits. Create one on the API and CLI page of the dashboard.

Response

The balance.

month
object
required
meters
object
required

Intent covers intent leads and website visitors.

this_organization
object
required

This organization (or workspace) alone, this month.

paid_by
enum<string>
required
Available options:
this_organization,
parent_organization
prices
object
required
top_ups
object
required
balance_usd
number

Your organization's prepaid balance. Workspaces spend their organization's. Not shown to a workspace's own key (it may belong to a client): that gets workspace_budget instead, and none of the balance fields.

held_by_running_exports_usd
number

Held for exports still running; released when they finish, less the people delivered.

available_usd
number

balance_usd less what's held.

expires_at
string<date-time> | null

When the balance expires unless something is added or spent first (3 months after the last top-up, grant or spending). Null when there's nothing to expire.

expiry_rule
string

The expiry rule in words.

workspace_budget
object

Only with a workspace's own key: what the workspace may spend each billing month, across intent leads, search results and website visitors.

monthly_topup
object | null

Admin keys: the monthly top-up (plan, amount_usd, status, renews_on, by_card), or null.

workspaces
object[]

Admin keys of an organization with workspaces: each one's people and dollars this month and its budget (as in List workspaces).