Skip to main content
GET
/
api
/
v1
/
metrics
/
mrr
Mrr Report Api
curl --request GET \
  --url https://api.justpaid.io/api/v1/metrics/mrr \
  --header 'Authorization: Bearer <token>'
{
  "request_id": "req_abc123def456",
  "data": [
    {
      "name": "New MRR",
      "values": [
        {
          "year": 2025,
          "month": 1,
          "amount": 5000.5
        },
        {
          "year": 2025,
          "month": 2,
          "amount": 6200.75
        }
      ]
    },
    {
      "name": "Churn MRR",
      "values": [
        {
          "year": 2025,
          "month": 1,
          "amount": -500
        },
        {
          "year": 2025,
          "month": 2,
          "amount": -300
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
year
integer

The year for which to retrieve MRR metrics. Defaults to the current year if not specified. Must be between 2000 and 2100.

Required range: 2000 <= x <= 2100
Example:

2025

​
months_ahead
integer

Number of months to project forward from the specified year. This allows you to retrieve forward-looking MRR projections. Defaults to 12 months. Maximum of 60 months (5 years).

Required range: 0 <= x <= 60
Example:

12

Response

MRR report retrieved successfully

Complete MRR report response.

Contains all 9 MRR metric types, each with their time series values. Data is grouped by metric type (not by month) for easier consumption in dashboards.

​
request_id
string
required

Unique request identifier for debugging and tracing

Example:

"req_abc123def456"

​
data
MetricGroupSchema · object[]
required

List of metric groups. Each group contains time series data for one of the 9 MRR metrics.