Orders

Expire Order

Changed on

Expires the order.

The expiration timestamp is set to the current time, which makes the order impossible to pay.

Only orders with status created or reattempted can be expired. Attempting to expire an order in any other status will result in an error.

patch/v1/orders/{order_id}/expire

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/orders/{order_id}/expire
  • Auth
    HTTP bearer

Path parameters

order_idstring required

Response

Successful Response

unknown required

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the path request parameter order_id, the maxLength was set to 32