Get subject entitlement history
Returns historical balance and usage data for the entitlement. The queried history can span accross multiple reset events.
BurndownHistory returns a continous history of segments, where the segments are seperated by events that changed either the grant burndown priority or the usage period.
WindowedHistory returns windowed usage data for the period enriched with balance information and the list of grants that were being burnt down in that window.
⚠️ Deprecated: Use GET /api/v2/customers/{customerIdOrKey}/entitlements/{entitlementIdOrFeatureKey}/history instead.
Path parameters
Query parameters
Start of time range to query entitlement: date-time in RFC 3339 format. Defaults to the last reset. Gets truncated to the granularity of the underlying meter.
End of time range to query entitlement: date-time in RFC 3339 format. Defaults to now. If not now then gets truncated to the granularity of the underlying meter.
Aggregation window size.
Windowsize
The timezone used when calculating the windows.
Response
The request has succeeded.
Example response
{
"windowedHistory": [
{
"period": {
"from": "2023-01-01T01:01:01.001Z",
"to": "2023-02-01T01:01:01.001Z"
},
"usage": 100,
"balanceAtStart": 100
}
],
"burndownHistory": [
{
"period": {
"from": "2023-01-01T01:01:01.001Z",
"to": "2023-02-01T01:01:01.001Z"
},
"usage": 100,
"overage": 100,
"balanceAtStart": 100,
"grantBalancesAtStart": {
"01G65Z755AFWAKHE12NY0CQ9FH": 100
},
"balanceAtEnd": 100,
"grantBalancesAtEnd": {
"01G65Z755AFWAKHE12NY0CQ9FH": 100
},
"grantUsages": [
{
"grantId": "01G65Z755AFWAKHE12NY0CQ9FH",
"usage": 100
}
]
}
]
}