Get amendment options for an order

GET

https://api.agentpaid.io/api/v2/orders/:orderId/amendments/options

GET

/api/v2/orders/:orderId/amendments/options

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.amendments.getOrderAmendmentOptions({
        orderId: "orderId",
    });
}
main();

{
  "orderId": "string",
  "orderVersion": 1.1,
  "currency": "string",
  "effectiveDate": "string",
  "amendable": true,
  "lines": [
    {
      "orderLineId": "string",
      "attributes": [
        {
          "orderLineAttributeId": "string",
          "state": {
            "quantity": 1.1,
            "unitPriceMinor": 1.1,
            "totalAmountMinor": 1.1,
            "creditCost": 1.1,
            "creditBenefitAmount": 1.1,
            "hasInfiniteCreditBenefits": true,
            "currency": "string",
            "chargeType": "usage",
            "meteredUsage": true,
            "productId": "string"
          },
          "meteredUsage": true,
          "intents": [
            {
              "kind": "updateQuantity",
              "axes": [
                {
                  "axis": "money",
                  "options": [
                    {
                      "value": "none",
                      "isDefault": true,
                      "available": true,
                      "unavailableReason": "string"
                    }
                  ],
                  "relevance": "always"
                }
              ]
            }
          ],
          "lockedReason": "string"
        }
      ],
      "intents": [
        {
          "kind": "updateQuantity",
          "axes": [
            {
              "axis": "money",
              "options": [
                {
                  "value": "none",
                  "isDefault": true,
                  "available": true,
                  "unavailableReason": "string"
                }
              ],
              "relevance": "always"
            }
          ]
        }
      ],
      "lockedReason": "string"
    }
  ],
  "addAttribute": {
    "axes": [
      {
        "axis": "chargeStub",
        "appliesTo": [
          {
            "chargeTypes": [
              "usage"
            ],
            "billingTypes": [
              "Advance"
            ],
            "pricingModels": [
              "PerUnit"
            ]
          }
        ],
        "options": [
          {
            "value": "none",
            "isDefault": true,
            "unsupportedReason": "string",
            "requires": [
              {
                "chargeTypes": [
                  "usage"
                ],
                "billingTypes": [
                  "Advance"
                ],
                "pricingModels": [
                  "PerUnit"
                ]
              }
            ]
          }
        ],
        "relevance": "always"
      }
    ]
  },
  "notAmendableCode": "string",
  "notAmendableReason": "string",
  "stubPeriodExists": true,
  "orderTerm": {
    "kind": "updateQuantity",
    "axes": [
      {
        "axis": "money",
        "options": [
          {
            "value": "none",
            "isDefault": true,
            "available": true,
            "unavailableReason": "string"
          }
        ],
        "relevance": "always"
      }
    ]
  },
  "currentPeriodEnd": "string"
}

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.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

orderIdstringRequired

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

Display id of the order.

orderVersiondouble

Pass this unchanged into preview and execute.

currencystring

Order currency (ISO 4217).

effectiveDatestring

When an amendment submitted now takes effect.

amendableboolean

False when the order cannot be amended right now.

lineslist of objects

addAttributeobject

Axes for adding an attribute mid-cycle.

notAmendableCodestringOptional

Machine-readable reason when amendable is false.

notAmendableReasonstringOptional

Human-readable reason when amendable is false.

stubPeriodExistsbooleanOptional

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.

orderTermobjectOptional

currentPeriodEndstringOptional

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

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error