UsagePrepaidCredits

Usage paid for in credits. Each unit of eventName uses creditCost credits, taken from the customer's credits in this charge's credits currency (creditsCurrencyId) as each signal arrives: their plans' credit benefits, grants and top-ups. Credits used beyond what the customer has are overage, billed in arrears at the end of the billing period at the overage price per credit: overageUnitPrices or overageUnitPrice here, else a credit benefit's in the same credits currency, from this charge's own benefits first, then from the order's other charges running in the period, the latest to start first (so a price an amendment changes applies from when its new charge starts).

Example: contract_reviewed at 25 credits. 30 reviews use 750 credits. With 500 credits included and an overage price of 10 (USD 0.10) per credit, the 250 extra credits cost USD 25.00.

creditCost
Type: number
min:
0
required

Credits each unit of usage uses.
pricingType
const:
UsagePrepaidCredits
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.
creditsCurrencyId
Type: string | null

The credits currency (cc_…) this charge spends. Left out or null: the first one this charge's own credit benefits name, else your default credits currency.
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.
overageUnitPrice
Type: number | null
min:
0

Price of each credit used beyond the customer's credits, in minor units (cents for USD) of the order's currency. Fractions are allowed.
overageUnitPrices
Type: object | null

Overage price per credit by currency (ISO 4217 code to minor units). Overrides overageUnitPrice in that currency.

Properties: 1
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:
prepaidCredits
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": "UsagePrepaidCredits",
  "eventName": "contract_reviewed",
  "creditCost": 25,
  "billingFrequency": "Monthly",
  "billingType": "Arrears"
}

UsageVolume

UsageBracketedPrepaidCredits