Skip to main content
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

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Query Parameters

from
string<date-time>

Start of the window. Defaults to 30 days ago.

to
string<date-time>

End of the window (exclusive). Defaults to now.

group_by
enum<string>
default:day

Bucket granularity. agent returns one row per agent_id (currently only populated for voice_call).

Available options:
day,
month,
total,
agent
product
enum<string>

Filter to a single product category.

Available options:
voice_call,
eval_run,
phone_number,
topup,
refund
include_topups
boolean
default:false

Response

Consumption rows

from
string<date-time>
to
string<date-time>
group_by
string
data
object[]