Get amendment options for an order

Returns which amendments the order admits right now: per-attribute intents and treatment axes with choosable options, defaults, and unavailability reasons, plus the order version, currency, and effective date an amendment request needs.

get/orders/{orderId}/amendments/options

Request

Base URL: https://api.agentpaid.io/api/v2
URL: https://api.agentpaid.io/api/v2/orders/{orderId}/amendments/options
Auth: HTTP bearer

Path parameters

orderIdstring required

Display id of the order (for example ord_5rLZXDFSHNw). Line and attribute ids in amendment bodies are UUIDs from the options response.

Response

200

orderIdstring required

Display id of the order.

orderVersionnumber double required

Pass this unchanged into preview and execute.

currencystring required

Order currency (ISO 4217).

effectiveDatestring required

When an amendment submitted now takes effect.

amendableboolean required

False when the order cannot be amended right now.

notAmendableCodestring

Machine-readable reason when amendable is false.

notAmendableReasonstring

Human-readable reason when amendable is false.

stubPeriodExistsboolean

True when an attribute added now would have a partial period before the next order anchor. When false, every chargeStub choice degenerates to the plain full-cycle add.

currentPeriodEndstring

Last day of the current billing period. Natural cancel-renewal target.

Changes

No recorded changes to this operation across all 1 revision of this API.