Transaction detail
The /reports/transactions-detail endpoint returns individual transaction records for a given period and type. Use this to drill down into specific transaction categories from the transactions overview.
GET /reports/transactions-detail
Query parameters
| Parameter | Type | Description |
|---|---|---|
selected-date | string | Period start date to show transactions for. *Not required when using customer parameter. |
selected-type | string | Transaction type: month_sub, year_sub, week_sub, day_sub, one_time, metered, discount, refund, fee. *Not required when using customer parameter. |
customer | string | Filter by customer ID. When set, shows transactions grouped by transaction. |
baseCurrency | string | Target currency for conversion. |
interval | string | Aggregation interval. Defaults to month. |
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": {
"list": [
{
"date": "2025-01-15",
"customer_id": "cus_123",
"customer_name": "Acme Corp",
"customer_email": "[email protected]",
"type": "month_sub",
"status": "paid",
"transaction_id": "txn_abc123",
"currency": "usd",
"description": "Pro Plan - Jan 2025",
"amount": 9900,
"amount_base_currency": 9900
}
]
}
}Response fields
| Field | Type | Description |
|---|---|---|
date | string | Transaction date |
customer_id | string | Customer external ID |
customer_name | string | Customer name |
customer_email | string | Customer email |
type | string | Transaction type |
status | string | Payment status |
transaction_id | string | Transaction reference ID |
currency | string | Original transaction currency |
description | string | Transaction description |
amount | number | Amount in original currency (cents) |
amount_base_currency | number | Amount in base currency (cents) |
When using the customer parameter, each transaction may include a lines array with invoice line-level detail.
