Analytics API

Read-only analytics under /v1/analytics/ surface the same figures the creator dashboard renders.

Read-only analytics under /v1/analytics/* surface the same figures the creator dashboard renders. Every endpoint delegates to the same service layer the dashboard uses, so the dashboard, the MCP tools and REST callers see identical numbers.

All eight reads are tenant-scoped by the token's team, need no Idempotency-Key, and share the token's general rate limit.

Background

Common query parameters

Most reads share the same window selection:

period: a preset window, one of 7d, 14d, 30d, 60d, 90d, mtd, qtd, ytd, 1y, all. Defaults to 30d. Ignored when both from and to are supplied; an unknown value falls back to the default rather than failing.
from, to: an explicit YYYY-MM-DD range. Takes precedence over period when both ends are provided.
project_id: an optional project id. Scopes the response to a single project; omit for every project visible to the token. A project outside the token's scope:project: allow-list is 404 TENANT_MISMATCH, an unknown one 404 RESOURCE_NOT_FOUND.

The dashboard, earnings and transaction-breakdown reads additionally accept filter allow-lists: plan_ids, statuses, payment_method_ids. Pass each as an array (?plan_ids[]=uuid1&plan_ids[]=uuid2) or as one comma-separated string (?plan_ids=uuid1,uuid2).

Caching

All reads share the same 5-minute cache the creator dashboard uses. A REST call warms the human-facing view and vice versa; consecutive calls with identical filters hit the cache until it rotates.

The service layer returns USD-normalised totals for cross-currency comparability. Per-plan or per-payment rows still carry their original currency alongside the USD-normalised amount.

Endpoints

GET/v1/analytics/dashboardHeadline figures GET/v1/analytics/earningsEarnings report GET/v1/analytics/subscribersSubscriber analytics GET/v1/analytics/transactionsList transactions GET/v1/analytics/transactions/breakdownTransaction breakdown GET/v1/analytics/plan-performancePlan performance GET/v1/analytics/connectorsBy connector GET/v1/analytics/compositionRevenue composition

Headline figures

GET

Total revenue, total transactions, total users and MRR, each with a trend relative to the compare_period window and a sparkline. The Recurring Monthly Income tile counts only active subscriptions on recurring plans, normalised to a monthly figure; one-time and lifetime plans are excluded.

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

Requires ability

dashboard:read

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

MCP tool

get_dashboard_metrics

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

compare_period?string

previous (the default) compares each tile with the window just before it and fills trend; none leaves the trend out.

Default"previous"

plan_ids[]?array<string>

Count only these plans. Send it as plan_ids[]=a&plan_ids[]=b or as one comma-separated string.

statuses[]?array<string>

Count only payments in these states: successful, failed, pending, refunded. Send them as statuses[]=a&statuses[]=b or as one comma-separated string.

payment_method_ids[]?array<string>

Count only payments taken through these payment methods. Send them as payment_method_ids[]=a&payment_method_ids[]=b or as one comma-separated string.

Responses

200OKapplication/json

The headline tiles.

data*array<>

The items.

meta*

The window the figures were computed for, 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/dashboard"

{  "data": [    {      "title": "Total Revenue",      "value": "$12,480.00",      "trend": "12.4%",      "trendUp": true,      "charting": [        0,        0,        120,        0,        340,        0,        720,        0,        0,        860      ]    },    {      "title": "Total Transactions",      "value": "342",      "trend": "8.1%",      "trendUp": true,      "charting": [        0,        0,        2,        0,        6,        0,        18,        0,        0,        22      ]    },    {      "title": "Total Users",      "value": "1,204",      "trend": "2.9%",      "trendUp": true,      "charting": [        0,        0,        0,        0,        1,        0,        4,        0,        0,        3      ]    },    {      "title": "Recurring Monthly Income",      "value": "$4,120.00",      "trend": "5.6%",      "trendUp": true,      "charting": [        0,        0,        120,        0,        340,        0,        720,        0,        0,        860      ]    }  ],  "meta": {    "period": "30d",    "compare_period": "previous",    "project_id": null  }}

Type definitions

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

export interface Response {  data: Data[];  meta: Meta;}export interface Data {  title: string;  value: string;  trend: string;  trendUp: boolean;  charting: (number | number)[];}export interface Meta {  period: string;  compare_period: string;  project_id: string | null;}

Earnings report

GET

The full earnings breakdown (gross, fees, net, transaction count) plus a timeseries bucketed by granularity: day (the default), week or month.

curl "https://api.subscriby.net/v1/analytics/earnings?granularity=week" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Every money figure is USD-normalised so buckets in different currencies add up; totals.currency says so.

Requires ability

dashboard:read

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

MCP tool

get_earnings_report

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

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Query Parameters

project_id?string

Formatuuid

period?string

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

granularity?string

The bucket size of the timeseries: day (the default), week or month. Anything else is 422 VALIDATION_FAILED.

Default"day"

plan_ids[]?array<string>

Count only these plans. Send it as plan_ids[]=a&plan_ids[]=b or as one comma-separated string.

statuses[]?array<string>

Count only payments in these states: successful, failed, pending, refunded. Send them as statuses[]=a&statuses[]=b or as one comma-separated string.

payment_method_ids[]?array<string>

Count only payments taken through these payment methods. Send them as payment_method_ids[]=a&payment_method_ids[]=b or as one comma-separated string.

Responses

200OKapplication/json

Gross, fees and net per bucket.

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

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

When granularity is not day, week or month, or project_id is not a UUID.

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/earnings"

{  "data": {    "range": {      "from": "string",      "to": "string",      "granularity": "string"    },    "totals": {      "gross": 0,      "fees": 0,      "net": 0,      "transactions": 0,      "currency": "string"    },    "timeseries": [      {        "bucket": "string",        "gross": 0,        "fees": 0,        "net": 0,        "transactions": 0      }    ]  },  "meta": {    "period": "string",    "granularity": "string",    "project_id": "string"  }}

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;  totals: Totals;  timeseries: Timesery[];}export interface Range {  from: string;  to: string;  granularity: string;}export interface Totals {  gross: number;  fees: number;  net: number;  transactions: number;  currency: string;}export interface Timesery {  bucket: string;  gross: number;  fees: number;  net: number;  transactions: number;}export interface Meta {  period: string;  granularity: string;  project_id: string | null;}

Subscriber analytics

GET

New sign-ups, cancellations, churn rate, trial-to-paid conversion and the status distribution of the window. The filter allow-lists do not apply: the figures describe the whole membership of the scope, which is what retention is measured against.

curl "https://api.subscriby.net/v1/analytics/subscribers?project_id=$PROJECT_ID" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Requires ability

dashboard:read

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

MCP tool

get_subscriber_analytics

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

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Query Parameters

project_id?string

Formatuuid

period?string

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

New, canceled, churn, trials and the status mix.

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

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

When project_id is not a UUID.

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/subscribers"

{  "data": {    "range": {      "from": "2026-08-13",      "to": "2026-09-12"    },    "new_subscribers": 54,    "canceled_subscribers": 6,    "active_at_window_start": 241,    "churn_rate_percent": 2.49,    "trial_started": 38,    "trial_converted": 13,    "trial_to_paid_percent": 34.21,    "status_distribution": {      "active": 289,      "trial": 25,      "past_due": 3,      "canceled": 41,      "expired": 118    }  },  "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;  new_subscribers: number;  canceled_subscribers: number;  active_at_window_start: number;  churn_rate_percent: number;  trial_started: number;  trial_converted: number;  trial_to_paid_percent: number;  status_distribution: Record<string, number>;}export interface Range {  from: string;  to: string;}export interface Meta {  period: string;  project_id: string | null;}

List transactions

GET

A keyset-paginated list of payments for one project. project_id is required.

curl "https://api.subscriby.net/v1/analytics/transactions?project_id=$PROJECT_ID&limit=100" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Every row carries its owning project, plan and subscriber, so a payment can be attributed without a follow-up lookup. Follow meta.next_cursor on the next call to paginate. A null or missing cursor means the end of the range has been reached.

Requires ability

dashboard:read

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

MCP tool

list_transactions

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

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Query Parameters

project_id*string

The project whose payments to list. Required: transactions are always read for one project.

Formatuuid

period?string

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

statuses[]?array<string>

Only payments in these states: successful, failed, pending, refunded. Send them as statuses[]=a&statuses[]=b or as one comma-separated string; an unknown state is ignored.

provider_ids[]?array<string>

Only payments taken through these payment methods. Send them as provider_ids[]=a&provider_ids[]=b or as one comma-separated string.

plan_ids[]?array<string>

Count only these plans. Send it as plan_ids[]=a&plan_ids[]=b or as one comma-separated string.

currency_ids[]?array<string>

Only payments in these currencies, by currency id. Send them as currency_ids[]=a&currency_ids[]=b or as one comma-separated string.

cursor?string

The opaque keyset cursor a previous page returned as meta.next_cursor. Omit for the first page.

limit?integer

Rows per page, 1 to 200; a value outside the range clamps. Defaults to 50.

Default50

Responses

200OKapplication/json

One keyset page of transactions.

data*array<>

The items.

meta*

The page's cursor and the window and project it was cut from.

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

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

When project_id is missing or not a UUID.

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/transactions?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": [    {      "id": "8b0c4a15-e792-4360-95d8-1f47c0b3e926",      "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",      "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",      "project_name": "Beautiful Mouths",      "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",      "plan_name": "Monthly",      "subscriber_id": "6f9b2e37-c184-4a05-8d72-30e16bc9f458",      "subscriber_name": "Ada Lovelace",      "status": "successful",      "amount": "29.00",      "currency": "USD",      "provider": "stripe",      "provider_label": "Stripe",      "method_id": "a15d70c8-3e46-4b92-b70f-58c9d2140e63",      "calculated_fee": "1.16",      "billing_reason": "subscription_cycle",      "external_payment_id": "pi_3Nxy...",      "occurred_at": "2026-05-18T10:05:00Z"    }  ],  "meta": {    "count": 1,    "limit": 100,    "next_cursor": "eyJpZCI6InR4bl8uLi4i...",    "range": {      "from": "2026-08-13",      "to": "2026-09-12"    },    "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 {  id: string;  subscription_id: string;  project_id: string;  project_name: string;  plan_id: string;  plan_name: string;  subscriber_id: string | null;  subscriber_name: string | null;  status: string;  amount: string;  currency: string;  provider: string;  provider_label: string;  method_id: string;  calculated_fee: string;  billing_reason: string | null;  external_payment_id: string | null;  occurred_at: string;}export interface Meta {  count: number;  limit: number;  next_cursor: string;  range: Range;  project_id: string;}export interface Range {  from: string;  to: string;}

Transaction breakdown

GET

USD-normalised successful-payment totals grouped by one dimension: plan, payment_provider, currency or project. dimension is required.

curl "https://api.subscriby.net/v1/analytics/transactions/breakdown?dimension=payment_provider&period=90d" \  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"

Requires ability

dashboard:read

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

MCP tool

get_transaction_breakdown

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

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Query Parameters

dimension*string

What to group the settled revenue by: plan, payment_provider, currency or project. Required.

project_id?string

Formatuuid

period?string

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

plan_ids[]?array<string>

Count only these plans. Send it as plan_ids[]=a&plan_ids[]=b or as one comma-separated string.

statuses[]?array<string>

Count only payments in these states: successful, failed, pending, refunded. Send them as statuses[]=a&statuses[]=b or as one comma-separated string.

payment_method_ids[]?array<string>

Count only payments taken through these payment methods. Send them as payment_method_ids[]=a&payment_method_ids[]=b or as one comma-separated string.

Responses

200OKapplication/json

Gross revenue grouped by the dimension.

data*

The response's payload.

meta*

The request's window, dimension 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

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

When dimension is missing or not one of the four, or project_id is not a UUID.

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/transactions/breakdown?dimension=payment_provider"

{  "data": {    "range": {      "from": "2026-06-14",      "to": "2026-09-12"    },    "dimension": "payment_provider",    "total_gross_usd": 4210.5,    "groups": [      {        "key": "stripe",        "label": "Stripe",        "gross_usd": 3120,        "transactions": 104,        "share_percent": 74.1      },      {        "key": "paypal",        "label": "PayPal",        "gross_usd": 1090.5,        "transactions": 37,        "share_percent": 25.9      }    ]  },  "meta": {    "period": "90d",    "dimension": "payment_provider",    "project_id": null  }}

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;  dimension: string;  total_gross_usd: number;  groups: Group[];}export interface Range {  from: string;  to: string;}export interface Group {  key: string;  label: string;  gross_usd: number;  transactions: number;  share_percent: number;}export interface Meta {  period: string;  dimension: string;  project_id: string | null;}

Plan performance

GET

A per-plan breakdown for one project: active subscribers, revenue in the window, payments in the window and the average ticket. project_id is required.

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

Figures are in the plan's own currency. meta.range is the window the preset resolved to.

Requires ability

dashboard:read

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

MCP tool

get_plan_performance

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

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Query Parameters

project_id*string

The project whose plans to report on. Required: the figures are per plan of one project.

Formatuuid

period?string

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

Per-plan activity in the plan's own currency.

data*array<>

The items.

meta*

The request's project and window, 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

error*

The one envelope every failure uses.

422Validation failedVALIDATION_FAILEDapplication/json

When project_id is missing or not a UUID.

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/plan-performance?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"

{  "data": [    {      "plan_id": "c4e82f16-93a7-4d5b-b81c-6e0f27a94d3b",      "plan_name": "Premium Monthly",      "active_subscribers": 241,      "payments_in_window": 58,      "revenue_in_window": "1682.00",      "avg_ticket": "29.00"    }  ],  "meta": {    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",    "period": "30d",    "range": {      "from": "2026-04-18",      "to": "2026-05-18"    }  }}

Type definitions

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

export interface Response {  data: Data[];  meta: Meta;}export interface Data {  plan_id: string;  plan_name: string;  active_subscribers: number;  payments_in_window: number;  revenue_in_window: string;  avg_ticket: string;}export interface Meta {  project_id: string;  period: string;  range: Range;}export interface Range {  from: string;  to: string;}

By connector

GET

Members, access and revenue per connector: one row for every connector the scope's projects run or ever granted access on. The figures behind the dashboards' By Connector panel.

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

installations counts the live, not uninstalled, installations of the connector in the scope; members the members holding at least one account linked on it; members_linked_in_window those who linked one inside the window.
live_grants and pending_grants read the access ledger now (pending covers pending, pending_identity and held); granted_in_window and revoked_in_window count the ledger's moves inside the window.
gross_usd is every settled payment in the window whose purchase granted access on the connector, converted to USD; share_percent is its part of total_gross_usd. A purchase that grants access on two connectors counts toward both, so shares can exceed 100 in total; attribution says so in the creator's language.
The filter allow-lists (plan_ids, statuses, payment_method_ids) do not apply here: installations and linked accounts are not subscriptions.

Requires ability

dashboard:read

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

MCP tool

get_connector_analytics

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

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Query Parameters

project_id?string

Formatuuid

period?string

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

One row per connector: installations, members, grants, revenue and share.

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

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/connectors"

{  "data": {    "range": {      "from": "2026-08-13",      "to": "2026-09-12"    },    "total_gross_usd": 1682,    "attribution": "A purchase that grants access on two connectors counts toward both.",    "connectors": [      {        "key": "example",        "name": "Example connector",        "installations": 2,        "members": 241,        "members_linked_in_window": 18,        "live_grants": 236,        "pending_grants": 3,        "granted_in_window": 21,        "revoked_in_window": 4,        "gross_usd": 1682,        "transactions": 58,        "share_percent": 100      }    ]  },  "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;  total_gross_usd: number;  attribution: string;  connectors: Connector[];}export interface Range {  from: string;  to: string;}export interface Connector {  key: string;  name: string;  installations: number;  members: number;  members_linked_in_window: number;  live_grants: number;  pending_grants: number;  granted_in_window: number;  revoked_in_window: number;  gross_usd: number;  transactions: string | number;  share_percent: number;}export interface Meta {  period: string;  project_id: string | null;}

Revenue composition

GET

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>

In: header

Query Parameters

project_id?string

Formatuuid

period?string

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

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;}

Ability CatalogEvery ability string a Subscriby token can carry, what enforces it, and how to pick the right ones when minting.Rate LimitingNamed rate-limit buckets applied to the REST API, the MCP server, and the webhook surface.Error CodesComplete catalog of Subscriby API error codes, HTTP statuses, and remediation hints.

Analytics API

Common query parametersCopy Anchor Link

CachingCopy Anchor Link

EndpointsCopy Anchor Link

Headline figuresCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Earnings reportCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Subscriber analyticsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

List transactionsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Transaction breakdownCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Plan performanceCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

By connectorCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Revenue compositionCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

ResponsesCopy Anchor Link

Related

On this page

Common query parameters

Caching

Endpoints

Headline figures

Authorization

Query Parameters

Responses

Earnings report

Authorization

Query Parameters

Responses

Subscriber analytics

Authorization

Query Parameters

Responses

List transactions

Authorization

Query Parameters

Responses

Transaction breakdown

Authorization

Query Parameters

Responses

Plan performance

Authorization

Query Parameters

Responses

By connector

Authorization

Query Parameters

Responses

Revenue composition

Authorization

Query Parameters

Responses