Revenue composition

How the window's revenue and payments are composed, as the five donuts the dashboards draw: transaction fees by payment provider, settled transactions by plan kind, gross revenue by currency, payment attempts by outcome, and the monthly recurring revenue split by plan.

curl "https://api.subscriby.net/v1/analytics/composition?project_id=$PROJECT_ID&period=30d" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Every dataset carries total, unit (usd or count) and slices sorted largest first; each slice has its key, label, value, share_percent and the color the dashboard draws it in, so a client can render the same donut.
fees_by_provider, transactions_by_kind and revenue_by_currency read the same settled payments, so they agree with each other to the cent; payment_outcomes reads every attempt in the window, because a failed charge is exactly what it exists to show.
mrr_by_plan ignores the window: MRR is a balance, not a flow. It counts every active subscription on a recurring plan, normalised to a monthly USD figure, filed under its plan.
Labels come back in the creator's language.

Requires ability

dashboard:read

The token must hold this ability, or the call is refused with 403.

MCP tool

get_revenue_composition

Runs the same action from an agent, behind the same ability.

Authorization

bearerToken

AuthorizationBearer <token>

A personal access token minted on the dashboard under Settings, then Tokens, sent as Authorization: Bearer sbt_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team.

In: header

Query Parameters

project_id?string

Scope the figures to one project the token may see; omit for every project visible to it. A project outside the token's scope:project: allow-list is 404 TENANT_MISMATCH, an unknown one 404 RESOURCE_NOT_FOUND.

Formatuuid

period?string

The preset window: 7d, 14d, 30d (the default), 60d, 90d, mtd, qtd, ytd, 1y or all. Ignored when both from and to are given; an unknown value falls back to the default rather than failing.

Default"30d"

from?string

The first day of an explicit window, YYYY-MM-DD. Both from and to are needed to override period.

Formatdate

to?string

The last day of an explicit window, YYYY-MM-DD. Both from and to are needed to override period.

Formatdate

Responses

200OKapplication/json

The four dashboard donuts for the window plus the MRR base split by plan, each as total, unit and slices.

data*

The response's payload.

meta*

The request's window and scope, echoed back.

401UnauthorizedAUTHENTICATION_REQUIREDapplication/json

The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an sbt_test_ token on production).

error*

The one envelope every failure uses.

403ForbiddenTOKEN_MISSING_ABILITYapplication/json

The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers FORBIDDEN, TEAM_TIER_REQUIRED or CONNECTOR_TIER_REQUIRED with the same status, and says so in its own description.

error*

The one envelope every failure uses.

429Too many requestsRATE_LIMITEDapplication/json

The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.

error*

The one envelope every failure uses.

Call it from your code

A sample request in your language, the body each status answers with, and the types to hold them.

curl -X GET "https://example.com/v1/analytics/composition"

{  "data": {    "range": {      "from": "2026-08-13",      "to": "2026-09-12"    },    "fees_by_provider": {      "total": 84.1,      "unit": "usd",      "slices": [        {          "key": "stripe",          "label": "Stripe",          "value": 61.4,          "share_percent": 73.01,          "color": "blue"        },        {          "key": "paypal",          "label": "PayPal",          "value": 22.7,          "share_percent": 26.99,          "color": "violet"        }      ]    },    "transactions_by_kind": {      "total": 58,      "unit": "count",      "slices": [        {          "key": "subscription",          "label": "Subscription",          "value": 41,          "share_percent": 70.69,          "color": "blue"        },        {          "key": "pass",          "label": "Pass",          "value": 17,          "share_percent": 29.31,          "color": "violet"        }      ]    },    "revenue_by_currency": {      "total": 1682,      "unit": "usd",      "slices": [        {          "key": "USD",          "label": "USD",          "value": 1490,          "share_percent": 88.59,          "color": "blue"        },        {          "key": "EUR",          "label": "EUR",          "value": 192,          "share_percent": 11.41,          "color": "violet"        }      ]    },    "payment_outcomes": {      "total": 63,      "unit": "count",      "slices": [        {          "key": "succeeded",          "label": "Succeeded",          "value": 58,          "share_percent": 92.06,          "color": "emerald"        },        {          "key": "failed",          "label": "Failed",          "value": 4,          "share_percent": 6.35,          "color": "rose"        },        {          "key": "pending",          "label": "Pending",          "value": 1,          "share_percent": 1.59,          "color": "amber"        }      ]    },    "mrr_by_plan": {      "total": 4120,      "unit": "usd",      "slices": [        {          "key": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",          "label": "Gold",          "value": 2980,          "share_percent": 72.33,          "color": "blue"        },        {          "key": "0c1e7a54-2f6b-4d8e-9a3c-1b5d7e9f2a46",          "label": "Silver",          "value": 1140,          "share_percent": 27.67,          "color": "violet"        }      ]    }  },  "meta": {    "period": "30d",    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13"  }}

Type definitions

The shapes above as types, ready to paste into your client.

export interface Response {  data: Data;  meta: Meta;}export interface Data {  range: Range;  fees_by_provider: Record<string, unknown>;  transactions_by_kind: Record<string, unknown>;  revenue_by_currency: Record<string, unknown>;  payment_outcomes: Record<string, unknown>;  mrr_by_plan: MrrByPlan;}export interface Range {  from: string;  to: string;}export interface MrrByPlan {  total: number;  unit: string;  slices: Slice[];}export interface Slice {  key: string;  label: string;  value: number;  share_percent: number;  color: string;}export interface Meta {  period: string;  project_id: string | null;}

Revenue composition

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Authorization

Query Parameters

Responses