WEBHOOK
promotionalEntitlement.updated
{
  "type": "promotionalEntitlement.updated",
  "messageId": "a6ce...",
  "traceId": "549a...",
  "id": "plan-test-id",
  "status": "Active",
  "feature": {
    "id": "feature-test-id",
    "name": "feature-test-name",
    "unit": "seat",
    "units": "seats",
    "description": "feature test description",
    "featureType": "NUMBER",
    "meterType": "INCREMENTAL",
    "status": "ACTIVE"
  },
  "customer": {
    "entityId": "customer-uuid",
    "id": "customer-test-id",
    "name": "customer-test",
    "email": "john@example.com",
    "billingId": "customer-test-billing-id",
    "crmId": "customer-test-crm-id"
  },
  "hasUnlimitedUsage": false,
  "usageLimit": 100,
  "resetPeriod": "MONTH",
  "resetPeriodConfiguration": {
    "accordingTo": "SubscriptionStart"
  },
  "isVisible": true,
  "period": "1 month",
  "endDate": "2022-04-10T00:00:00.001Z"
}

Body

application/json
type
string

Event type discriminator.

Allowed value: "promotionalEntitlement.updated"
messageId
string

Unique webhook message ID.

traceId
string

Correlation ID for tracing.

id
string

Promotional entitlement ID.

status
string

Current status of the entitlement.

feature
object

Canonical representation of a feature that can be packaged in plans or add-ons.

customer
object

Minimal customer object embedded in events.

hasUnlimitedUsage
boolean

Whether usage is unlimited.

usageLimit
number

Max usage if not unlimited.

resetPeriod
string

Period for usage resets (e.g.

resetPeriodConfiguration
object

Reset anchor configuration (e.g., according to subscription start).

isVisible
boolean

Whether the entitlement is visible to the user.

period
string

Human-readable period (e.g. "1 month").

endDate
string<date-time>

Entitlement end time (ISO 8601).