Returns both meters, contact credits and premium credits, as separate objects. Premium credits pay for engagers and verified emails. Stored contact delivery uses contact credits. When a premium unit finds no room, the API answers `402 premium_credits.exhausted` with the reset time and an `upgrade_url` for the account owner. Free.
FreeFree.
Returns both meters, contact credits and premium credits, as separate objects. Premium credits pay for engagers and verified emails. Stored contact delivery uses contact credits. When a premium unit finds no room, the API answers 402 premium_credits.exhausted with the reset time and an upgrade_url for the account owner. Free.
The monthly contact credit cap of the plan. On the paid plan, the cap the Fair Usage Policy sets. On the free plan, the lifetime pool: 1,000 contact credits in total, for the life of the account.
contact_credits_per_dayintegerrequired
The daily contact credit cap of the plan. On the paid plan, the cap the Fair Usage Policy sets. On the free plan, the same lifetime pool as contact_credits_per_month.
month_remainingintegerrequired
The contact credits left in the current billing month. A paid plan's month starts on its billing date each month; without a subscription it is the UTC calendar month. On the free plan, the contact credits left in the lifetime pool; the pool has no window.
today_remainingintegerrequired
The contact credits left in the current UTC day. On the free plan, the same number as month_remaining.
bindingenumrequired
The window that runs out first at the current pace. On the free plan, always month.
monthday
resets_atstringrequired
The RFC 3339 UTC time at which the binding window resets. On the free plan the pool never resets, and the field is 9999-12-31T23:59:59.000Z.
premium_creditsPremiumCreditBalancerequired
This month's premium credits. Premium credits pay for engagers and verified emails, and reset on the billing date each month.
Show child attributes
allowanceintegerrequired
The premium credits the plan grants this month, plus any grant that arrived this month.
usedintegerrequired
The premium credits spent this month on delivered premium units.
heldintegerrequired
The premium credits running work holds before it delivers. A hold settles to what was delivered or is released.
availableintegerrequired
The premium credits a new premium unit can take right now: the allowance less used and held, never below zero.
resets_atstringrequired
The RFC 3339 UTC time at which the allowance resets: the next billing date, or the start of the next UTC month without a subscription.