@stigg/node-server-sdk - v4.22.1

    Type Alias EntitlementCheckResult

    Result object of an entitlement access check.

    type EntitlementCheckResult = {
        accessDeniedReason?: InputMaybe<AccessDeniedReason>;
        currentUsage?: InputMaybe<Scalars["Float"]>;
        enumValues?: InputMaybe<Scalars["String"][]>;
        hasAccess: Scalars["Boolean"];
        hasSoftLimit?: InputMaybe<Scalars["Boolean"]>;
        hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>;
        monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>;
        nextResetDate?: InputMaybe<Scalars["DateTime"]>;
        requestedUsage?: InputMaybe<Scalars["Float"]>;
        requestedValues?: InputMaybe<Scalars["String"][]>;
        resetPeriod?: InputMaybe<EntitlementResetPeriod>;
        usageLimit?: InputMaybe<Scalars["Float"]>;
        weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>;
        yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>;
    }
    Index

    Properties

    accessDeniedReason?: InputMaybe<AccessDeniedReason>

    Optional message explaining why access to the feature is denied.

    currentUsage?: InputMaybe<Scalars["Float"]>

    The amount of the feature the customer has used so far in the current period.

    enumValues?: InputMaybe<Scalars["String"][]>

    List of enum values applicable to this entitlement, if it is an enum feature.

    hasAccess: Scalars["Boolean"]

    Indicates whether the customer currently has access to the feature.

    hasSoftLimit?: InputMaybe<Scalars["Boolean"]>

    Indicates whether the usage limit is soft — usage can exceed the limit, but will be tracked.

    hasUnlimitedUsage?: InputMaybe<Scalars["Boolean"]>

    Indicates whether this entitlement grants unlimited usage with no enforced cap.

    monthlyResetPeriodConfiguration?: InputMaybe<MonthlyResetPeriodConfigInput>

    Configuration for monthly usage reset.

    nextResetDate?: InputMaybe<Scalars["DateTime"]>

    The next date when the entitlement usage resets.

    requestedUsage?: InputMaybe<Scalars["Float"]>

    The amount of usage requested by the customer.

    requestedValues?: InputMaybe<Scalars["String"][]>

    The values requested by the customer, if applicable.

    resetPeriod?: InputMaybe<EntitlementResetPeriod>

    The interval at which usage resets automatically, such as monthly or yearly.

    usageLimit?: InputMaybe<Scalars["Float"]>

    The maximum allowed usage for this entitlement before restrictions apply.

    weeklyResetPeriodConfiguration?: InputMaybe<WeeklyResetPeriodConfigInput>

    Configuration for weekly usage reset.

    yearlyResetPeriodConfiguration?: InputMaybe<YearlyResetPeriodConfigInput>

    Configuration for yearly usage reset.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR