Skip to main content

Active contacts consumed in the current billing month, with a day-by-day breakdown. A contact counts once per pool per month, on the day it is first touched, however many times it is contacted afterwards.

billingMonthStart
string<date-time>
required

First day of the current billing month.

billingMonthEnd
string<date-time>
required

Exclusive end of the current billing month, which is the first day of the next one.

poolType
enum<string>
required

How the monthly active contacts allowance is measured. shared is a single capped pool, and is the only value for which available and remaining carry a number. unlimited is a shared pool with no cap. perUser means the plan meters contacts against each user rather than from a shared pool.

Available options:
shared,
unlimited,
perUser
aiSdrContactsIncluded
boolean
required

Whether contacts touched by AI SDR sequences draw on this pool. Determined by the plan.

computedAt
string<date-time>
required

When the daily figures were calculated. They are cached for up to 30 minutes, so this can be earlier than generatedAt.

used
integer
required

Contacts consumed so far this billing month.

daily
Active Contacts Daily Usage · object[]
required

One entry per day, from the first day of the billing month through today. Days still to come in the month are not included.

available
integer | null

Size of the pool for the month. Null unless poolType is shared.

remaining
integer | null

available minus used, never below zero. Null unless poolType is shared.