get_transaction_breakdown
USD-normalized successful-payment totals split by plan, payment_provider, currency, or project. Includes share percent per group.
Split USD-normalized successful-payment totals by one dimension for the requested window. Supported dimensions: plan, payment_provider, currency, project. Each group carries gross_usd, transactions, and share_percent so agents can answer "which provider drove the most revenue?" in one call.
Requires ability
The token behind the MCP session must hold it, or the call is refused with TOKEN_MISSING_ABILITY.
Runs the same action as
The REST endpoint and this tool share one action, so validation, permissions and events are identical.
Annotations
It reads and never changes anything.
Arguments
project_idstringoptionalOptional project UUID to scope the breakdown. Leave blank for all projects in the current team.
dimension*stringRequired. Grouping dimension — plan, payment_provider, currency, or project.
periodstringoptionalPeriod preset — 7d, 14d, 30d, 60d, 90d, mtd, qtd, ytd, 1y, all. Defaults to 30d.
fromstringoptionalExplicit start date (ISO YYYY-MM-DD). Overrides period when paired with "to".
tostringoptionalExplicit end date (ISO YYYY-MM-DD). Overrides period when paired with "from".
plan_idsarrayoptionalOptional plan-UUID allow-list.
statusesarrayoptionalOptional SubscriptionStatus allow-list applied to parent subscriptions.
payment_method_idsarrayoptionalOptional payment-method UUID allow-list applied to parent subscriptions.
What it returns
{ "data": { "total_gross_usd": "4821.50", "groups": [ { "key": "stripe", "label": "Stripe", "gross_usd": "2891.00", "transactions": 110, "share_percent": 59.96 } ] }, "meta": { "period": "30d", "dimension": "payment_provider" }}How it fails
VALIDATION_FAILEDdimension is missing or not one of the allowed values.
AUTHENTICATION_REQUIREDno authenticated user on the request.
TOKEN_MISSING_ABILITYtoken lacks dashboard:read.
How is this guide?
Last updated on