Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Réponses
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.

objectstringrequis
Valeurs autorisées :usage
planstring | nullrequis

Effective plan

Valeurs autorisées :freestarterproscalenull
limitsobjectrequis
Afficher les propriétés
emails_per_dayinteger | nullrequis

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

emails_per_monthinteger | nullrequis

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

domainsinteger | nullrequis

null = unlimited

contactsinteger | nullrequis

Contacts the team may hold; null = unlimited

inboxesinteger | nullrequis

Inboxes the team may hold at once; null = unlimited

webhook_endpointsinteger | nullrequis

Webhook endpoints the team may hold; null = unlimited

todayobjectrequis
Afficher les propriétés
emails_sentintegerrequis

Emails accepted so far this UTC day

resets_atstringrequis

Next UTC midnight, when the daily counter resets

periodobject | nullrequis

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

Afficher les propriétés
emails_sentintegerrequis

Emails accepted so far this billing period

includedintegerrequis

Emails the plan includes per period

overage_enabledbooleanrequis

Whether sends past included bill overage instead of being refused

overage_usd_per_1knumberrequis

Overage price per 1,000 emails, in USD

starts_atstringrequis

Billing period start

ends_atstringrequis

Billing period end, when the counter resets

verificationobjectrequis

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

Afficher les propriétés
verifiedintegerrequis

Addresses deep verification gave a definite verdict this quota month

from_grantintegerrequis

Of them, covered by the free credit

meteredintegerrequis

Of them, billed on the monthly invoice

cost_centsintegerrequis

What the billed addresses cost, in cents

price_per_1k_centsintegerrequis

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

teamobjectrequis
Afficher les propriétés
idstring<uuid>requis
namestringrequis
app_urlstring | nullrequis

Dashboard origin, for building links; null when unset

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Restricted API key

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Requête
curl -X GET 'https://api.billionsend.com/usage' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "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"
}

Cette page vous a-t-elle été utile ?