Account
Get Credit Usage
GET
Get your current billing cycle credit usage at a glance — plan info, credits used, credits remaining, and a breakdown by entity type.
Response Fields
plan
| Field | Type | Description |
|---|---|---|
name | string | Plan name (e.g. No plan, Starter, Pro) |
is_paid | boolean | Whether this is a paid plan |
billing_cycle
| Field | Type | Description |
|---|---|---|
start | string | ISO 8601 start of the current billing cycle |
end | string | ISO 8601 end of the current billing cycle (credits reset at this time) |
credits
| Field | Type | Description |
|---|---|---|
included | number | Total credits included in your plan for this billing cycle |
used | number | Credits consumed so far this billing cycle |
remaining | number | Credits remaining before overages begin |
overage | number | Credits used beyond your included allowance (billed separately) |
credits.breakdown
| Field | Type | Description |
|---|---|---|
properties | number | Unique properties accessed this billing cycle |
people | number | Unique people accessed this billing cycle |
companies | number | Unique companies accessed this billing cycle |
Credits are deduplicated within your billing period. Accessing the same property or contact
multiple times in one billing cycle only counts once.