API Reference

Subscription counts, churn and refunds (all apps)

get
https://api.purchasely.io/management/v1/dashboard/subscriptions_stats

Live subscriptions revenue/churn/refund stats for an application, or across every application you can access. Active subscriber counts are available in the Purchasely console (including Ask your data) and to Purchasely staff. API keys and third-party MCP clients do not get them. They take up to 80 s on large apps.

Required scope: analytics.dashboards:view

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
date_range[]
array of strings
required

Two-element [start_date, end_date] window of ISO8601 dates (YYYY-MM-DD); both ends inclusive (the end date's events are counted). Over REST, send it as date_range[]=2026-10-01&date_range[]=2026-10-25.

date_range[]*
string
enum

Bucket granularity: DAY, WEEK or MONTH (default MONTH). YEAR is not supported by this tool.

Allowed:
countries[]
array of strings

Filter by store country ISO codes (or "Unknown").

countries[]
platform_names[]
array of strings

Filter by platform name.

platform_names[]
Allowed:
period_types[]
array of strings

Filter by plan billing period, as an ISO 8601 duration (e.g. P1W, P1M, P1Y).

period_types[]
plans[]
array of strings

Filter by subscription plan public_id.

plans[]
family_sharing[]
array of strings

Filter by family-sharing flag ("true"/"false" strings).

family_sharing[]
offer_types[]
array of strings

Filter by offer type.

offer_types[]
Allowed:
promotional_offers[]
array of strings

Filter by promotional offer public_id.

promotional_offers[]
audiences[]
array of strings

Filter by audience public_id.

audiences[]
campaigns[]
array of strings

Filter by campaign public_id.

campaigns[]
placements[]
array of strings

Filter by placement public_id.

placements[]
screens[]
array of strings

Filter by screen (paywall) public_id.

screens[]
ab_test_variants[]
array of strings

Filter by A/B test variant public_id.

ab_test_variants[]
string

Restrict to unique users ("true"/"false").

string

Filter by survey identifier.

fields[]
array of strings

Field selection for token economy: an explicit list of field names to include in the response, or ["*"] for every field. Omit for this endpoint's own default field set.

fields[]
Responses

Updated 24 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago

Did this page help you?