Billing
HTTPBearerAuthorizationBearer <token>Successful Response
application/json- response
Combined billing response — plan + usage.
plan*Current subscription plan details.
"Listen, I'm a politician, which means I'm a cheat and a liar, and when I'm not kissing babies I'm stealing their lollipops." — The President, The Naked Gun 2½
subscribed_tier_ids?array<string>[]usage*Usage metrics for the current billing period.
Note: webhost_nodes and total_hosted_sites are tenant-wide aggregates (not customer-scoped) because hosting infrastructure is provisioned at the tenant level. All other usage fields are customer-scoped via subscription.
curl -X GET 'https://example.com/v1/billing'{ "plan": { "api_call_limit": 10000, "billing_cycle": "string", "conversation_limit": 1000, "current_period_end": "string", "current_period_start": "string", "instance_limit": 1, "max_sites_per_node": 25, "plan_name": "string", "price_cents": 0, "product_name": "string", "status": "string", "tier_id": "string", "tier_slug": "string", "token_allowance": 100000, "trial_days_remaining": 0, "trial_ends_at": "string" }, "subscribed_tier_ids": [], "usage": { "active_instances": 0, "api_call_limit": 10000, "conversation_limit": 1000, "instance_limit": 0, "max_sites_per_node": 25, "platform_cost_usd": "string", "token_allowance": 100000, "total_cost_usd": "string", "total_hosted_sites": 0, "total_requests": 0, "total_tokens": 0, "unique_end_users": 0, "webhost_nodes": 0 }}HTTPBearerAuthorizationBearer <token>Successful Response
application/json- response
Lightweight trial status for sidebar countdown.
"Time is an illusion. Lunchtime doubly so." — Ford Prefect, The Hitchhiker's Guide to the Galaxy
plan_name?Plan Name"No Plan"status*Statustrial_days_remaining?integer|nulltrial_ends_at?string|nulltrial_expired?Trial Expiredfalseupgrade_url?Upgrade Url"/billing"curl -X GET 'https://example.com/v1/billing/trial-status'{ "plan_name": "No Plan", "status": "string", "trial_days_remaining": 0, "trial_ends_at": "string", "trial_expired": false, "upgrade_url": "/billing"}HTTPBearerAuthorizationBearer <token>Successful Response
application/json- response
Detailed usage breakdown for the current billing period.
by_instance*array<>period_end*Period Endperiod_start*Period Startplatform_cost_usd*Platform Cost Usdtoken_allowance_monthly*Token Allowance Monthlytoken_usage_pct*Token Usage Pcttotal_cost_usd*Total Cost Usdtotal_requests*Total Requeststotal_tokens*Total Tokensunique_end_users*Unique End Userscurl -X GET 'https://example.com/v1/billing/usage'{ "by_instance": [ {} ], "period_end": "string", "period_start": "string", "platform_cost_usd": "string", "token_allowance_monthly": 0, "token_usage_pct": 0, "total_cost_usd": "string", "total_requests": 0, "total_tokens": 0, "unique_end_users": 0}HTTPBearerAuthorizationBearer <token>days?Days30instance_id?string|nullSuccessful Response
application/json- response
period_label*Period Labelpoints*array<>curl -X GET 'https://example.com/v1/billing/usage/chart'{ "period_label": "string", "points": [ { "cost_usd": "string", "date": "string", "requests": 0, "tokens": 0 } ]}