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 令牌 · header必填A 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.
objectstring必填usageplanstring | null必填Effective plan
freestarterproscalenulllimitsobject必填显示属性隐藏属性
emails_per_dayinteger | null必填Daily cap (UTC day) on Free; null on monthly plans
emails_per_monthinteger | null必填Emails included per billing period on Starter, Pro and Scale; null on Free
domainsinteger | null必填null = unlimited
contactsinteger | null必填Contacts the team may hold; null = unlimited
inboxesinteger | null必填Inboxes the team may hold at once; null = unlimited
webhook_endpointsinteger | null必填Webhook endpoints the team may hold; null = unlimited
todayobject必填显示属性隐藏属性
emails_sentinteger必填Emails accepted so far this UTC day
resets_atstring必填Next UTC midnight, when the daily counter resets
periodobject | null必填Billing-period usage on monthly plans; null on daily plans
显示属性隐藏属性
emails_sentinteger必填Emails accepted so far this billing period
includedinteger必填Emails the plan includes per period
overage_enabledboolean必填Whether sends past included bill overage instead of being refused
overage_usd_per_1knumber必填Overage price per 1,000 emails, in USD
starts_atstring必填Billing period start
ends_atstring必填Billing period end, when the counter resets
verificationobject必填Deep verification of contacts this quota month (POST /verifications)
显示属性隐藏属性
verifiedinteger必填Addresses deep verification gave a definite verdict this quota month
from_grantinteger必填Of them, covered by the free credit
meteredinteger必填Of them, billed on the monthly invoice
cost_centsinteger必填What the billed addresses cost, in cents
price_per_1k_centsinteger必填Price per 1,000 verified addresses past the credit, in cents
teamobject必填显示属性隐藏属性
idstring<uuid>必填namestring必填app_urlstring | null必填Dashboard origin, for building links; null when unset
Missing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填Restricted API key
statusCodenumber必填namestring必填messagestring必填Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumber必填namestring必填messagestring必填