Get usage
/usageAuthorizationToken Bearer · headerobrigatórioA 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.
objectstringobrigatóriousageplanstring | nullobrigatórioEffective plan; null on the instance's own (system) team
freestarterproscalenulllimitsobjectobrigatórioMostrar propriedadesOcultar propriedades
emails_per_dayinteger | nullobrigatórioDaily cap (UTC day) on Free; null on monthly plans
emails_per_monthinteger | nullobrigatórioEmails included per billing period on Starter, Pro and Scale; null on Free
domainsinteger | nullobrigatórionull = unlimited
contactsinteger | nullobrigatórioContacts the team may hold; null = unlimited
inboxesinteger | nullobrigatórioInboxes the team may hold at once; null = unlimited
webhook_endpointsinteger | nullobrigatórioWebhook endpoints the team may hold; null = unlimited
todayobjectobrigatórioMostrar propriedadesOcultar propriedades
emails_sentintegerobrigatórioEmails accepted so far this UTC day
resets_atstringobrigatórioNext UTC midnight, when the daily counter resets
periodobject | nullobrigatórioBilling-period usage on monthly plans; null on daily plans
Mostrar propriedadesOcultar propriedades
emails_sentintegerobrigatórioEmails accepted so far this billing period
includedintegerobrigatórioEmails the plan includes per period
overage_enabledbooleanobrigatórioWhether sends past included bill overage instead of being refused
overage_usd_per_1knumberobrigatórioOverage price per 1,000 emails, in USD
starts_atstringobrigatórioBilling period start
ends_atstringobrigatórioBilling period end, when the counter resets
verificationobjectobrigatórioDeep verification of contacts this quota month (POST /verifications)
Mostrar propriedadesOcultar propriedades
verifiedintegerobrigatórioAddresses deep verification gave a definite verdict this quota month
from_grantintegerobrigatórioOf them, covered by the free credit
meteredintegerobrigatórioOf them, billed on the monthly invoice
cost_centsintegerobrigatórioWhat the billed addresses cost, in cents
price_per_1k_centsintegerobrigatórioPrice per 1,000 verified addresses past the credit, in cents
teamobjectobrigatórioMostrar propriedadesOcultar propriedades
idstring<uuid>obrigatórionamestringobrigatórioapp_urlstring | nullobrigatórioDashboard origin, for building links; null when unset
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioRestricted API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório