Usage summary exposes aggregated usage data for a metered feature in a subscription over a specified reporting period. Use this resource to analyze feature-level usage for reporting or analytics purposes, independent of billing or invoicing.
Each usage summary entry is scoped to a subscription and a metered feature and includes the total usage aggregated over the selected reporting window.
Each usage summary entry includes:
- The subscription for which usage is reported (subscription_id)
- The metered feature for which usage is aggregated (feature_id)
- The total usage aggregated over the reporting window (aggregated_value)
- The reporting window used to compute the aggregated usage (aggregated_from and aggregated_to)
The reporting window is defined using timeframe_start and timeframe_end. If these parameters are not provided, the reporting window defaults to the start of the current subscription term and the current time.
When window_size is specified, the response returns usage data as time-based aggregates for the reporting window. Otherwise, the response returns a single aggregate value for the entire period.
API Index URL
Usage summary attributes
Unique identifier of the subscription for which usage is reported.
Unique identifier of the metered feature for which usage is aggregated.
Start timestamp (inclusive) of the window used to compute total_usage.