Real-time business metrics for your billing operation. Track monthly recurring revenue (MRR), customer churn, revenue breakdown by plan, and other key indicators.
- MRR - the normalized monthly revenue from all active subscriptions
- Churn - the rate at which customers cancel or downgrade
- Revenue - breakdown by product, plan, currency, and time period
Get churn analytics
Returns customer churn metrics for the organization. Currency-agnostic — counts customers regardless of which currency they bill in.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get churn analytics › Responses
OK
Get monthly recurring revenue
Returns MRR data over a configurable number of months (default 12, max 36). Set segment=customer_type for a B2B-vs-B2C breakdown. Required currency filter.
query Parameters
currencyISO 4217 currency code (e.g. USD, EUR)
ISO 4217 currency code (e.g. USD, EUR)
monthsNumber of months to include (default 12, max 36)
Number of months to include (default 12, max 36)
segmentSet to 'customer_type' to receive a B2B/B2C-segmented response
Set to 'customer_type' to receive a B2B/B2C-segmented response
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get monthly recurring revenue › Responses
OK
Outcome-dependent: with segment=customer_type the MRRByTypeResponse (B2B/B2C-segmented series), otherwise the plain MRRResponse.
Get revenue breakdown
Returns revenue breakdown analytics for the organization. Default groups by plan; pass segment=customer_type for a B2B-vs-B2C breakdown. Required currency filter.
query Parameters
currencyISO 4217 currency code (e.g. USD, EUR)
ISO 4217 currency code (e.g. USD, EUR)
segmentSet to 'customer_type' for B2B/B2C breakdown (default: by plan)
Set to 'customer_type' for B2B/B2C breakdown (default: by plan)
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get revenue breakdown › Responses
OK
Outcome-dependent: with segment=customer_type the RevenueByCustomerTypeResponse, otherwise the plain RevenueResponse breakdown.