{
"type": "entitlement.usage_exceeded",
"messageId": "a6ce...",
"traceId": "549a...",
"timestamp": "2024-03-06T14:59:16.399Z",
"thresholdPercentage": 80,
"usageUsedPercentage": 83,
"currentUsage": 10,
"hasUnlimitedUsage": false,
"hasSoftLimit": false,
"usageLimit": 12,
"usagePeriodAnchor": "2024-01-06T00:00:00.000Z",
"usagePeriodStart": "2024-03-06T00:00:00.000Z",
"usagePeriodEnd": "2024-04-06T00:00:00.000Z",
"resetPeriod": "MONTH",
"resetPeriodConfiguration": {
"accordingTo": "SubscriptionStart"
},
"feature": {
"id": "feature-02-campaigns",
"name": "Campaigns",
"featureType": "NUMBER",
"meterType": "INCREMENTAL",
"unit": "campaign",
"units": "campaigns"
},
"customer": {
"entityId": "e8f61d50-58f1-42e9-9385-c6e97c62a710",
"id": "customer-166d74",
"name": "",
"email": null
},
"resource": null,
"activeSubscriptions": [
{
"id": "subscription-plan-revvenu-essentials-0e736e",
"startDate": "2024-03-06T10:13:37.000Z",
"plan": {
"id": "plan-revvenu-essentials",
"name": "Essentials"
}
}
]
}Entitlement usage exceeded
Fired when usage crosses configured thresholds. Useful for alerts or auto-upgrades.
{
"type": "entitlement.usage_exceeded",
"messageId": "a6ce...",
"traceId": "549a...",
"timestamp": "2024-03-06T14:59:16.399Z",
"thresholdPercentage": 80,
"usageUsedPercentage": 83,
"currentUsage": 10,
"hasUnlimitedUsage": false,
"hasSoftLimit": false,
"usageLimit": 12,
"usagePeriodAnchor": "2024-01-06T00:00:00.000Z",
"usagePeriodStart": "2024-03-06T00:00:00.000Z",
"usagePeriodEnd": "2024-04-06T00:00:00.000Z",
"resetPeriod": "MONTH",
"resetPeriodConfiguration": {
"accordingTo": "SubscriptionStart"
},
"feature": {
"id": "feature-02-campaigns",
"name": "Campaigns",
"featureType": "NUMBER",
"meterType": "INCREMENTAL",
"unit": "campaign",
"units": "campaigns"
},
"customer": {
"entityId": "e8f61d50-58f1-42e9-9385-c6e97c62a710",
"id": "customer-166d74",
"name": "",
"email": null
},
"resource": null,
"activeSubscriptions": [
{
"id": "subscription-plan-revvenu-essentials-0e736e",
"startDate": "2024-03-06T10:13:37.000Z",
"plan": {
"id": "plan-revvenu-essentials",
"name": "Essentials"
}
}
]
}Body
Event type discriminator.
"entitlement.usage_exceeded"Unique webhook message ID.
Correlation ID for tracing.
When the threshold crossing was detected.
The configured threshold that was crossed (e.g.
Current usage as a percentage of the allowed limit.
Current absolute usage amount.
Whether usage is unlimited.
Whether exceeding triggers soft limits only.
Absolute limit for the period if not unlimited.
Anchor timestamp for the usage window.
Start of the current usage window.
End of the current usage window.
Reset interval (e.g.
Configuration describing how the reset anchor is chosen.
Feature for which usage exceeded a threshold.
Show child attributes
Show child attributes
Customer whose usage exceeded the threshold.
Show child attributes
Show child attributes
Resource context if scoped.
Active subscriptions relevant to the entitlement.
Show child attributes
Show child attributes
