Transactions
The /reports/transactions endpoint returns a timeline of transaction amounts broken down by type (monthly subscriptions, yearly subscriptions, one-time charges, metered usage, discounts, refunds, fees, tax, and net amount).
GET /reports/transactions
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. |
fix_fx | boolean | Use fixed exchange rates from start date. |
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). |
industry | string | Filter by industry (space-separated). |
channel | string | Filter by channel (space-separated). |
size | string | Filter by customer size (space-separated). |
data_source | string | Filter by data source ID (space-separated). |
Example response
200 OK
{
"currency": "usd",
"result": [
{
"date": "2025-01-01",
"month_sub": 85000,
"year_sub": 35000,
"week_sub": 0,
"day_sub": 0,
"one_time": 5000,
"metered": 2000,
"discount": -3000,
"refund": -1500,
"fee": -2500,
"fx_loss": -200,
"tax": 8000,
"net_amount": 127800,
"net_amount_change_pct": 4.2
}
]
}
Response fields
| Field | Type | Description |
|---|
date | string | Period start date |
month_sub | number | Monthly subscription revenue (cents) |
year_sub | number | Yearly subscription revenue (cents) |
week_sub | number | Weekly subscription revenue (cents) |
day_sub | number | Daily subscription revenue (cents) |
one_time | number | One-time charges (cents) |
metered | number | Metered/usage-based revenue (cents) |
discount | number | Discounts applied (cents, negative) |
refund | number | Refunds issued (cents, negative) |
fee | number | Fees deducted (cents, negative) |
fx_loss | number | Foreign exchange loss (cents, negative) |
tax | number | Tax collected (cents) |
net_amount | number | Net transaction amount (cents) |
net_amount_change_pct | float | Percentage change vs previous period |
