Billing
Plans, subscriptions, payment methods, invoices, usage and prepaid credits.
Get usage
/usagePlan, limits and consumption for the current period: connected accounts against the allowance (plan included + extra accounts + lifetime + Apple seats), members, profiles, webhooks, API keys, posts, storage, API requests this hour, X API pass-through calls and spend, and prepaid credits. Also covers the deprecated usage-stats snapshot.
Try it with MCPAsk your agent to call get-usage (toolset billing)Set up MCP
Returns object
objectstringusage
planstringfreeprobusinessenterprise
intervalstring | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullaccountsobjectShow 10 child attributes
usedintegerincludedinteger | nullextra_purchasedintegerlifetimeintegerappleintegerlegacy_subscribedintegerlimitinteger | nullavailableinteger | nullover_limitintegerpausedintegermembersobjectShow 2 child attributes
usedintegerlimitinteger | nullprofilesobjectShow 2 child attributes
usedintegerlimitinteger | nullwebhooksobjectShow 2 child attributes
usedintegerlimitinteger | nullapi_keysobjectShow 2 child attributes
usedintegerlimitinteger | nullpostsobjectShow 2 child attributes
this_monthintegerlimit_per_monthinteger | nullstorageobjectShow 2 child attributes
used_bytesintegerlimit_bytesinteger | nullapiobjectShow 2 child attributes
requests_this_hourintegerlimit_per_hourintegerx_apiobjectShow 3 child attributes
callsintegerspend_centsintegercalls_by_operationmap of integercredits_centsintegerResponses
{
"object": "usage",
"plan": "free",
"interval": "string",
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z",
"accounts": {
"used": 1,
"included": 1,
"extra_purchased": 1,
"lifetime": 1,
"apple": 1,
"legacy_subscribed": 1,
"limit": 1,
"available": 1,
"over_limit": 1,
"paused": 1
},
"members": {
"used": 1,
"limit": 1
},
"profiles": {
"used": 1,
"limit": 1
},
"webhooks": {
"used": 1,
"limit": 1
},
"api_keys": {
"used": 1,
"limit": 1
},
"posts": {
"this_month": 1,
"limit_per_month": 1
},
"storage": {
"used_bytes": 1,
"limit_bytes": 1
},
"api": {
"requests_this_hour": 1,
"limit_per_hour": 1
},
"x_api": {
"calls": 1,
"spend_cents": 1,
"calls_by_operation": {
"key": 1
}
},
"credits_cents": 1
}Get X API usage
/usage/x-apiMetering of X API pass-through calls (debited from prepaid credits at cost) over a window: totals, per-operation breakdown and a day/month series. Pair with GET /billing/x-pricing. Profile-restricted keys only see their profiles’ accounts.
Try it with MCPAsk your agent to call get-x-api-usage (toolset billing)Set up MCP
Query parameters
rangestringdefault: "cycle"cycleprev_cycle7d30d90d12mocustom
fromstring (date)tostring (date)granularitystringdefault: "day"daymonthtotal
account_idstringpattern ^sa_[0-9A-Za-z]{27}$
Returns object
objectstringx_api_usage
rangestringfromstringtostringgranularitystringtotalsobjectShow 3 child attributes
callsintegerspend_centsintegerspend_micro_usdintegerby_operationarray of objectShow 3 item attributes
operationstringcallsintegerspend_centsintegerdaysarray of objectShow 3 item attributes
datestringcallsintegerspend_centsintegerResponses
{
"object": "x_api_usage",
"range": "string",
"from": "+15551234567",
"to": "+15551234567",
"granularity": "string",
"totals": {
"calls": 1,
"spend_cents": 1,
"spend_micro_usd": 1
},
"by_operation": [
{
"operation": "string",
"calls": 1,
"spend_cents": 1
}
],
"days": [
{
"date": "string",
"calls": 1,
"spend_cents": 1
}
]
}Get billing overview
/billingPlan, billing interval, subscription status and period, extra accounts, recurring price, account allowance and publishing pause, payment method, invoices summary, upcoming invoice, credits and the dashboard banner.
Try it with MCPAsk your agent to call get-billing (toolset billing)Set up MCP
Returns object
objectstringbilling
planstringfreeprobusinessenterprise
plan_namestringintervalstring | nullstatusstringproviderstringnonestripeappleltdenterprise
customer_idstring | nullsubscription_idstring | nullcurrent_period_startstring (date-time) | nullcurrent_period_endstring (date-time) | nullcancel_at_period_endbooleancanceled_atstring (date-time) | nullextra_accountsintegerpriceobject | nullShow 6 child attributes
currencystringbase_centsintegerextra_account_centsintegerextra_accounts_centsintegertotal_centsintegerperiodstringaccountsobjectShow 10 child attributes
usedintegerincludedinteger | nullextra_purchasedintegerlifetimeintegerappleintegerlegacy_subscribedintegerlimitinteger | nullavailableinteger | nullover_limitintegerpausedintegerpublishing_pausedobjectShow 2 child attributes
activebooleanaccount_idsarray of stringbannerobject | nullShow 4 child attributes
typestringseveritystringmessagestringactionstringpayment_methodobject | nullShow 10 child attributes
objectstringpayment_method
idstringtypestringbrandstring | nulllast4string | nullexp_monthinteger | nullexp_yearinteger | nullwalletstring | nullis_defaultbooleancreated_atstring (date-time) | nullhas_payment_methodbooleaninvoicesobjectShow 3 child attributes
latestobject | nullShow 21 child attributes
objectstringinvoice
idstringnumberstring | nullstatusstring | nullcurrencystringamount_due_centsintegeramount_paid_centsintegeramount_remaining_centsintegersubtotal_centsintegertax_centsintegertotal_centsintegerbilling_reasonstring | nulldescriptionstring | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullhosted_invoice_urlstring | nullinvoice_pdfstring | nulldue_datestring (date-time) | nullpaid_atstring (date-time) | nullcreated_atstring (date-time) | nulllinesarray of objectShow 5 item attributes
descriptionstring | nullamount_centsintegerquantityinteger | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullopen_countintegeropen_amount_centsintegerupcoming_invoiceobject | nullShow 3 child attributes
amount_due_centsintegercurrencystringnext_payment_attemptstring (date-time) | nullcredits_centsintegerx_usage_blockedbooleanlegacyobjectShow 6 child attributes
billing_modestringlifetime_seatsintegersubscribed_seatsintegerapple_seatsintegersourcestring | nullmeteredbooleanResponses
{
"object": "billing",
"plan": "free",
"plan_name": "string",
"interval": "string",
"status": "string",
"provider": "none",
"customer_id": "string",
"subscription_id": "string",
"current_period_start": "2026-10-13T09:00:00.000Z",
"current_period_end": "2026-10-13T09:00:00.000Z",
"cancel_at_period_end": true,
"canceled_at": "2026-10-13T09:00:00.000Z",
"extra_accounts": 1,
"price": {
"currency": "USD",
"base_cents": 1,
"extra_account_cents": 1,
"extra_accounts_cents": 1,
"total_cents": 1,
"period": "string"
},
"accounts": {
"used": 1,
"included": 1,
"extra_purchased": 1,
"lifetime": 1,
"apple": 1,
"legacy_subscribed": 1,
"limit": 1,
"available": 1,
"over_limit": 1,
"paused": 1
},
"publishing_paused": {
"active": true,
"account_ids": [
"string"
]
},
"banner": {
"type": "string",
"severity": "string",
"message": "string",
"action": "string"
},
"payment_method": {
"object": "payment_method",
"id": "string",
"type": "string",
"brand": "string",
"last4": "string",
"exp_month": 1,
"exp_year": 1,
"wallet": "string",
"is_default": true,
"created_at": "2026-10-13T09:00:00.000Z"
},
"has_payment_method": true,
"invoices": {
"latest": {
"object": "invoice",
"id": "string",
"number": "string",
"status": "string",
"currency": "USD",
"amount_due_cents": 1,
"amount_paid_cents": 1,
"amount_remaining_cents": 1,
"subtotal_cents": 1,
"tax_cents": 1,
"total_cents": 1,
"billing_reason": "string",
"description": "string",
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z",
"hosted_invoice_url": "https://example.com",
"invoice_pdf": "string",
"due_date": "2026-10-13T09:00:00.000Z",
"paid_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"lines": [
{
"description": "string",
"amount_cents": 1,
"quantity": 1,
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z"
}
]
},
"open_count": 1,
"open_amount_cents": 1
},
"upcoming_invoice": {
"amount_due_cents": 1,
"currency": "USD",
"next_payment_attempt": "2026-10-13T09:00:00.000Z"
},
"credits_cents": 1,
"x_usage_blocked": true,
"legacy": {
"billing_mode": "string",
"lifetime_seats": 1,
"subscribed_seats": 1,
"apple_seats": 1,
"source": "string",
"metered": true
}
}List plans
/billing/plansPrices (price_cents per month, year = per month billed yearly; billed_cents per billing period), extra account prices, limits and features of every plan.
Try it with MCPAsk your agent to call list-plans (toolset billing)Set up MCP
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 12 item attributes
objectstringplan
idstringfreeprobusinessenterprise
namestringrankintegerself_servebooleancurrentbooleanprice_centsobjectShow 2 child attributes
monthinteger | nullyearinteger | nullbilled_centsobjectShow 2 child attributes
monthinteger | nullyearinteger | nullextra_account_centsobjectShow 2 child attributes
monthinteger | nullyearinteger | nullextra_account_billed_centsobjectShow 2 child attributes
monthinteger | nullyearinteger | nulllimitsmap of integer | nullfeaturesmap of booleanpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "plan",
"id": "free",
"name": "string",
"rank": 1,
"self_serve": true,
"current": true,
"price_cents": {
"month": 1,
"year": 1
},
"billed_cents": {
"month": 1,
"year": 1
},
"extra_account_cents": {
"month": 1,
"year": 1
},
"extra_account_billed_cents": {
"month": 1,
"year": 1
},
"limits": {},
"features": {}
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Get X API pricing
/billing/x-pricingThe X API pass-through price table (zero markup) by operation and tier. Safe to cache for a billing period.
Try it with MCPAsk your agent to call get-x-pricing (toolset billing)Set up MCP
Returns object
objectstringx_pricing
currencystringmarkupstringsourcestringlast_verifiedstringtiersarray of objectShow 3 item attributes
tierstringprice_per_call_usdnumberoperation_countintegeroperationsarray of objectShow 7 item attributes
operationstringdisplay_namestringprice_per_call_usdnumberprice_per_call_centsnumberprice_micro_usdintegertierstringtriggered_byarray of stringResponses
{
"object": "x_pricing",
"currency": "USD",
"markup": "string",
"source": "string",
"last_verified": "string",
"tiers": [
{
"tier": "string",
"price_per_call_usd": 1.5,
"operation_count": 1
}
],
"operations": [
{
"operation": "string",
"display_name": "string",
"price_per_call_usd": 1.5,
"price_per_call_cents": 1.5,
"price_micro_usd": 1,
"tier": "string",
"triggered_by": [
"string"
]
}
]
}Get prepaid credits
/billing/creditsCredit balance (USD cents) used for X API pass-through calls, whether X actions are blocked, and the credit packs for sale.
Try it with MCPAsk your agent to call get-billing-credits (toolset billing)Set up MCP
Returns object
objectstringcredits
balance_centsintegerx_usage_blockedbooleanpacksarray of objectShow 4 item attributes
idstringprice_centsintegercredits_centsintegerios_product_idstring | nullResponses
{
"object": "credits",
"balance_cents": 1,
"x_usage_blocked": true,
"packs": [
{
"id": "string",
"price_cents": 1,
"credits_cents": 1,
"ios_product_id": "string"
}
]
}Preview a plan change
/billing/previewRecurring price and the proration due now for switching plan, interval or extra accounts. Without a subscription the preview is the first period (requires_checkout: true). Upgrades are invoiced immediately; downgrades credit the next invoice.
Try it with MCPAsk your agent to call preview-billing-change (toolset billing)Set up MCP
Query parameters
planstringrequiredfreeprobusinessenterprise
intervalstringmonthyear
extra_accountsinteger0–100000
Returns object
objectstringbilling_preview
planstringintervalstringextra_accountsintegerchange_typestringnewupgradedowngradeinterval_changeextra_accountsnone
requires_checkoutbooleancurrencystringrecurringobjectShow 4 child attributes
base_centsintegerextra_accounts_centsintegertotal_centsintegerperiodstringamount_due_now_centsintegerproration_dateinteger | nulllinesarray of objectShow 5 item attributes
descriptionstring | nullamount_centsintegerprorationbooleanperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullnext_invoice_atstring (date-time) | nullaccountsobjectShow 3 child attributes
usedintegerlimit_afterinteger | nullover_limit_afterintegerResponses
{
"object": "billing_preview",
"plan": "string",
"interval": "string",
"extra_accounts": 1,
"change_type": "new",
"requires_checkout": true,
"currency": "USD",
"recurring": {
"base_cents": 1,
"extra_accounts_cents": 1,
"total_cents": 1,
"period": "string"
},
"amount_due_now_cents": 1,
"proration_date": 1,
"lines": [
{
"description": "string",
"amount_cents": 1,
"proration": true,
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z"
}
],
"next_invoice_at": "2026-10-13T09:00:00.000Z",
"accounts": {
"used": 1,
"limit_after": 1,
"over_limit_after": 1
}
}List invoices
/billing/invoicesStripe invoices of the workspace, newest first, with hosted page and PDF links.
Try it with MCPAsk your agent to call list-billing-invoices (toolset billing)Set up MCP
Query parameters
pageintegerdefault: 11–50
limitintegerdefault: 201–100
statusstringdraftopenpaiduncollectiblevoid
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 21 item attributes
objectstringinvoice
idstringnumberstring | nullstatusstring | nullcurrencystringamount_due_centsintegeramount_paid_centsintegeramount_remaining_centsintegersubtotal_centsintegertax_centsintegertotal_centsintegerbilling_reasonstring | nulldescriptionstring | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullhosted_invoice_urlstring | nullinvoice_pdfstring | nulldue_datestring (date-time) | nullpaid_atstring (date-time) | nullcreated_atstring (date-time) | nulllinesarray of objectShow 5 item attributes
descriptionstring | nullamount_centsintegerquantityinteger | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
{
"object": "list",
"data": [
{
"object": "invoice",
"id": "string",
"number": "string",
"status": "string",
"currency": "USD",
"amount_due_cents": 1,
"amount_paid_cents": 1,
"amount_remaining_cents": 1,
"subtotal_cents": 1,
"tax_cents": 1,
"total_cents": 1,
"billing_reason": "string",
"description": "string",
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z",
"hosted_invoice_url": "https://example.com",
"invoice_pdf": "string",
"due_date": "2026-10-13T09:00:00.000Z",
"paid_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"lines": [
{
"description": "string",
"amount_cents": 1,
"quantity": 1,
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z"
}
]
}
],
"page": 1,
"limit": 1,
"total": 1,
"has_more": true,
"next_page_url": "https://example.com",
"previous_page_url": "https://example.com"
}Get an invoice
/billing/invoices/{id}Try it with MCPAsk your agent to call get-billing-invoice (toolset billing)Set up MCP
Path parameters
idstringrequiredpattern ^in_[A-Za-z0-9_]+$
Returns object
objectstringinvoice
idstringnumberstring | nullstatusstring | nullcurrencystringamount_due_centsintegeramount_paid_centsintegeramount_remaining_centsintegersubtotal_centsintegertax_centsintegertotal_centsintegerbilling_reasonstring | nulldescriptionstring | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullhosted_invoice_urlstring | nullinvoice_pdfstring | nulldue_datestring (date-time) | nullpaid_atstring (date-time) | nullcreated_atstring (date-time) | nulllinesarray of objectShow 5 item attributes
descriptionstring | nullamount_centsintegerquantityinteger | nullperiod_startstring (date-time) | nullperiod_endstring (date-time) | nullResponses
{
"object": "invoice",
"id": "string",
"number": "string",
"status": "string",
"currency": "USD",
"amount_due_cents": 1,
"amount_paid_cents": 1,
"amount_remaining_cents": 1,
"subtotal_cents": 1,
"tax_cents": 1,
"total_cents": 1,
"billing_reason": "string",
"description": "string",
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z",
"hosted_invoice_url": "https://example.com",
"invoice_pdf": "string",
"due_date": "2026-10-13T09:00:00.000Z",
"paid_at": "2026-10-13T09:00:00.000Z",
"created_at": "2026-10-13T09:00:00.000Z",
"lines": [
{
"description": "string",
"amount_cents": 1,
"quantity": 1,
"period_start": "2026-10-13T09:00:00.000Z",
"period_end": "2026-10-13T09:00:00.000Z"
}
]
}