Interface UsageOptions

interface UsageOptions {
    limit: number;
    percentage: number;
    throttled: boolean;
    usage: number;
}

Properties

limit: number

The number of monthly API calls your plan entitles you to.

percentage: number

The percentage of the limit used since the beginning of the month.

throttled: boolean

Value indicating whether the requests are being throttled for having consistently gone over the limit.

usage: number

The number of calls (spam + ham) since the beginning of the month.