Get the subscriptions summary
MRR and its movements, subscribers, churn, ARPU, lifetime value and trials of the providers that record subscriptions, in one currency (currency, else the site's), and the currencies seen; with a comparison window, the same figures for it under previous.
Requires revenue:read on the site (an API key, or a signed-in member's role). Share links: 401.
x-api-key<token>An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).
Scope: revenue:read
siteId*stringstart?stringend?stringlast?stringall?"true""true"tz?stringbucket?string"minute""5m""15m""hour""day""week""month""year"compare?string"previous""year"compare_start?stringcompare_end?stringcurrency?stringISO 4217 code: only amounts in this currency count, so every amount of the response is in it (no conversion); default: the site's currency
^[A-Za-z]{3}$OK
application/json- response
data*meta*curl -X GET 'https://pilotfox.app/api/v1/sites/string/revenue/subscriptions/summary'{ "data": { "as_of": "string", "mrr": 0, "mrr_start": 0, "new_mrr": 0, "expansion_mrr": 0, "contraction_mrr": 0, "churned_mrr": 0, "reactivation_mrr": 0, "net_new_mrr": 0, "active_subscribers": 0, "active_subscribers_start": 0, "new_subscribers": 0, "reactivated_subscribers": 0, "churned_subscribers": 0, "subscriber_churn_rate": 0, "arpu": 0, "ltv": 0, "trials": { "active": 0, "new": 0 }, "currency": "string", "currencies": [ { "currency": "string", "subscriptions": 0 } ], "previous": { "as_of": "string", "mrr": 0, "mrr_start": 0, "new_mrr": 0, "expansion_mrr": 0, "contraction_mrr": 0, "churned_mrr": 0, "reactivation_mrr": 0, "net_new_mrr": 0, "active_subscribers": 0, "active_subscribers_start": 0, "new_subscribers": 0, "reactivated_subscribers": 0, "churned_subscribers": 0, "subscriber_churn_rate": 0, "arpu": 0, "ltv": 0, "trials": { "active": 0, "new": 0 } } }, "meta": { "window": { "from": "string", "to": "string", "tz": "string", "bucket": "minute" }, "compare": { "from": "string", "to": "string" }, "totalCount": -9007199254740991, "nextCursor": "string", "truncated": true, "cache": "hit" }}