Skip to main content
Version: 2.x

Class: PricingEngine

Defined in: javascript/src/engine.ts:31

Constructors​

Constructor​

new PricingEngine(config): PricingEngine

Defined in: javascript/src/engine.ts:32

Parameters​

config​

ParsedBursarConfig

Returns​

PricingEngine

Accessors​

pricingSchema​

Get Signature​

get pricingSchema(): Record<string, unknown>

Defined in: javascript/src/engine.ts:38

Returns​

Record<string, unknown>

Methods​

calculate()​

calculate(metrics, options?): CostBreakdown

Defined in: javascript/src/engine.ts:42

Parameters​

metrics​

UsageMetrics

options?​

Record<string, string> | { rateCard?: string; } | null

Returns​

CostBreakdown

calculateBatch()​

calculateBatch(metrics, options?): CostBreakdown[]

Defined in: javascript/src/engine.ts:126

Parameters​

metrics​

UsageMetrics[]

options?​
rateCard?​

string

Returns​

CostBreakdown[]

getRateCardForPlan()​

getRateCardForPlan(planId): string | undefined

Defined in: javascript/src/engine.ts:130

Parameters​

planId​

string | null | undefined

Returns​

string | undefined

fromDict()​

static fromDict(data): PricingEngine

Defined in: javascript/src/engine.ts:34

Parameters​

data​

Record<string, unknown> | BursarConfig

Returns​

PricingEngine