logo

Retrieve a monthly recurring revenue report

Retrieve a monthly recurring revenue report.

SecuritySecretApiKey or JWT
Request
query Parameters
currency
required
string (CurrencyCode) = 3 characters

Revenue currency.

Example: currency=USD
periodStart
required
string^\d{4}-\d{2}$

Report start date.

Example: periodStart=2022-01
periodEnd
required
string^\d{4}-\d{2}$

Report end date.

Example: periodEnd=2022-06
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array of objects
Array
period
string^\d{4}-\d{2}$

Revenue month.

total
number <double>

Total Monthly Recurring Revenue (MRR) amount.

object

MRR categories are described below. The difference between current period MRR and previous period MRR is equal to new + reactivated + expanded - contracted - churned.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/monthly-recurring-revenue
Request samples
const report = await api.reports.getMonthlyRecurringRevenue({
    periodStart: '2016-09',
    periodEnd: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
});
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Retrieve a renewal sales report