Cancel an order

Cancels the order. Its status becomes cancelled, and no more payments are collected.

  • You can cancel an order in any status except complete and cancelled.
  • If the order is already complete or cancelled, you get 200 with the order unchanged. It's safe to retry a cancel.
  • Upcoming scheduled payments are cancelled too. Nothing is charged or refunded. Payments already taken stay as they are.
  • You can't undo a cancellation.

Send no request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

string
required

ID of the order.

Responses

Language
Credentials
Bearer
API token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json