Billing consumption
Billing
Billing Consumption
Aggregated negative-balance debits from your credit account, bucketed by date and
product. Useful for usage dashboards, monthly invoice reconciliation, and anomaly
detection. Required scope billing:read.
By default, top-ups (positive credits) are excluded — pass include_topups=true to
include them.
GET
Billing consumption
Aggregated debits from your credit account, bucketed by date and product. Useful for usage dashboards, monthly reconciliation, and anomaly detection.
By default, top-ups are excluded — pass
include_topups=true to fold them in for full statement parity.
Common queries
Products
Authorizations
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Query Parameters
Start of the window. Defaults to 30 days ago.
End of the window (exclusive). Defaults to now.
Bucket granularity. agent returns one row per agent_id (currently only populated for voice_call).
Available options:
day, month, total, agent Filter to a single product category.
Available options:
voice_call, eval_run, phone_number, topup, refund