v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Analytics

Get analytics

Retrieve your pre-computed account's analytics (ARR, revenues, churn, etc).

get/v1/analytics

Query parameters

invoicing_entity_idstring

Invoicing Entity ID to filter analytics

Example:ive_47484fjdhy5

Invoicing Entity ID to filter analytics

Response

revenue_last_30_daysnumber required

Revenue of the last 30 days. Expressed in the currency's smallest unit.

churn_30_daysnumber required

Churn of the last 30 days. Churn corresponds to the number of customers who churned divided by the number of active customers. A churned customer is one who had a subscription but no longer has an active one.

churned_revenue_30_daysnumber required

Revenue corresponding to the churn of the last 30 days. Expressed in the currency's smallest unit.

arrnumber required

Computed live Annual Recurring Revenue. Expressed in the currency's smallest unit.

mrrnumber required

Computed live Monthly Recurring Revenue. Expressed in the currency's smallest unit.

pending_arrnumber required

Computed pending Annual Recurring Revenue. The sum of ARR from all pending subscriptions. Expressed in the currency's smallest unit.

active_arrnumber required

Computed pending Annual Recurring Revenue. The sum of ARR from all active subscriptions. Expressed in the currency's smallest unit.

arr_in_discountsnumber required

Annual Recurring Revenue currently under coupons. Expressed in the currency's smallest unit.

fixed_arrnumber required

Computed live Annual Recurring Revenue without the discounted amount (coupons). Expressed in the currency's smallest unit.

active_customersnumber required

Number of customers with an assigned subscriptions.

arpanumber required

Average Revenue Per Account (customer).