UsagePerUnit

A price per unit of usage. Each signal named eventName counts its quantity (see pricingInput), and the period's total is billed at unitPrice per unit.

Example: 5 (USD 0.05) per page, with pricingInput.path pages. 400 document_uploaded signals of 12 pages each are 4,800 pages: USD 240.00 for the month. With includedQuantity 1000 the first 1,000 pages are free, so it's USD 190.00.

pricingType
const:
UsagePerUnit
required

The pricing type. It decides the charge's other fields and how it bills.
billingFrequency
Type: enum

How often the charge is billed: every 1, 3, 6 or 12 months, or with Custom every billingFrequencyCustomMonths months. Amounts (the price, credit benefits) are per billing period: a quarterly fee is charged once a quarter.

values
MonthlyQuarterlySemi-AnnuallyAnnualCustom
billingFrequencyCustomMonths
Type: integer
min:
1

With billingFrequency: Custom, the length of the billing period in months.
billingType
Type: enum

When each period is billed. Advance: at the start of the period, for the period ahead. Arrears: at the end, for the period just ended. Usage charges, and the overage of seats that come with credits, are always billed in arrears. Default: Arrears for usage charges, Advance for the rest.

values
AdvanceArrears
chargeType
const:
usage
read-only

Set by Spondo Billing from pricingType: the kind of charge. Returned, never sent.
eventName
Type: string

The signal event name this charge counts. Every signal sent with this eventName adds to the charge. Required unless the charge names a meterId.
meterId
Type: string

A meter of the charge's product (mtr_…) to bill in place of eventName: each signal counts its quantity on the meter. Send eventName or meterId, not both. A charge on a meter takes no pricingInput: the meter says what each signal counts.
pricePoints
Type:

One price point per currency. An order uses the one in its currency, else the first. unitPrice is the price per unit.

Properties: 5
pricingInput
Type:

Where a charge that counts signals reads each signal's quantity. Without it, a signal counts the number in data.quantity, else 1. There is no formula language: the quantity is one number read from the signal. It is read once, when the signal arrives, with the pricingInput of a charge on the customer's active orders that prices its event.

Properties: 1
pricingModel
const:
perUnit
read-only

Set by Spondo Billing from pricingType: how the charge is priced. Returned, never sent.
signalType
Type: enum

What a usage charge bills for: activity (work done) or outcome (a result delivered, such as a resolved ticket). Both bill the same way; it labels the charge.

values
activityoutcome

Examples

{
  "pricingType": "UsagePerUnit",
  "eventName": "document_uploaded",
  "pricingInput": {
    "path": "pages"
  },
  "billingFrequency": "Monthly",
  "billingType": "Arrears",
  "pricePoints": [
    {
      "currency": "USD",
      "unitPrice": 5,
      "includedQuantity": 1000
    }
  ]
}

RecurringPercentOfTotal

UsageGraduated