@sudoplatform/sudo-entitlements
    Preparing search index...

    Interface EntitlementConsumption

    The consumption of a particular entitlement

    interface EntitlementConsumption {
        available: number;
        consumed: number;
        consumer?: EntitlementConsumer;
        firstConsumedAtEpochMs?: number;
        lastConsumedAtEpochMs?: number;
        name: string;
        value: number;
    }
    Index

    Properties

    available: number

    The amount of the entitlement that is yet to be consumed. Provided for convenience. available + consumed always equals value

    consumed: number

    The amount of the entitlement that has been consumed

    Consumer of the entitlement. If present this indicates the sub-user level resource responsible for consumption of the entitlement. If not present, the entitlement is consumed directly by the user.

    firstConsumedAtEpochMs?: number

    The time at which this entitlement was first consumed

    lastConsumedAtEpochMs?: number

    The most recent time at which this entitlement was consumed

    name: string

    Name of the consumed entitlement

    value: number

    The maximum amount of the entitlement that can be consumed by the consumer