On this page
No Headings
Represents the lifetime usage metrics for a given subscription.
objectexternal_subscription_idstringUnique external identifier of the subscription.
external_historical_usage_amountobjectThe total historical usage amount for this subscription, representing usage accumulated prior to the start of invoiced and current usage tracking.
invoiced_usage_amountobjectThe total usage amount, that has been invoiced for this subscription, provided by your own application.
current_usage_amountobjectThe total usage amount, accumulated for the subscription during the current billing period
fromobjectdate-timeDate and time in ISO 8601 format.
The start date and time (with timezone) of the tracked lifetime usage for the subscription.
toobjectdate-timeDate and time in ISO 8601 format.
The end date and time (with timezone) of the tracked lifetime usage for the subscription.
usage_thresholdsarrayAn array of usage thresholds configured in the subscription's plan.
itemsobjectRepresents a usage threshold milestone for a subscription.
amountobjectThe usage threshold amount
completion_rationumberdoubleThe ratio (between 0 and 1) representing the proportion of the threshold amount that has been used.
reached_atobjectdate-timeDate and time in ISO 8601 format.
The date and time (in ISO 8601 format with timezone) when this usage threshold was reached.