Type Alias EntitlementAttributes

Optional details on an entitlement grant (a user owning an item or feature).

type EntitlementAttributes = {
    expiresAt?: number | null;
    quantity?: number;
    source?: string;
    version?: number;
}

Properties

expiresAt?: number | null

When the entitlement lapses, in epoch milliseconds; null (or absent) means it never expires.

quantity?: number

How many units the grant confers; a positive integer when present (validated at submit).

source?: string

Where the grant came from (a promotion, a bundle), recorded on the grant for the audit trail.

version?: number

The grant's version, for hosts that version their item definitions.