Allowance use report
How much of its allowance each customer has used in the window it is in now, ranked by percent_used, highest first. Use it to see who is about to run out, and who pays for a plan they barely touch. A row is one customer and one allowance (a refill or a cap), with the same granted, used, remaining and percent_used as a usage summary window. For an allowance with scope: per_member, the row is the member who has used the most, named in member_id.
Send percent_used_over to list only the customers past a chosen share, such as 0.8 for those who have used more than 80%. The report has no money in it, so there is no currency.
Authentication
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
Only allowances whose percent_used is above this decimal, from 0 to 1. 0.8 is 80%.
Only the allowance with this key on a plan, such as weekly.
Only customers on this plan (ID or key).
The credit type (ID or key).
Response
Highest percent_used first.
true when more rows matched than limit returned.