Upgrade customer to a new plan | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.plans.upgrade({
        customerExternalId: "customerExternalId",
        oldPlanId: "oldPlanId",
        newPlanId: "newPlanId",
    });
}
main();

{
  "orderId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "amendmentId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
  "version": 3,
  "effectiveDate": "2024-06-01T12:00:00Z",
  "endedLineIds": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479"
  ],
  "createdLineIds": [
    "c9bf9e57-1685-4c89-bafb-ff5af830be8a"
  ],
  "creditLineIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "prorationDetails": [
    {
      "oldAttributeId": "1c6b147a-3f4a-4d2a-9f3a-1a2b3c4d5e6f",
      "newAttributeId": "2d7c258b-4e5b-5f3b-af4b-2b3c4d5e6f7a",
      "creditLineId": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
      "oldPrice": 29.99,
      "newPrice": 49.99,
      "creditAmount": 15,
      "remainingDays": 10,
      "totalDaysInCycle": 30
    }
  ]
}

Upgrades a customer from one plan to another with automatic proration. Credits are applied for the unused portion of the current billing period, and the order is updated with the new plan's pricing.

Authentication

AuthorizationBearer

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

Query parameters

customerExternalIdstringRequired

The external ID of the customer

oldPlanIdstringRequiredformat: "uuid"

The ID of the current plan

newPlanIdstringRequiredformat: "uuid"

The ID of the plan to upgrade to

Response

Plan upgrade completed 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

Query parameters

Response

Errors