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.
/usageAuthorizationToken Bearer · headerobligatorioA 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.
objectstringobligatoriousageplanstring | nullobligatorioEffective plan
freestarterproscalenulllimitsobjectobligatorioMostrar propiedadesOcultar propiedades
emails_per_dayinteger | nullobligatorioDaily cap (UTC day) on Free; null on monthly plans
emails_per_monthinteger | nullobligatorioEmails included per billing period on Starter, Pro and Scale; null on Free
domainsinteger | nullobligatorionull = unlimited
contactsinteger | nullobligatorioContacts the team may hold; null = unlimited
inboxesinteger | nullobligatorioInboxes the team may hold at once; null = unlimited
webhook_endpointsinteger | nullobligatorioWebhook endpoints the team may hold; null = unlimited
todayobjectobligatorioMostrar propiedadesOcultar propiedades
emails_sentintegerobligatorioEmails accepted so far this UTC day
resets_atstringobligatorioNext UTC midnight, when the daily counter resets
periodobject | nullobligatorioBilling-period usage on monthly plans; null on daily plans
Mostrar propiedadesOcultar propiedades
emails_sentintegerobligatorioEmails accepted so far this billing period
includedintegerobligatorioEmails the plan includes per period
overage_enabledbooleanobligatorioWhether sends past included bill overage instead of being refused
overage_usd_per_1knumberobligatorioOverage price per 1,000 emails, in USD
starts_atstringobligatorioBilling period start
ends_atstringobligatorioBilling period end, when the counter resets
verificationobjectobligatorioDeep verification of contacts this quota month (POST /verifications)
Mostrar propiedadesOcultar propiedades
verifiedintegerobligatorioAddresses deep verification gave a definite verdict this quota month
from_grantintegerobligatorioOf them, covered by the free credit
meteredintegerobligatorioOf them, billed on the monthly invoice
cost_centsintegerobligatorioWhat the billed addresses cost, in cents
price_per_1k_centsintegerobligatorioPrice per 1,000 verified addresses past the credit, in cents
teamobjectobligatorioMostrar propiedadesOcultar propiedades
idstring<uuid>obligatorionamestringobligatorioapp_urlstring | nullobligatorioDashboard origin, for building links; null when unset
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioRestricted API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio