Billing & subscription
Anything that spends money takes two calls: a preview returns what will happen and a confirmation token, and the apply call uses that token. A token works once, for ten minutes, so a retry never charges twice. Cancelling takes effect at the end of the period, never at once. Enterprise prices are never shown.
The live list
searchTools with category: "billing" for the current list of these tools with every input. This page is the readable copy.The tools
Every tool below keeps to the access of the key or sign-in that calls it, and to the person’s own role. A tool only sees the tools it may use.
applySubscriptionChange
Apply a previewed change. Same-tier seat = in-place; cross-tier = Checkout.
cancelSubscription
Soft-cancel (cancel_at_period_end). Never immediate.
getCreditBalance
Current credit balance for the org.
getCreditPackages
Available credit packages.
getCustomerPortalLink
A link to the billing portal, to manage payment details and invoices.
getPriceForTier
Get pricing info for a tier (Enterprise stripped for non-admins).
getSubscription
Read the organisation's current subscription.
listCreditPurchases
Past credit purchases.
listInvoices
List invoices for the org.
listPaymentMethods
List masked payment methods.
previewSubscriptionCancellation
Preview cancellation impact (remaining credits, prepaid days, feature loss).
previewSubscriptionChange
Preview a tier or seat change. Returns confirmation token + AUD totals.
purchaseCreditPackage
Apply the quote and get a Checkout URL.
quoteCreditPackage
Quote a credit-package purchase. Returns quote token.
reactivateSubscription
Reactivate a soft-cancelled subscription.
updateBillingEmail
Update the billing contact email.