@modelhealth/modelhealth
    Preparing search index...

    Interface UsageInfo

    Current billing/quota state for the authenticated account.

    Returned by ModelHealthClient.usage().

    interface UsageInfo {
        activitiesMax?: number;
        activitiesUsed?: number;
        isFreeTrial?: boolean;
        periodEnd?: Date;
        planName?: string;
        reason?: UsageReason;
        recordingAllowed: boolean;
        resetPeriod?: ResetPeriod;
        willAutoRenew?: boolean;
    }
    Index
    activitiesMax? activitiesUsed? isFreeTrial? periodEnd? planName? reason? recordingAllowed resetPeriod? willAutoRenew?
    activitiesMax?: number

    Activities allowed in the current period. undefined when there is no active plan. undefined while a plan IS active means unlimited.

    activitiesUsed?: number

    Activities used in the current period. undefined when there is no active plan.

    isFreeTrial?: boolean

    Whether the account is on a free trial. undefined only when there is no org, or no plan and no prior plan history.

    periodEnd?: Date

    When the current usage period ends. undefined when there is no active plan.

    planName?: string

    Name of the active plan. undefined when there is no active plan.

    reason?: UsageReason

    Why recording is blocked. undefined when recordingAllowed is true.

    recordingAllowed: boolean
    resetPeriod?: ResetPeriod

    How often the usage period resets. undefined when there is no active plan.

    willAutoRenew?: boolean

    Whether the plan will automatically renew. undefined when there is no active plan or no subscription is linked.

    Settings
    Member Visibility

    On This Page
    Properties