OrderLinePricing
A charge's pricing on an order line: what it charges for (chargeType), how (pricingModel) and one price point in the order's currency. Money is in minor units.
- billingType: stringenum
Frequency How often the charge is billed.
custombills everybillingFrequencyCustomMonthsmonths.valuesmonthlyquarterlysemiAnnuallyannualcustom - billingType: integer
Frequency Custom Months min:1Months in a billing period when
billingFrequencyiscustom. - billingType: "advance" or "arrears"enum
Type advancebills at the start of the period,arrearsat its end. Default,arrearsfor usage, elseadvance. - chargeType: stringenum
Type recurring: a fee each billing period.usage: priced from your customer's signals.oneTime: charged once, on the first invoice.seatBased: a fee per seat each billing period, with seats you assign.valuesrecurringusageoneTimeseatBased - costType: number
Plus Multiplier For
costPlus, what your customer's AI cost is multiplied by, for example 1.3. The cost, in US dollars, is converted to the order's currency at your exchange rate, and each period keeps the rate it was first billed at, so changing a rate changes only what's billed from then on. - creditType:
Benefits Properties: 13Credits the charge includes.
- creditType: array of object
Brackets Properties: 3For
bracketedPrepaidCredits, the credits an event uses by its quantity (the number atpricingInput.path, else the signal'sdata.quantity, else 1). The first bracket, byupperBound, that the quantity fits sets the credits; past the last bound, the last bracket does.bracketsis accepted as another name for it. - creditType: number
Cost Credits each event (or each unit of
pricingInput.path) uses, for prepaid-credits pricing. - creditsType: string
Currency Id The credits currency (
cc_…) the charge's credits are in. Default, its credit benefits' currency, else your default credits currency. - discountType: objectProperties: 2
A discount on the charge, billed as a negative line of its own under each of the charge's amounts, never taking one below zero:
percentoff, or a fixedamountMinoroff each billing period (once for a one-time charge), the same for a part period as for a full one. Set it withdiscountPercentordiscountAmounton the charge. - eventType: string
Name The signal event name a usage charge prices, for example
document_uploaded. - overageType: number
Unit Price For prepaid credits, the price per credit past the included credits. Default, the overage price of one of its credit benefits in its credits currency, else of a credit benefit in that currency on another of the order's charges running in the period billed, the latest started first (a platform fee that carries the credits, say), so an overage price changed by an amendment applies from when its charge starts. In minor units (cents for USD); fractions allowed.
- overageType: object
Unit Prices Properties: 1Overage price per credit by currency code, in minor units; wins over
overageUnitPricefor that currency. - percentageType: number
Value For
percentOfTotal, the percentage of the invoice's other charges, for example 10 for 10%. - priceType:
Points Properties: 7The charge's price in one currency.
- pricingType: object
Input Properties: 1For prepaid credits, which number in the signal's
datacounts as the quantity. - pricingType: stringenum
Model perUnit: unit price times quantity (or events).graduatedPricing: each tier's units at that tier's price.volumePricing: every unit at the price of the tier the quantity reaches.percentOfTotal: a percentage of the invoice's other charges.prepaidCreditsandbracketedPrepaidCredits: each event uses credits.costPlus: your customer's AI cost times a multiplier. Provisioning also takesflat, asperUnit.valuesperUnitgraduatedPricingvolumePricingpercentOfTotalprepaidCreditsbracketedPrepaidCreditscostPlus - propertyadditionalPropertyType: anything
Name