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.

  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.

Fields you leave out keep their current value, except tag_list and order_products_attributes, which are replaced. You can't change currency, customer_id or status: they're ignored if you send them.

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