{
"type": "promotionalEntitlement.granted",
"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 granted
Fired when a promotional entitlement is granted to a customer.
WEBHOOK
promotionalEntitlement.granted
{
"type": "promotionalEntitlement.granted",
"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
Allowed value:
"promotionalEntitlement.granted"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
Related topics
Revoke promotional entitlementManaging customers promotional entitlementsUsage, billing & creditsCreate a promotional entitlementsSchema