Skip to content
Browse the docs

GET /billing

Plan, usage against each published limit, and what the next tier changes.

Request

The same call in curl, Node and Python. A path id in the sample is a placeholder.

curl

curl -sS -X GET https://api.agentisend.com/billing \
  -H "Authorization: Bearer $AGENTISEND_API_KEY"

Node

import { AgentiSend } from 'agentisend';

const client = new AgentiSend(process.env.AGENTISEND_API_KEY);
const result = await client.request({
  method: 'GET',
  path: '/billing',
});

Python

import json, os, urllib.request

url = 'https://api.agentisend.com/billing'
headers = {'Authorization': 'Bearer ' + os.environ['AGENTISEND_API_KEY']}
request = urllib.request.Request(url, headers=headers, method='GET')
print(urllib.request.urlopen(request).read().decode())

Tag: usage. Generated from openapi.json; the anchor get-billing is the id the console's error fix links point at.

Parameters

This operation takes no parameters.

Responses

  • 200 — Success
  • 401 — No usable credential was sent. Codes: agent_signup_code_rejected, missing_api_key, session_required, mfa_required, appsumo_signature_invalid.
  • 403 — The credential may not do this, or the account or key is stopped. Codes: sending_domain_blocked, young_domain_held, domain_sending_disabled, inbound_sender_refused, domain_not_verified, onboarding_recipient_not_a_member, onboarding_sender_unavailable, account_suspended, account_sandboxed, agent_unconfirmed, recipient_ramp, human_action_required, csrf_origin_rejected, charge_not_this_account, invalid_api_key, restricted_api_key, insufficient_role, invite_email_mismatch, domain_scope_violation, dedicated_ip_assigned_by_us, approval_required, staff_review_required, trust_paused, kill_switch_active.
  • 404 — Nothing with this id exists on the account. Codes: billing_customer_missing, not_found, session_expired, support_ticket_not_found.
  • 429 — A rate, quota or ramp ceiling was reached. Codes: onboarding_daily_cap_reached, trust_throttled, invite_limit_reached, rate_ceiling_exceeded, daily_quota_exceeded, monthly_quota_exceeded, rate_limit_exceeded, support_rate_limited, appsumo_lookup_limited.
  • 500 — Something failed on our side. Codes: internal_server_error.

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
currencystringyes
limitsarray<object>yes
limits[].at_limitstringyes
limits[].labelstringyes
limits[].limitinteger | nullyes
limits[].metric"emails_per_month" | "lifetime_emails" | "domains" | "seats" | "retention_days"yes
limits[].unitstringyes
limits[].usedintegeryes
next_tierobject | nullyes
overageobjectyes
overage.auto_chargesbooleanyes
overage.availablebooleanyes
overage.cap_emailsinteger | nullyes
overage.consumed_this_periodintegeryes
overage.enabledbooleanyes
overage.policy"pause" | "bill"yes
overage.rate_minor_per_1000integer | nullyes
overage.textstringyes
paymentobjectyes
payment.textstringyes
payment.writes_enabledbooleanyes
periodobjectyes
period.daysintegeryes
period.resets_atstringyes
period.started_atstringyes
planobjectyes
plan.idstringyes
plan.included_emails_per_monthintegeryes
plan.max_domainsinteger | nullyes
plan.max_seatsintegeryes
plan.monthly_price_minorintegeryes
plan.namestringyes
plan.overage_minor_per_1000_emailsinteger | nullyes
plan.retention_daysintegeryes
pricing_document_versionintegeryes

Response example

200
{
  "currency": "example",
  "limits": [],
  "next_tier": {
    "id": "example",
    "included_emails_per_month": -9007199254740991,
    "max_domains": -9007199254740991,
    "max_seats": -9007199254740991,
    "monthly_price_minor": -9007199254740991,
    "name": "example",
    "overage_minor_per_1000_emails": -9007199254740991,
    "retention_days": -9007199254740991
  },
  "overage": {
    "auto_charges": false,
    "available": false,
    "cap_emails": -9007199254740991,
    "consumed_this_period": -9007199254740991,
    "enabled": false,
    "policy": "pause",
    "rate_minor_per_1000": -9007199254740991,
    "text": "example"
  },
  "payment": {
    "text": "example",
    "writes_enabled": false
  },
  "period": {
    "days": -9007199254740991,
    "resets_at": "2026-09-04T09:14:00.000Z",
    "started_at": "2026-09-04T09:14:00.000Z"
  },
  "plan": {
    "id": "example",
    "included_emails_per_month": -9007199254740991,
    "max_domains": -9007199254740991,
    "max_seats": -9007199254740991,
    "monthly_price_minor": -9007199254740991,
    "name": "example",
    "overage_minor_per_1000_emails": -9007199254740991,
    "retention_days": -9007199254740991
  },
  "pricing_document_version": -9007199254740991
}

Errors

The codes this operation can answer with, and what to do about each. Every one arrives with its code, message, fix and docs_url.

  • internal_server_error (500, internal_server_error) — Unexpected error. Fix: Retry ONCE after a short pause, with the same Idempotency-Key so the retry cannot double-send. If it fails again, stop retrying and report the x-request-id from the response — that id is what identifies this exact failure in support.
  • invalid_api_key (403, invalid_api_key) — API key is invalid or revoked. Fix: Create a new key with POST /api-keys; deleted keys cannot be restored.
  • mfa_required (401) — This session has not completed two-factor authentication. Fix: Finish signing in at https://console.agentisend.com/verify with a code from your authenticator app, or one of your recovery codes. Manage the second factor in the console under Settings, Security.
  • missing_api_key (401, missing_api_key) — Missing API key in authorization header. Fix: Create an API key at https://console.agentisend.com/api-keys and send "Authorization: Bearer as_...". MCP clients can connect with OAuth instead of a key.
  • not_found (404, not_found) — Endpoint or resource does not exist. Fix: List that resource on this account and use an id from the list. For a domain, GET /domains accepts the id or the domain name. A path that is not a route is a typo in the URL.
  • rate_limit_exceeded (429, rate_ceiling_exceeded, rate_limit_exceeded) — Too many requests. Fix: Back off and retry honoring the Retry-After header.
  • restricted_api_key (403, restricted_api_key) — This API key is restricted to sending only. Fix: Use a full_access key (POST /api-keys with permission=full_access) for management endpoints.