UsageGraduated

Usage priced on tiers, graduated: the period's total quantity is split across the tiers, each part at its tier's price.

Example: pages up to 1,000 at 5 (USD 0.05), up to 10,000 at 3, then 1. 4,800 pages cost 1,000 × 0.05 + 3,800 × 0.03 = USD 164.00.

  • The pricing type. It decides the charge's other fields and how it bills.

  • 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
  • With billingFrequency: Custom, the length of the billing period in months.

  • 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
  • Set by Spondo Billing from pricingType: the kind of charge. Returned, never sent.

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

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

  • One price point per currency. An order uses the one in its currency, else the first. Each carries the tiers the period's quantity is priced on.

    Properties: 6
  • 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
  • Set by Spondo Billing from pricingType: how the charge is priced. Returned, never sent.

  • 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": "UsageGraduated",
  "eventName": "document_uploaded",
  "pricingInput": {
    "path": "pages"
  },
  "billingFrequency": "Monthly",
  "billingType": "Arrears",
  "pricePoints": [
    {
      "currency": "USD",
      "unitPrice": 0,
      "tiers": [
        {
          "upperBound": 1000,
          "unitAmount": 5
        },
        {
          "upperBound": 10000,
          "unitAmount": 3
        },
        {
          "upperBound": null,
          "unitAmount": 1
        }
      ]
    }
  ]
}