Interface CreditHoldRow

A hold: one operation's most, reserved against the lots, and its settlement.

interface CreditHoldRow {
    holdId: string;
    scopeId: string;
    operationId: string;
    kind: string;
    requestHash: string;
    customerMicro: number;
    supplierMicro: number;
    mediaCustomerMicro: number;
    mediaSupplierMicro: number;
    attemptCustomerMicro: number;
    attemptSupplierMicro: number;
    maxAttempts: number;
    attemptLimits: string;
    rateVersion: string;
    rates: string;
    mediaComponent: string;
    state: CreditHoldState;
    chargedMicro: number;
    supplierSettledMicro: number;
    supplierOpenMicro: number;
    createdAt: number;
    expiresAt: number;
    settledAt: null | number;
    deferredUntil: null | number;
    fenceEvidence: null | string;
    version: number;
}

Properties

holdId scopeId operationId kind requestHash customerMicro supplierMicro mediaCustomerMicro mediaSupplierMicro attemptCustomerMicro attemptSupplierMicro maxAttempts attemptLimits rateVersion rates mediaComponent state chargedMicro supplierSettledMicro supplierOpenMicro createdAt expiresAt settledAt deferredUntil fenceEvidence version

Properties

holdId

holdId: string

scopeId

scopeId: string

operationId

operationId: string

The host's id for the operation (a call); unique in the scope.

kind

kind: string

What is held for, such as call or meeting_run.

requestHash

requestHash: string

A digest of the request the hold was made for; the same operation with another digest is a conflict.

customerMicro

customerMicro: number

The customer's most, allocated to lots.

supplierMicro

supplierMicro: number

The supplier's most, counted against the platform's daily cap.

mediaCustomerMicro

mediaCustomerMicro: number

mediaSupplierMicro

mediaSupplierMicro: number

attemptCustomerMicro

attemptCustomerMicro: number

One attempt's most on each side.

attemptSupplierMicro

attemptSupplierMicro: number

maxAttempts

maxAttempts: number

attemptLimits

attemptLimits: string

The attempts' limits, as JSON of AttemptLimits.

rateVersion

rateVersion: string

The primary snapshot's version.

rates

rates: string

JSON of { primary: RateSnapshot; fallbacks: RateSnapshot[] }, immutable for the hold's life.

mediaComponent

mediaComponent: string

The component that prices connected time.

state

state: CreditHoldState

chargedMicro

chargedMicro: number

What the customer was charged at settlement.

supplierSettledMicro

supplierSettledMicro: number

Supplier cost settled so far.

supplierOpenMicro

supplierOpenMicro: number

Supplier liability still open after settlement: attempts whose usage never arrived, at their most.

createdAt

createdAt: number

expiresAt

expiresAt: number

When the hold's time is up and a reconcile asks about it.

settledAt

settledAt: null | number

deferredUntil

deferredUntil: null | number

When a deferred hold is asked about again.

fenceEvidence

fenceEvidence: null | string

The last fence evidence, as JSON.

version

version: number

Settings

Member Visibility

Theme

On This Page

holdIdscopeIdoperationIdkindrequestHashcustomerMicrosupplierMicromediaCustomerMicromediaSupplierMicroattemptCustomerMicroattemptSupplierMicromaxAttemptsattemptLimitsrateVersionratesmediaComponentstatechargedMicrosupplierSettledMicrosupplierOpenMicrocreatedAtexpiresAtsettledAtdeferredUntilfenceEvidenceversion