API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Get series data for subscription
Get series data for subscription analytics, including MRR, new-MRR, expansion-MRR, churn-MRR. The result has one data-point for each currency and date combination. The data-point contains the MRR, new-MRR, expansion-MRR, and churn-MRR for the given currency and date.
Required permissions:analytics:read
curl -X GET \
/analytics/subscription-revenue \
--header "Authorization: Bearer <token>"
{
"data": [
{
"date": "2023-09-10 00:00:00",
"currency_code": "EUR",
"revenue": "1000.00",
"churn_revenue": "300.00",
"expansion_revenue": "150.00",
"new_revenue": "300.00"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}
Authorizations
Value for the Authorization header parameter.
Response
The date for the current data point. The date is in the timezone of the tenant.
"2023-09-10 00:00:00"
The currency code for the revenue data.
"EUR"
The MRR for the current data point as string-float.
"1000.00"
The new-MRR for the current data point as string-float. The value is null, when there is no churn for the given currency and date.
"300.00"
The expansion-MRR for the current data point as string-float. The value is null, when there is no expansion for the given currency and date.
"150.00"
The new-MRR for the current data point as string-float. The value is null, when there is no new mrr for the given currency and date.
"300.00"
Was this page helpful?
curl -X GET \
/analytics/subscription-revenue \
--header "Authorization: Bearer <token>"
{
"data": [
{
"date": "2023-09-10 00:00:00",
"currency_code": "EUR",
"revenue": "1000.00",
"churn_revenue": "300.00",
"expansion_revenue": "150.00",
"new_revenue": "300.00"
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}