Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Get usage

GET/usage
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Respostas
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; plan, limits and period are null on the instance's own (system) team.

objectstringobrigatório
Valores permitidos:usage
planstring | nullobrigatório

Effective plan; null on the instance's own (system) team

Valores permitidos:freestarterproscalenull
limitsobjectobrigatório
Mostrar propriedades
emails_per_dayinteger | nullobrigatório

Daily cap (UTC day) on Free; null on monthly plans

emails_per_monthinteger | nullobrigatório

Emails included per billing period on Starter, Pro and Scale; null on Free

domainsinteger | nullobrigatório

null = unlimited

contactsinteger | nullobrigatório

Contacts the team may hold; null = unlimited

inboxesinteger | nullobrigatório

Inboxes the team may hold at once; null = unlimited

webhook_endpointsinteger | nullobrigatório

Webhook endpoints the team may hold; null = unlimited

todayobjectobrigatório
Mostrar propriedades
emails_sentintegerobrigatório

Emails accepted so far this UTC day

resets_atstringobrigatório

Next UTC midnight, when the daily counter resets

periodobject | nullobrigatório

Billing-period usage on monthly plans; null on daily plans

Mostrar propriedades
emails_sentintegerobrigatório

Emails accepted so far this billing period

includedintegerobrigatório

Emails the plan includes per period

overage_enabledbooleanobrigatório

Whether sends past included bill overage instead of being refused

overage_usd_per_1knumberobrigatório

Overage price per 1,000 emails, in USD

starts_atstringobrigatório

Billing period start

ends_atstringobrigatório

Billing period end, when the counter resets

verificationobjectobrigatório

Deep verification of contacts this quota month (POST /verifications)

Mostrar propriedades
verifiedintegerobrigatório

Addresses deep verification gave a definite verdict this quota month

from_grantintegerobrigatório

Of them, covered by the free credit

meteredintegerobrigatório

Of them, billed on the monthly invoice

cost_centsintegerobrigatório

What the billed addresses cost, in cents

price_per_1k_centsintegerobrigatório

Price per 1,000 verified addresses past the credit, in cents

teamobjectobrigatório
Mostrar propriedades
idstring<uuid>obrigatório
namestringobrigatório
app_urlstring | nullobrigatório

Dashboard origin, for building links; null when unset

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Restricted API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Requisição
curl -X GET 'https://api.billionsend.com/usage' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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"
}

Esta página foi útil?