Get Meter Usage Summary

GET

/api/:account_id/meters/:meter_id/usage-summary

Get aggregated usage for a meter over a time window. Optionally filter by customer.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

meter_idstringRequired

account_idstringRequired

customer_idstring or nullOptional

Customer ID (optional, omit to aggregate all customers)

merchant_account_idstring or nullOptional

Merchant account ID (optional; scopes usage to one merchant).

start_timedatetimeRequired

Start of time window (inclusive)

end_timedatetimeRequired

End of time window (exclusive)

Successful Response

meter_idstring

customer_idstring or null

aggregation_formulaenum

start_timedatetime

end_timedatetime

aggregated_valuedouble

422

Unprocessable Entity Error

$	curl -G https://app.paymentkit.com/api/account_id/meters/meter_id/usage-summary \
>	-H "Authorization: Bearer <token>" \
>	-d start_time=start_time \
>	-d end_time=end_time