Entitlements updated

Body

application/json

type

string

required

Event type discriminator.

Allowed value: "entitlements.updated"

messageId

string

required

Unique webhook message ID.

traceId

string

required

Correlation ID for tracing.

entitlements

object[]

required

The new list of effective entitlements.

Show child attributes

entitlements.feature

object

Feature metadata for the entitlement.

Show child attributes

entitlements.feature.entityId

string | null

Stigg UUID of the feature entity.

entitlements.feature.id

string

Feature identifier.

entitlements.feature.name

string

Feature name.

entitlements.feature.description

string | null

Optional feature description.

entitlements.feature.unit

string | null

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

entitlements.feature.units

string | null

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

entitlements.feature.featureType

string | null

Feature type (e.g., NUMBER, BOOLEAN, ENUM).

entitlements.feature.meterType

string | null

Metering model for the feature, if any (e.g., INCREMENTAL).

entitlements.feature.status

string | null

Feature lifecycle status.

entitlements.feature.enumConfiguration

object

Enum configuration when featureType is ENUM.

entitlements.usageLimit

number | null

Maximum allowed usage in the period (null means unlimited).

entitlements.hasUnlimitedUsage

boolean | null

Indicates unlimited usage regardless of limit fields.

entitlements.hasSoftLimit

boolean | null

Whether exceeding usage triggers only soft limits.

entitlements.currentUsage

number | null

Current measured usage in the active window.

entitlements.usagePeriodAnchor

string<date-time> | null

Anchor timestamp for calculating reset windows.

entitlements.usagePeriodStart

string<date-time> | null

Start of the current usage window.

entitlements.usagePeriodEnd

string<date-time> | null

End of the current usage window.

entitlements.resetPeriod

string | null

Reset interval (e.g., MONTH, YEAR) when applicable.

entitlements.resetPeriodConfiguration

object

Configuration describing how the reset anchor is chosen.

entitlements.enumValues

string[] | null

For ENUM features, the effective enum values for this entitlement (if applicable).

entitlementsUpdatedAt

string<date-time>

required

Timestamp of the entitlement recalculation.

timestamp

string<date-time>

Time the entitlements were recalculated.

trigger

string

Originating action that caused the update (e.g., subscription_updated).

customer

object

Customer for whom effective entitlements changed.

Show child attributes

customer.id

string

External/customer-facing ID.

customer.name

string | null

Customer name.

customer.email

string | null

Customer email address.

customer.billingId

string | null

Billing provider customer identifier.

resource

object

Resource context for the entitlements when scoped to a specific resource. Null for customer-scoped entitlements.

Show child attributes

resource.id

string

External/resource identifier (your system’s ID).

resource.entityId

string

Stigg UUID of the resource entity.

environmentId

string | null

Stigg environment in which the change occurred.

eventId

string

Unique ID of the underlying event that triggered this webhook.

actor

object

Actor that initiated the change (system or user).

Show child attributes

actor.type

string

Actor type (e.g., SYSTEM, SUPPORT, USER).

Products

Plans

Add-ons

Features

Coupons

Customers

Subscriptions

Trials

Measurements

Credit grants

Credit balance

Entitlements

Promotional entitlements

Third-party sync

Entitlements updated

Body