Update order

Changes an order's lines, schedule and details. You can edit an order while it's waiting for payment: when its status is draft, pending or rejected.

Send the whole order every time. The same fields are required as in Create order, including currency and customer_id, or you get 422.

Most fields you leave out are cleared, not kept: description, tag_list and the order lines are replaced by what you send. Only merchant_invoice_id is kept when left out.

A draft order is rebuilt from your body, as in Create order:

  • You can change order_type, currency and customer_id.
  • BillPro works out the amounts again. Preview figures you send are ignored.

An order in any other status keeps the amounts you send:

  1. Calculate a preview with the order as it should be.
  2. Send the same body here, with the preview's figures added. Each parameter says which preview figure to send. The amounts you send are saved as they are, not worked out again.

On these orders, a different order_type returns 422. currency and customer_id are ignored.

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.

Body Params
order
object
required

The order as it should be. Fields are as in Create order, unless noted.

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