OrderLineCreditBenefit

Credits a charge includes each billing period, or once for a one-time charge.

  • Credits per billing period of the charge, per seat when recipient is seat; allocationCadence says how they are handed out. For a one-time charge, granted once per unit when the order is activated (or once its invoice is posted or paid, per creditGrantTiming).

  • How often the credits are handed out, on the order's billing cycles: each month, quarter, half-year or year, each billing period of the charge (billingPeriod), or once (oneTime, the whole amount, lasting until used). Each periodic allocation is the period's amount scaled to its length (monthly on an annual charge hands out a twelfth each month) and expires at the end of its allocation period, apart from what rolls over.

    values
    monthlyquarterlysemiAnnuallyannualbillingPeriodoneTime
  • When each allocation can be spent. Null: from the start of its period. on_invoice_posted: once the first invoice billing the charge for that period (for a one-time charge, its fee) is posted; straight away if it already is. on_payment: once that invoice is paid. A later invoice adjusting the period, such as a proration, neither releases them nor, voided, forfeits them. Credits used before then are held, even past the allocation's end, and become overage if that invoice is voided (in Stripe too, when Stripe collects it); an invoice Stripe marks uncollectible can still be paid, so they stay held. A free charge's credits don't wait, and a period that turns out to have nothing to bill releases them when the billing run reaches it.

  • The credits currency (cc_…) the credits are in; null for your default credits currency.

  • The benefit's ID. Generated when left out.

  • Unlimited credits.

  • Price per credit used past the included credits. 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
  • organization: the amount is for the whole customer. seat: per seat.

  • Unused credits that carry over when an allocation expires, at most this many; null with a rolloverDuration carries over all of them. Rolled-over credits don't roll over again.

  • How long rolled-over credits last, in rolloverDurationUnits. Default, one allocation period.

  • The unit of rolloverDuration.

    values
    daysweeksmonthsyearsnull