Get usage
Your plan, its send, domain, contact, inbox and webhook endpoint limits, today’s accepted send count (UTC day), on a monthly plan this billing period’s usage, and this month’s deep verification. BillionSend extension.
/usageAuthorizationJeton Bearer · headerrequisA 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.
objectstringrequisusageplanstring | nullrequisEffective plan
freestarterproscalenulllimitsobjectrequisAfficher les propriétésMasquer les propriétés
emails_per_dayinteger | nullrequisDaily cap (UTC day) on Free; null on monthly plans
emails_per_monthinteger | nullrequisEmails included per billing period on Starter, Pro and Scale; null on Free
domainsinteger | nullrequisnull = unlimited
contactsinteger | nullrequisContacts the team may hold; null = unlimited
inboxesinteger | nullrequisInboxes the team may hold at once; null = unlimited
webhook_endpointsinteger | nullrequisWebhook endpoints the team may hold; null = unlimited
todayobjectrequisAfficher les propriétésMasquer les propriétés
emails_sentintegerrequisEmails accepted so far this UTC day
resets_atstringrequisNext UTC midnight, when the daily counter resets
periodobject | nullrequisBilling-period usage on monthly plans; null on daily plans
Afficher les propriétésMasquer les propriétés
emails_sentintegerrequisEmails accepted so far this billing period
includedintegerrequisEmails the plan includes per period
overage_enabledbooleanrequisWhether sends past included bill overage instead of being refused
overage_usd_per_1knumberrequisOverage price per 1,000 emails, in USD
starts_atstringrequisBilling period start
ends_atstringrequisBilling period end, when the counter resets
verificationobjectrequisDeep verification of contacts this quota month (POST /verifications)
Afficher les propriétésMasquer les propriétés
verifiedintegerrequisAddresses deep verification gave a definite verdict this quota month
from_grantintegerrequisOf them, covered by the free credit
meteredintegerrequisOf them, billed on the monthly invoice
cost_centsintegerrequisWhat the billed addresses cost, in cents
price_per_1k_centsintegerrequisPrice per 1,000 verified addresses past the credit, in cents
teamobjectrequisAfficher les propriétésMasquer les propriétés
idstring<uuid>requisnamestringrequisapp_urlstring | nullrequisDashboard origin, for building links; null when unset
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisRestricted API key
statusCodenumberrequisnamestringrequismessagestringrequisOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis