Skip to navigation
API ReferenceReportingReports

Margin report

Revenue, cost and margin for a range, grouped by customer, model or outcome definition, in one currency. Revenue is split into confirmed, pending and reversed; margin is confirmed revenue minus cost.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

fromdatetimeRequired
Start of the range, inclusive.
todatetimeRequired
End of the range, exclusive.
currencystringRequired
Report in this currency. Charges in other currencies are left out.
group_byenumOptionalDefaults to customer

How to split the range. Default customer.

Allowed values:

Response

The report.
object"margin_report"
currencystring
fromdatetime
todatetime
group_byenum
Allowed values:
datalist of objects
generated_atdatetime
livemodeboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error