Schedule a plan change with proration | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orders.schedulePlanChange("orderId", {
        orderVersion: 1,
        effectiveDate: new Date("2025-02-01T00:00:00.000Z"),
        updatedOrderLineAttributes: [
            {
                orderLineAttributeId: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
                newPricing: {
                    "unitPrice": 200,
                    "currency": "USD",
                },
                newQuantity: 10,
            },
        ],
    });
}
main();

{
  "orderId": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
  "amendmentId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "version": 2,
  "effectiveDate": "2025-02-01T00:00:00.000Z",
  "endedLineIds": [
    "old-line-id-1"
  ],
  "createdLineIds": [
    "new-line-id-1"
  ],
  "creditLineIds": [
    "credit-line-id-1"
  ],
  "prorationDetails": [
    {
      "oldAttributeId": "old-attr-id",
      "newAttributeId": "new-attr-id",
      "creditLineId": "credit-line-id-1",
      "oldPrice": 100,
      "newPrice": 200,
      "creditAmount": 50,
      "remainingDays": 15,
      "totalDaysInCycle": 30
    }
  ]
}

Schedules a plan upgrade or downgrade for an order with automatic proration calculation. Credits are applied for the unused portion of the current billing period.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

orderIdstringRequired

The order ID (can be internal ID or display ID)

Request

This endpoint expects an object.

orderVersionintegerRequired>=1

The current version of the order (for optimistic locking)

effectiveDatedatetimeRequired

The date when the plan change should take effect (ISO 8601 format)

updatedOrderLineAttributeslist of objectsRequired

The list of order line attributes to update

Response

Plan change scheduled successfully

orderIdstringformat: "uuid"

The ID of the order

amendmentIdstringformat: "uuid"

The ID of the amendment record

versioninteger

The new version of the order after the amendment

effectiveDatedatetime

The effective date of the plan change

endedLineIdslist of strings

IDs of order lines that were ended

createdLineIdslist of strings

IDs of new order lines that were created

creditLineIdslist of strings

IDs of credit lines that were created

prorationDetailslist of objects

Detailed proration calculations for each updated attribute

Authentication

Path parameters

Request

Response

Errors