Skip to navigation

Outcome report

Counts, and amounts by currency or credit type, of outcome charges over time, grouped by status, outcome definition, reversal reason or source. It gives the totals a list can’t: how many charges, and what share were reversed or disputed. Amounts in credits and in money are never added together. Never sum list pages to get money.

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.
granularityenumOptionalDefaults to day

The bucket size. Default day.

Allowed values:
group_byenumOptionalDefaults to status

How to split each period. Default status.

Allowed values:
definitionstringOptional

Only charges for this outcome definition (ID or key).

livemodebooleanOptional
Only live or only sandbox data. Defaults to the key's environment.

Response

The report.
object"outcome_report"
fromdatetime
todatetime
granularityenum
Allowed values:
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