AmendmentMoneyEffect

A charge or credit the amendment adds to the order's next invoice, worked out as the billing run bills it: proration is the change in the charge's amount for one of its billing periods (at its own billing frequency, or the order's billingFrequencyOverride) times remainingDays over totalDaysInCycle, rounded to the nearest minor unit. For example, $100 more a month with 22 of November's 30 days left is an amountMinor of 7333 ($73.33), and $1,200 more a year with 100 of the year's 365 days left is 32877 ($328.77). A firstPeriodCharge is the added charge's amount for one of its periods prorated the same way for chargeStub: prorated, or that whole amount for chargeStub: full.

amountMinor
Type: integer
min:
0
required

The amount, always positive (kind says which way). Integer minor units (cents for USD).
billing
enum
const:
inline
required

inline: billed as a line on the order's next invoice.
currency
Type: string
required
cycleEnd
Type: stringFormat: date
required

The first day of the charge's next billing period.
cycleStart
Type: stringFormat: date
required

The first day of the charge's current billing period (for an added charge, the period it starts in).
intentIndex
Type: integer
required

Integer numbers.
kind
Type: "prorationCharge" or "prorationCredit" or "firstPeriodCharge"enum
required

prorationCharge: a recurring or seat-based charge went up mid-period. prorationCredit: it went down or ended. firstPeriodCharge: an added charge's chargeStub for the current period.
remainingDays
Type: integer
required

Days from the effective date to cycleEnd.
totalDaysInCycle
Type: integer
required

Days in the charge's billing period. For the order's first period when it starts off its billing anchor (a short first period), the days in the full period that ends where it does.
orderLineAttributeId
Type: string

The charge, for proration.
orderLineId
Type: string

The charge's line, for proration.

AmendmentOperations

AmendmentCreditEffect