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.
/usageAuthorizationBearer-Token · headererforderlichA 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.
objectstringerforderlichusageplanstring | nullerforderlichEffective plan
freestarterproscalenulllimitsobjecterforderlichEigenschaften anzeigenEigenschaften ausblenden
emails_per_dayinteger | nullerforderlichDaily cap (UTC day) on Free; null on monthly plans
emails_per_monthinteger | nullerforderlichEmails included per billing period on Starter, Pro and Scale; null on Free
domainsinteger | nullerforderlichnull = unlimited
contactsinteger | nullerforderlichContacts the team may hold; null = unlimited
inboxesinteger | nullerforderlichInboxes the team may hold at once; null = unlimited
webhook_endpointsinteger | nullerforderlichWebhook endpoints the team may hold; null = unlimited
todayobjecterforderlichEigenschaften anzeigenEigenschaften ausblenden
emails_sentintegererforderlichEmails accepted so far this UTC day
resets_atstringerforderlichNext UTC midnight, when the daily counter resets
periodobject | nullerforderlichBilling-period usage on monthly plans; null on daily plans
Eigenschaften anzeigenEigenschaften ausblenden
emails_sentintegererforderlichEmails accepted so far this billing period
includedintegererforderlichEmails the plan includes per period
overage_enabledbooleanerforderlichWhether sends past included bill overage instead of being refused
overage_usd_per_1knumbererforderlichOverage price per 1,000 emails, in USD
starts_atstringerforderlichBilling period start
ends_atstringerforderlichBilling period end, when the counter resets
verificationobjecterforderlichDeep verification of contacts this quota month (POST /verifications)
Eigenschaften anzeigenEigenschaften ausblenden
verifiedintegererforderlichAddresses deep verification gave a definite verdict this quota month
from_grantintegererforderlichOf them, covered by the free credit
meteredintegererforderlichOf them, billed on the monthly invoice
cost_centsintegererforderlichWhat the billed addresses cost, in cents
price_per_1k_centsintegererforderlichPrice per 1,000 verified addresses past the credit, in cents
teamobjecterforderlichEigenschaften anzeigenEigenschaften ausblenden
idstring<uuid>erforderlichnamestringerforderlichapp_urlstring | nullerforderlichDashboard origin, for building links; null when unset
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichRestricted API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich