Complete an order

Marks the order as complete. No more payments are collected.

  • The order needs at least one successful payment.
  • You can't complete a draft, complete or cancelled order. A paused order can be completed.
  • Upcoming scheduled payments are cancelled, including those on a paused order. Nothing more is collected.
  • Nothing is charged or refunded. You can still refund the payments the order took.

You can complete an order when its available_actions.complete is true.

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.

integer
required
≥ 1

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