Get usage
/usageAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Effective plan, its send, domain, contact, inbox and webhook endpoint limits, today's accepted send count (UTC day), on a monthly plan the billing period's usage, and this quota month's deep verification. BillionSend extension; plan, limits and period are null on the instance's own (system) team.
objectstringrequiredusageplanstring | nullrequiredEffective plan; null on the instance's own (system) team
freestarterproscalenulllimitsobjectrequiredShow propertiesHide properties
emails_per_dayinteger | nullrequiredDaily cap (UTC day) on Free; null on monthly plans
emails_per_monthinteger | nullrequiredEmails included per billing period on Starter, Pro and Scale; null on Free
domainsinteger | nullrequirednull = unlimited
contactsinteger | nullrequiredContacts the team may hold; null = unlimited
inboxesinteger | nullrequiredInboxes the team may hold at once; null = unlimited
webhook_endpointsinteger | nullrequiredWebhook endpoints the team may hold; null = unlimited
todayobjectrequiredShow propertiesHide properties
emails_sentintegerrequiredEmails accepted so far this UTC day
resets_atstringrequiredNext UTC midnight, when the daily counter resets
periodobject | nullrequiredBilling-period usage on monthly plans; null on daily plans
Show propertiesHide properties
emails_sentintegerrequiredEmails accepted so far this billing period
includedintegerrequiredEmails the plan includes per period
overage_enabledbooleanrequiredWhether sends past included bill overage instead of being refused
overage_usd_per_1knumberrequiredOverage price per 1,000 emails, in USD
starts_atstringrequiredBilling period start
ends_atstringrequiredBilling period end, when the counter resets
verificationobjectrequiredDeep verification of contacts this quota month (POST /verifications)
Show propertiesHide properties
verifiedintegerrequiredAddresses deep verification gave a definite verdict this quota month
from_grantintegerrequiredOf them, covered by the free credit
meteredintegerrequiredOf them, billed on the monthly invoice
cost_centsintegerrequiredWhat the billed addresses cost, in cents
price_per_1k_centsintegerrequiredPrice per 1,000 verified addresses past the credit, in cents
teamobjectrequiredShow propertiesHide properties
idstring<uuid>requirednamestringrequiredapp_urlstring | nullrequiredDashboard origin, for building links; null when unset
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredRestricted API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired