orders

Schedule a plan change with proration

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.

post/orders/{orderId}/schedule-plan-change

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/orders/{orderId}/schedule-plan-change
  • Auth: HTTP bearer

Path parameters

orderIdstring required

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

Request body

orderVersioninteger required

The current version of the order (for optimistic locking)

effectiveDatestring date-time required

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

Response

Plan change scheduled successfully

orderIdstring uuid required

The ID of the order

amendmentIdstring uuid required

The ID of the amendment record

versioninteger required

The new version of the order after the amendment

effectiveDatestring date-time required

The effective date of the plan change

endedLineIdsstring[] required

IDs of order lines that were ended

createdLineIdsstring[] required

IDs of new order lines that were created

creditLineIdsstring[] required

IDs of credit lines that were created

Changes

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