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. For a live order that isn't a subscription, complete it instead.
  • 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.
  • On a paused order, the scheduled payments are cancelled too.
  • You can't undo a cancellation.

Send no request body.

Cancel or complete? Cancel an order that never took a payment (draft, pending or rejected), or a subscription you want to end. Complete any other live order. Both stop all future payments.

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