Interface Usage

Deprecated

Use usage.getAggregated() instead. Sunset: 2027-02-28.

interface Usage {
    dateRange: {
        endAt: string;
        startAt: string;
    };
    metric: UsageMetricEnum;
    sys: MetaSysProps & {
        organization?: {
            sys: MetaLinkProps;
        };
    };
    unitOfMeasure: string;
    usage: number;
    usagePerDay: {
        [key: string]: number;
    };
    toPlainObject(): UsageProps;
}

Hierarchy (view full)

Properties

dateRange metric sys unitOfMeasure usage usagePerDay

Methods

toPlainObject

Properties

dateRange

dateRange: {
    endAt: string;
    startAt: string;
}

Range of usage

metric

metric: UsageMetricEnum

Type of usage

sys

sys: MetaSysProps & {
    organization?: {
        sys: MetaLinkProps;
    };
}

System metadata

unitOfMeasure

unitOfMeasure: string

Unit of usage metric

usage

usage: number

Value of the usage

usagePerDay

usagePerDay: {
    [key: string]: number;
}

Usage per day

Methods

toPlainObject

Settings

Member Visibility

On This Page

Properties
Methods