Payment failure rate
The /reports/cashflow-failure-rate endpoint returns payment failure rate and recovery rate metrics over time. Supports optional breakdown by dimension.
GET /reports/cashflow-failure-rate
Query parameters
| Parameter | Type | Description |
|---|---|---|
date | string | Date range. Format: YYYYMMDD-YYYYMMDD. Defaults to last 365 days. |
interval | string | Aggregation interval: day, week, month, quarter, year. Defaults to month. |
breakdown | string | Optional breakdown dimension. |
region | string | Filter by region or country codes (space-separated). |
currency | string | Filter by currency codes (space-separated). |
plan | string | Filter by plan group IDs (space-separated). |
data_source | string | Filter by data source ID (space-separated). |
Example response
200 OK
{
"result": [
{
"date": "2025-01-01",
"failed_pct": 3.2,
"recovery_rate": 75.0,
"failed_invoices": 8,
"total_invoices": 250,
"recovered_invoices": 6
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
date | string | Period start date |
failed_pct | float | Percentage of invoices that failed |
recovery_rate | float | Percentage of failed payments recovered |
failed_invoices | integer | Number of failed invoices |
total_invoices | integer | Total invoices in period |
recovered_invoices | integer | Number of recovered invoices |
When using the breakdown parameter, the response includes a breakdown object with per-dimension values.
