Get Recovered Revenue

GET

analytics

dunning

recovered

Recovered revenue attribution

curl --request GET \
  --url https://billing.example.com/v1/analytics/dunning/recovered \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/v1/analytics/dunning/recovered', 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/analytics/dunning/recovered",
  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/analytics/dunning/recovered"

	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/analytics/dunning/recovered")

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

{
  "recovered_amount_total": {},
  "recovered_count": 123,
  "avg_attempts": 123,
  "avg_days_to_recover": 123,
  "monthly": [
    {
      "month": "<string>",
      "currency": "<string>",
      "amount": 123,
      "count": 123
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

Returns recovery attribution for the authenticated tenant: every invoice that was paid after at least one failed payment attempt (or under an active dunning action or campaign) is counted as recovered revenue.

Example Request

curl https://api.recurso.dev/v1/analytics/dunning/recovered \
  -H "Authorization: Bearer $API_KEY"

Response

{
  "recovered_amount_total": {
    "INR": 1249750,
    "USD": 89900
  },
  "recovered_count": 42,
  "avg_attempts": 2.4,
  "avg_days_to_recover": 3.7,
  "monthly": [
    { "month": "2026-05", "currency": "INR", "amount": 349900, "count": 11 },
    { "month": "2026-06", "currency": "INR", "amount": 249950, "count": 8 },
    { "month": "2026-06", "currency": "USD", "amount": 19900, "count": 2 }
  ]
}

Field	Type	Description
`recovered_amount_total`	object	Total recovered, in minor units, keyed by currency — amounts are never summed across currencies
`recovered_count`	integer	Number of recovered invoices
`avg_attempts`	number	Average failed attempts before recovery
`avg_days_to_recover`	number	Average days from invoice creation to payment
`monthly`	array	Last-12-months series, one entry per month × currency
`monthly[].month`	string	`YYYY-MM`
`monthly[].amount`	integer	Recovered amount for the bucket, minor units
`monthly[].count`	integer	Recovered invoices in the bucket

Notes

An invoice paid on the first attempt is not recovered revenue — the qualification is at least one failed attempt or an active dunning action/campaign at payment time.
Each recovery record also stores the strategy that was in effect (the tenant’s DUNNING_STRATEGY, or campaign when a dunning campaign execution drove the invoice); recording is idempotent per invoice.
The dunning dashboard renders this endpoint as its recovered revenue panel.

Pair this with the dunning overview to see both the activity (retries attempted) and the outcome (revenue actually recovered).

Authorizations

Authorization

string

header

required

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

Response

Recovery attribution report

recovered_amount_total

object

Total recovered, in minor units, keyed by currency.

Show child attributes

recovered_count

integer

avg_attempts

number

avg_days_to_recover

number

monthly

object[]

Show child attributes

Recovered revenue attribution

curl --request GET \
  --url https://billing.example.com/v1/analytics/dunning/recovered \
  --header 'Authorization: Bearer <token>'

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

fetch('https://billing.example.com/v1/analytics/dunning/recovered', 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/analytics/dunning/recovered",
  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/analytics/dunning/recovered"

	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/analytics/dunning/recovered")

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

{
  "recovered_amount_total": {},
  "recovered_count": 123,
  "avg_attempts": 123,
  "avg_days_to_recover": 123,
  "monthly": [
    {
      "month": "<string>",
      "currency": "<string>",
      "amount": 123,
      "count": 123
    }
  ]
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  }
}

Getting Started

Core

Billing & Invoicing

Revenue & Finance

Growth & Recovery

Compliance (India)

Platform

Customer Portal API

Example Request

Response

Notes

Authorizations

Response

​Example Request

​Response

​Notes

Authorizations

Response

Example Request

Response

Notes