Type Alias BalanceResult

The answer from GET /key/balance.

type BalanceResult = {
    active: boolean;
    credit_balance_usd: number;
    credit_spent_usd: number;
    expires_at: string;
    kind: string;
}

Index

Properties

active credit_balance_usd credit_spent_usd expires_at kind

Properties

active

active: boolean

True while the key is switched on and not past its expiry.

credit_balance_usd

credit_balance_usd: number

Credit left on the key, in USD.

credit_spent_usd

credit_spent_usd: number

Credit the key has spent, in USD.

expires_at

expires_at: string

When the key stops working, as an ISO 8601 time.

kind

kind: string

The kind of key the server stores: credit, pass or faucet.