Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Respuestas
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.

objectstringobligatorio
Valores permitidos:usage
planstring | nullobligatorio

Effective plan

Valores permitidos:freestarterproscalenull
limitsobjectobligatorio
Mostrar propiedades
emails_per_dayinteger | nullobligatorio

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

emails_per_monthinteger | nullobligatorio

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

domainsinteger | nullobligatorio

null = unlimited

contactsinteger | nullobligatorio

Contacts the team may hold; null = unlimited

inboxesinteger | nullobligatorio

Inboxes the team may hold at once; null = unlimited

webhook_endpointsinteger | nullobligatorio

Webhook endpoints the team may hold; null = unlimited

todayobjectobligatorio
Mostrar propiedades
emails_sentintegerobligatorio

Emails accepted so far this UTC day

resets_atstringobligatorio

Next UTC midnight, when the daily counter resets

periodobject | nullobligatorio

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

Mostrar propiedades
emails_sentintegerobligatorio

Emails accepted so far this billing period

includedintegerobligatorio

Emails the plan includes per period

overage_enabledbooleanobligatorio

Whether sends past included bill overage instead of being refused

overage_usd_per_1knumberobligatorio

Overage price per 1,000 emails, in USD

starts_atstringobligatorio

Billing period start

ends_atstringobligatorio

Billing period end, when the counter resets

verificationobjectobligatorio

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

Mostrar propiedades
verifiedintegerobligatorio

Addresses deep verification gave a definite verdict this quota month

from_grantintegerobligatorio

Of them, covered by the free credit

meteredintegerobligatorio

Of them, billed on the monthly invoice

cost_centsintegerobligatorio

What the billed addresses cost, in cents

price_per_1k_centsintegerobligatorio

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

teamobjectobligatorio
Mostrar propiedades
idstring<uuid>obligatorio
namestringobligatorio
app_urlstring | nullobligatorio

Dashboard origin, for building links; null when unset

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Solicitud
curl -X GET 'https://api.billionsend.com/usage' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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"
}

¿Te ha resultado útil esta página?