Subscription Financial Summary

GET

subscriptions

{id}

financial-summary

Subscription financial summary

curl --request GET \
  --url https://billing.example.com/v1/subscriptions/{id}/financial-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/subscriptions/{id}/financial-summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/subscriptions/{id}/financial-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/subscriptions/{id}/financial-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/subscriptions/{id}/financial-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/subscriptions/{id}/financial-summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "currency": "<string>",
    "mrr": 123,
    "recurring_amount": 123,
    "interval_unit": "<string>",
    "interval_count": 123,
    "current_period_start": "2023-11-07T05:31:56Z",
    "current_period_end": "2023-11-07T05:31:56Z",
    "next_invoice_date": "2023-11-07T05:31:56Z",
    "next_invoice_base_amount": 123,
    "coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "discount_active": true,
    "outstanding": [
      {
        "currency": "<string>",
        "outstanding": 123,
        "past_due": 123,
        "past_due_count": 123,
        "billed": 123,
        "paid": 123
      }
    ]
  }
}

What it returns

One subscription’s financial position:

mrr — the monthly-normalized list price, counted only when the subscription is active (0 otherwise). This matches the tenant-wide MRR definition, so summing it across subscriptions agrees with the dashboard.
recurring_amount, interval_unit, interval_count — the recurring list price and its interval.
next_invoice_date and next_invoice_base_amount — when it will renew and the base amount. Base is the plan list price only; it excludes tax, coupon, add-ons, and usage, so it is never the total that will be due.
outstanding — the subscription’s invoice-derived position per currency, in the same shape as the customer financial summary.

See Explain any number for how this fits with the other drill-down endpoints.

Example request

curl https://api.recurso.dev/v1/subscriptions/b9071c55-0e14-4720-80f3-665613ceb7de/financial-summary \
  -H "Authorization: Bearer $API_KEY"

Example response

{
  "data": {
    "subscription_id": "b9071c55-0e14-4720-80f3-665613ceb7de",
    "status": "active",
    "currency": "USD",
    "mrr": 100000,
    "recurring_amount": 100000,
    "interval_unit": "month",
    "interval_count": 1,
    "current_period_start": "2026-08-01T00:00:00Z",
    "current_period_end": "2026-09-01T00:00:00Z",
    "next_invoice_date": "2026-09-01T00:00:00Z",
    "next_invoice_base_amount": 100000,
    "coupon_id": null,
    "discount_active": false,
    "outstanding": [
      {
        "currency": "USD",
        "outstanding": 118000,
        "past_due": 0,
        "past_due_count": 0,
        "billed": 354000,
        "paid": 236000
      }
    ]
  }
}

Fields

Field	Type	Description
`status`	string	The subscription’s current status
`currency`	string	The subscription’s billing currency
`mrr`	integer (int64)	Monthly-normalized recurring value; `0` unless `active`
`recurring_amount`	integer (int64)	Recurring list price per interval, minor units
`interval_unit` / `interval_count`	string / integer	Billing interval (e.g. `month` × `1`)
`current_period_start` / `current_period_end`	string (date-time)	The current billing period
`next_invoice_date`	string (date-time), nullable	When the next invoice will be generated; `null` when it will not renew
`next_invoice_base_amount`	integer (int64)	Plan list price only — excludes tax, coupon, add-ons, and usage
`coupon_id`	string (uuid), nullable	Attached coupon, if any
`discount_active`	boolean	Whether that coupon currently applies
`outstanding[]`	array	Per-currency `outstanding`, `past_due`, `past_due_count`, `billed`, `paid`

Read-only. A missing or cross-tenant id returns 404. For what canceling this subscription would do to these numbers, see Cancel Preview.

Authorizations

Authorization

string

header

required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

string<uuid>

required

Response

The subscription's financial summary.

data

object

Show child attributes

Subscription financial summary

curl --request GET \
  --url https://billing.example.com/v1/subscriptions/{id}/financial-summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://billing.example.com/v1/subscriptions/{id}/financial-summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://billing.example.com/v1/subscriptions/{id}/financial-summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://billing.example.com/v1/subscriptions/{id}/financial-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://billing.example.com/v1/subscriptions/{id}/financial-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://billing.example.com/v1/subscriptions/{id}/financial-summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": {
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "currency": "<string>",
    "mrr": 123,
    "recurring_amount": 123,
    "interval_unit": "<string>",
    "interval_count": 123,
    "current_period_start": "2023-11-07T05:31:56Z",
    "current_period_end": "2023-11-07T05:31:56Z",
    "next_invoice_date": "2023-11-07T05:31:56Z",
    "next_invoice_base_amount": 123,
    "coupon_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "discount_active": true,
    "outstanding": [
      {
        "currency": "<string>",
        "outstanding": 123,
        "past_due": 123,
        "past_due_count": 123,
        "billed": 123,
        "paid": 123
      }
    ]
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Subscription Financial Summary

What it returns

Example request

Example response

Fields

Authorizations

Path Parameters

Response

​What it returns

​Example request

​Example response

​Fields

Authorizations

Path Parameters

Response

What it returns

Example request

Example response

Fields