Retrieve a MRR report

Retrieves a Monthly Recurring Revenue (MRR) report.

Use MRR reports to view information on the predictable recurring revenue for your business over a period of months.

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

Revenue currency.

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

Date and time when the report starts.

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

Date and time when the report ends.

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

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array of objects

Monthly Recurring Revenue (MRR) data.

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 the current period MRR and the previous period MRR is equal to: new + reactivation + expansion - contraction - churned.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/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": [
    ]
}