Promotional entitlement granted

POST

promotionalEntitlement.granted

Body

application/json

type

string

Allowed value: "promotionalEntitlement.granted"

messageId

string

traceId

string

status

string

feature

object

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

Show child attributes

feature.id

string

Unique feature identifier in Stigg.

feature.name

string

Human-readable name of the feature.

feature.description

string | null

Optional marketing/admin description of the feature.

feature.unit

string | null

Singular measurement unit for usage (e.g., "seat").

feature.units

string | null

Plural measurement unit for usage (e.g., "seats").

feature.featureType

string

Data type/category of the feature (e.g., NUMBER, BOOLEAN).

feature.meterType

string | null

Metering model if applicable (e.g., INCREMENTAL, FLUCTUATING).

feature.status

string

Current lifecycle status of the feature (e.g., ACTIVE).

customer

object

Minimal customer object embedded in events.

Show child attributes

customer.entityId

string

Stigg UUID of the customer entity.

customer.id

string

External/customer-facing identifier (your system’s ID).

customer.name

string | null

Customer name (company or individual).

customer.email

string | null

Primary customer email address.

customer.billingId

string | null

Identifier for the customer in the connected billing provider.

customer.crmId

string | null

Identifier for the customer in your CRM.

customer.metadata

object

Arbitrary key-value attributes attached to the customer.

customer.excludeFromExperiment

boolean | null

Whether the customer is excluded from experiments.

customer.experimentInfo

object

Current experiment assignment for this customer.

Show child attributes

customer.experimentInfo.id

string

Experiment identifier.

customer.experimentInfo.name

string

Experiment name.

customer.experimentInfo.groupName

string

Assigned group’s human-readable name.

customer.experimentInfo.groupType

string

Group type/classification (e.g., CONTROL, VARIANT).

customer.billingCurrency

string | null

ISO currency code used for billing the customer.

hasUnlimitedUsage

boolean

usageLimit

number

resetPeriod

string

resetPeriodConfiguration

object

isVisible

boolean

period

string

endDate

string<date-time>

Entitlement usage exceeded Promotional entitlement updated

⌘I

Products

Plans

Add-ons

Features

Coupons

Customers

Subscriptions

Trials

Measurements

Credit grants

Credit balance

Entitlements

Promotional entitlements

Third-party sync

Promotional entitlement granted

Body