GET /billing/plan
The plan in force (Free until one is bought), the plans, volumes and terms on offer, and what the signed-in person may buy.
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/plan \
-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/plan',
});Python
import json, os, urllib.request
url = 'https://api.agentisend.com/billing/plan'
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: billing. Generated from openapi.json; the anchor get-billing-plan is the id the console's error fix links point at.
Parameters
This operation takes no parameters.
Responses
200— Success401— 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
| Field | Type | Required | Notes |
|---|---|---|---|
| appsumo | object | null | yes | |
| appsumo_deal_url | string | null | yes | |
| appsumo_lifetime_notice | string | null | yes | |
| billing_configured | boolean | yes | |
| billing_term | "month" | "year" | null | yes | |
| entitlements | object | yes | |
| entitlements.included_emails_per_month | integer | yes | |
| entitlements.max_domains | integer | null | yes | |
| entitlements.max_seats | integer | yes | |
| entitlements.overage_minor_per_1000_emails | integer | null | yes | |
| entitlements.retention_days | integer | yes | |
| entitlements.tier | "free" | "starter" | "pro" | "scale" | yes | |
| lifetime | object | null | yes | |
| lifetime_on_sale | boolean | yes | |
| lifetime_plans | array<object> | yes | |
| lifetime_plans[].emails_total | integer | yes | |
| lifetime_plans[].featured | boolean | yes | |
| lifetime_plans[].features_of | "starter" | "pro" | "scale" | yes | |
| lifetime_plans[].max_domains | integer | null | yes | |
| lifetime_plans[].max_emails_per_month | integer | yes | |
| lifetime_plans[].max_seats | integer | yes | |
| lifetime_plans[].name | string | yes | |
| lifetime_plans[].price_minor | integer | yes | |
| lifetime_plans[].price_now_minor | integer | null | yes | |
| lifetime_plans[].retention_days | integer | yes | |
| lifetime_plans[].tier | "tier1" | "tier2" | "tier3" | "tier4" | yes | |
| lifetime_refund_rule | string | yes | |
| lifetime_sales_channel | "own" | "appsumo" | yes | |
| needs_plan_selection | boolean | yes | |
| plan_source | "free" | "subscription" | "manual" | "lifetime" | "appsumo" | yes | |
| plan_status | "none" | "trialing" | "active" | "past_due" | "canceled" | yes | |
| plans | array<object> | yes | |
| plans[].featured | boolean | yes | |
| plans[].included_emails_per_month | integer | yes | |
| plans[].max_domains | integer | null | yes | |
| plans[].max_seats | integer | yes | |
| plans[].name | string | yes | |
| plans[].prices | object | yes | |
| plans[].retention_days | integer | yes | |
| plans[].tier | "starter" | "pro" | "scale" | yes | |
| plans[].volume_rungs | array<object> | yes | |
| purchasable | array<object> | yes | |
| purchasable[].included_emails_per_month | integer | yes | |
| purchasable[].monthly_price_minor | integer | yes | |
| purchasable[].tier | "starter" | "pro" | "scale" | yes | |
| subscription | object | null | yes | |
| terms_on_sale | array<"month" | "year"> | yes | |
| tier | "free" | "starter" | "pro" | "scale" | yes | |
| viewer | object | yes | |
| viewer.can_purchase | boolean | yes | |
| viewer.can_purchase_lifetime | boolean | yes | |
| viewer.role | "owner" | "admin" | "viewer" | null | yes |
Response example
200
{
"appsumo": {
"daily_send_cap": null,
"emails_per_month": -9007199254740991,
"license_key": "example",
"max_domains": -9007199254740991,
"max_seats": -9007199254740991,
"name": "example",
"retention_days": -9007199254740991,
"tier": -9007199254740991
},
"appsumo_deal_url": "example",
"appsumo_lifetime_notice": "example",
"billing_configured": false,
"billing_term": "month",
"entitlements": {
"included_emails_per_month": -9007199254740991,
"max_domains": -9007199254740991,
"max_seats": -9007199254740991,
"overage_minor_per_1000_emails": -9007199254740991,
"retention_days": -9007199254740991,
"tier": "free"
},
"lifetime": {
"emails_left": -9007199254740991,
"emails_total": -9007199254740991,
"emails_used": -9007199254740991,
"max_emails_per_month": -9007199254740991,
"name": "example",
"refundable": false,
"tier": "tier1"
},
"lifetime_on_sale": false,
"lifetime_plans": [],
"lifetime_refund_rule": "example",
"lifetime_sales_channel": "own",
"needs_plan_selection": false,
"plan_source": "free",
"plan_status": "none",
"plans": [],
"purchasable": [],
"subscription": {
"cancel_at_period_end": false,
"current_period_end": "2026-09-04T09:14:00.000Z",
"price_lookup_key": "example",
"status": "example"
},
"terms_on_sale": [],
"tier": "free",
"viewer": {
"can_purchase": false,
"can_purchase_lifetime": false,
"role": "owner"
}
}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.