Interface CreditLotRow

A funding lot: principal granted once, and how much of it is consumed, held, refunded and retired.

interface CreditLotRow {
    lotId: string;
    scopeId: string;
    kind: CreditLotKind;
    fundingRef: string;
    principalMicro: number;
    consumedMicro: number;
    heldMicro: number;
    refundedMicro: number;
    retiredMicro: number;
    state: CreditLotState;
    expiresAt: null | number;
    createdAt: number;
    version: number;
}

Properties

lotId scopeId kind fundingRef principalMicro consumedMicro heldMicro refundedMicro retiredMicro state expiresAt createdAt version

Properties

lotId

lotId: string

scopeId

scopeId: string

kind

kind: CreditLotKind

fundingRef

fundingRef: string

The payment or promotion reference the lot was granted for; unique in the scope.

principalMicro

principalMicro: number

consumedMicro

consumedMicro: number

heldMicro

heldMicro: number

refundedMicro

refundedMicro: number

Refunded or reserved for a refund in flight.

retiredMicro

retiredMicro: number

Retired: an expired promotion's unheld remainder, or what a lost dispute took from the free balance.

state

state: CreditLotState

expiresAt

expiresAt: null | number

When a promotion expires; null for a lot that does not.

createdAt

createdAt: number

version

version: number

Settings

Member Visibility

Theme

On This Page

lotIdscopeIdkindfundingRefprincipalMicroconsumedMicroheldMicrorefundedMicroretiredMicrostateexpiresAtcreatedAtversion