VocalDocscontracts 1.65.0

WhatIf

The estimated charge of a Provider swap over measured quantities, with its evidence and sample sizes (1.57.0). An estimate from list prices, not a quote.

An object with 17 fields.

Fields

FieldTypeRequiredDescription
agent_idAgentIdyes
agent_versioninteger or nullyes
callsintegeryesThe Calls whose quantities were measured.
currency"USD"yes
currentWhatIfSideyes
delta_microsinteger or nullyesThe substitute amount minus the current amount; null when either is null.
eligiblebooleanyes
estimatetrueyes
fromstringyes
ineligible_reasonsarray of WhatIfIneligibleReasonyes
latencyWhatIfLatencyEvidenceyes
minutesnumberyesTheir billable Call minutes.
object"what_if"yes
price_list_versionstringyesThe version of the price list the estimate used; a date in 1.5.0.
stageWhatIfStageyes
substituteWhatIfSideyes
tostringyes

Used by

The operations whose parameters, request body or responses name this shape directly.