Returns revenue summary with invoice and payment breakdowns (outstanding/paid/writtenOff), plus a time-series trend. Revenue is sourced from all issued invoices (v0 + v1) and completed payments.
API key authentication
Start of the time range (ISO 8601 format)
End of the time range (ISO 8601 format)
Time bucket granularity for trend data
hour, day, week Filter by merchant ID. At least one of merchantId, subscriptionIds, or customerId must be provided. Unique identifier for an organization
^org_[a-zA-Z0-9]+$Filter by customer ID. At least one of merchantId, subscriptionIds, or customerId must be provided.
Filter by subscription IDs. At least one of merchantId, subscriptionIds, or customerId must be provided.
Group invoice data by dimension. Max 5 groups (top 4 + 'other' when exceeding).
plan Revenue summary data
Object type identifier
"revenue_summary"Net collected revenue in dollars (paid invoices + completed payments)
Time-bucketed revenue trend data
Invoice breakdown by group dimension (only present when groupBy is specified)