Interface CreditHoldFilter

Which holds CreditTransaction.listHolds returns.

interface CreditHoldFilter {
    scopeId?: string;
    states?: readonly CreditHoldState[];
    dueAtOrBefore?: number;
    limit?: number;
}

Index

Properties

scopeId? states? dueAtOrBefore? limit?

Properties

`Optional` scopeId

scopeId?: string

`Optional` states

states?: readonly CreditHoldState[]

`Optional` dueAtOrBefore

dueAtOrBefore?: number

Holds due at or before this time: a held one by its expiresAt, a deferred one by its deferredUntil.

`Optional` limit

limit?: number

At most this many; default 1,000.