orders

Cancel order renewal

Schedules the cancellation of an order's renewal from a specified date. The order will remain active until the cancellation date.

post/orders/{orderId}/cancel

Request

  • Base URL: https://api.agentpaid.io/api/v1
  • URL: https://api.agentpaid.io/api/v1/orders/{orderId}/cancel
  • 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)

cancelFromDatestring date-time required

The date from which the renewal should be cancelled (ISO 8601 format)

Response

Order renewal cancelled 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

endDatestring date-time required

The new end date of the order

effectiveDatestring date-time required

The effective date of the cancellation

Changes

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