AmendmentPlan

What an amendment does, compiled from its intents.

creditEffects
Type:
required
Properties: 5
effectiveDate
Type: stringFormat: date
required

The day the amendment is made (today, UTC). Added charges start then; ended and replaced charges change on their own effectiveFrom in operations.
moneyEffects
Type:
required
Properties: 11
operations
Type:
required
Properties: 5
orderId
Type: string
required
orderVersion
Type: integer
required

The order version the plan was made for.
planHash
Type: string
required

A hash of the plan and the order version it applies to. Send it when you execute.
planVersion
const:
1
required

The plan format's version.
stateDiff
Type:
required

Each change's before and after. Not part of planHash.

Properties: 7
treatmentsResolved
Type: array of object
required

The treatment each intent got, and where it came from.

Properties: 5
usageEffects
Type:
required
Properties: 3