Skip to navigation

Breakage report

Credits that expired unused, by class: included (an allowance or a rollover, no cash paid), promotional, and paid (cash paid, so its value at cost_basis is breakage revenue). Operating figures: confirm the accounting treatment, and any limits on expiring prepaid value, with your adviser. Credits and money are reported separately and never added together.

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
todatetimeRequired
credit_typestringOptional

The credit type (ID or key). Without it, every credit type is reported.

group_byenumOptional

How to split the range. Default month.

Allowed values:

Response

The report.
object"breakage_report"
fromdatetime
todatetime
group_byenum
Allowed values:
rowslist of objects
livemodeboolean

Errors

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