{
"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"
}Promotional entitlements
Promotional entitlement updated
Fired when a promotional entitlement changes (limits, visibility, or period).
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
Event type discriminator.
Allowed value:
"promotionalEntitlement.updated"Unique webhook message ID.
Correlation ID for tracing.
Promotional entitlement ID.
Current status of the entitlement.
Canonical representation of a feature that can be packaged in plans or add-ons.
Show child attributes
Show child attributes
Minimal customer object embedded in events.
Show child attributes
Show child attributes
Whether usage is unlimited.
Max usage if not unlimited.
Period for usage resets (e.g.
Reset anchor configuration (e.g., according to subscription start).
Whether the entitlement is visible to the user.
Human-readable period (e.g. "1 month").
Entitlement end time (ISO 8601).
Related topics
Revoke promotional entitlementCreate a promotional entitlementsEntitlements updatedGet a list of promotional entitlementsPromotional entitlement granted