AmendmentOptions

addAttribute
Type: object
required

The treatments an addFromCatalog or addAttribute intent takes.

Properties: 1
amendable
Type: boolean
required

Whether the order can be amended; only active orders can.
currency
Type: string
required

The order's currency.
currentPeriodEnd
Type: stringFormat: date
required

The last day of the current billing period.
effectiveDate
Type: stringFormat: date
required

Today (UTC): the effectiveDate of an amendment made now. Added charges start then; ended and replaced ones change on their own effectiveFrom.
lines
Type: array of object
required
Properties: 3
orderId
Type: string
required
orderTerm
Type:
required
Properties: 2
orderVersion
Type: integer
required

The order's current version, to send with a preview or amendment.
stubPeriodExists
Type: boolean
required

Whether today falls after the first day of the current billing period, so a change today lands mid-period.
notAmendableCode
enum
const:
ORDER_NOT_ACTIVE

Why the order can't be amended. Present only when amendable is false.
notAmendableReason
Type: string

The same, for people.