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.

  • How often the charge is billed. custom bills every billingFrequencyCustomMonths months.

    values
    monthlyquarterlysemiAnnuallyannualcustom
  • Months in a billing period when billingFrequency is custom.

  • advance bills at the start of the period, arrears at its end. Default, arrears for usage, else advance.

  • 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.

    values
    recurringusageoneTimeseatBased
  • 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.

  • Credits the charge includes.

    Properties: 13
  • For bracketedPrepaidCredits, the credits an event uses by its quantity (the number at pricingInput.path, else the signal's data.quantity, else 1). The first bracket, by upperBound, that the quantity fits sets the credits; past the last bound, the last bracket does. brackets is accepted as another name for it.

    Properties: 3
  • Credits each event (or each unit of pricingInput.path) uses, for prepaid-credits pricing.

  • The credits currency (cc_…) the charge's credits are in. Default, its credit benefits' currency, else your default credits currency.

  • 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: percent off, or a fixed amountMinor off each billing period (once for a one-time charge), the same for a part period as for a full one. Set it with discountPercent or discountAmount on the charge.

    Properties: 2
  • The signal event name a usage charge prices, for example document_uploaded.

  • 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.

  • Overage price per credit by currency code, in minor units; wins over overageUnitPrice for that currency.

    Properties: 1
  • For percentOfTotal, the percentage of the invoice's other charges, for example 10 for 10%.

  • The charge's price in one currency.

    Properties: 7
  • For prepaid credits, which number in the signal's data counts as the quantity.

    Properties: 1
  • 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. prepaidCredits and bracketedPrepaidCredits: each event uses credits. costPlus: your customer's AI cost times a multiplier. Provisioning also takes flat, as perUnit.

    values
    perUnitgraduatedPricingvolumePricingpercentOfTotalprepaidCreditsbracketedPrepaidCreditscostPlus