Refunds
The /reports/cashflow-refunds endpoint returns a timeline of refund metrics.
GET /reports/cashflow-refunds
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. |
baseCurrency | string | Target currency for conversion. Defaults to account base currency. |
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
{
"currency": "usd",
"result": [
{
"date": "2025-01-01",
"refund_count": 5,
"refund_amount": 12500,
"customers_refunded": 4
}
]
}
Response fields
| Field | Type | Description |
|---|
date | string | Period start date |
refund_count | integer | Number of refunds issued |
refund_amount | number | Total refund amount (cents) |
customers_refunded | integer | Number of customers who received refunds |
