跳到内容
Esc
↑↓导航↵打开⌘J预览

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.

GET/usage
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

响应
200

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必填
允许值:usage
planstring | null必填

Effective plan

允许值:freestarterproscalenull
limitsobject必填
显示属性
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

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Restricted API key

statusCodenumber必填
namestring必填
messagestring必填
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
请求
curl -X GET 'https://api.billionsend.com/usage' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "object": "usage",
  "plan": "free",
  "limits": {
    "emails_per_day": 0,
    "emails_per_month": 0,
    "domains": 0,
    "contacts": 0,
    "inboxes": 0,
    "webhook_endpoints": 0
  },
  "today": {
    "emails_sent": 0,
    "resets_at": "string"
  },
  "period": {
    "emails_sent": 0,
    "included": 0,
    "overage_enabled": true,
    "overage_usd_per_1k": 0,
    "starts_at": "string",
    "ends_at": "string"
  },
  "verification": {
    "verified": 0,
    "from_grant": 0,
    "metered": 0,
    "cost_cents": 0,
    "price_per_1k_cents": 0
  },
  "team": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "app_url": "string"
}

这个页面有帮助吗?