WEBHOOK
entitlement.usage_exceeded
{
  "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

application/json
type
string

Event type discriminator.

Allowed value: "entitlement.usage_exceeded"
messageId
string

Unique webhook message ID.

traceId
string

Correlation ID for tracing.

timestamp
string<date-time>

When the threshold crossing was detected.

thresholdPercentage
number

The configured threshold that was crossed (e.g.

usageUsedPercentage
number

Current usage as a percentage of the allowed limit.

currentUsage
number

Current absolute usage amount.

hasUnlimitedUsage
boolean

Whether usage is unlimited.

hasSoftLimit
boolean

Whether exceeding triggers soft limits only.

usageLimit
number

Absolute limit for the period if not unlimited.

usagePeriodAnchor
string<date-time>

Anchor timestamp for the usage window.

usagePeriodStart
string<date-time>

Start of the current usage window.

usagePeriodEnd
string<date-time>

End of the current usage window.

resetPeriod
string

Reset interval (e.g.

resetPeriodConfiguration
object

Configuration describing how the reset anchor is chosen.

feature
object

Feature for which usage exceeded a threshold.

customer
object

Customer whose usage exceeded the threshold.

resource
any

Resource context if scoped.

activeSubscriptions
object[]

Active subscriptions relevant to the entitlement.