Skip to main content

Usage

Metered usage for usage-based billing: raw records, the aggregated summary per subscription item, and the daily and monthly snapshots.

Families on this page​

FamilyToolsreadwritedestructive
usage — Metered usage7430

usage​

ToolKindPermissionEndpointWhat it does
billing_usage_listreadusage.viewGET /v1/usageList raw usage records for metered billing.
billing_usage_reportwriteusage.viewPOST /v1/usageReport metered usage.
billing_usage_summaryreadusage.viewGET /v1/usage/summaryAggregated usage for a period: total quantity per subscription item, against its plan limit.
billing_usage_snapshots_daily_listreadusage.viewGET /v1/usage/snapshots/dailyList daily usage snapshots.
billing_usage_snapshots_daily_createwriteusage.viewPOST /v1/usage/snapshots/dailyPush daily usage snapshots — one inline, or up to 100 in records.
billing_usage_snapshots_monthly_listreadusage.viewGET /v1/usage/snapshots/monthlyList monthly usage snapshots.
billing_usage_snapshots_monthly_createwriteusage.viewPOST /v1/usage/snapshots/monthlyPush monthly usage snapshots — one inline, or a batch in records.

The fields of each resource are in the API reference and in billing_schemas_get.

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.