3 · Create customers & orders

Every order belongs to a customer. Create the customer, then create the order with the products they're buying.

Endpoints: Customers · Orders

---

Steps

1. Create the customer: POST /customers. Send at least first_name, last_name and email.
2. Optional: preview the order: POST /orders/calculate. It returns the same totals and payment schedule as a real order, but saves nothing.
3. Create the order: POST /orders. Send order_type, currency, customer_id, and the products in order_products_attributes.
   • Each line takes the product's price, tax, fee and discount unless you send them.
   • The product's schedule and deposit aren't copied. For an instalment or subscription, send start_date and the schedule, and for a deposit send collect_initial_payment: true with initial_payment_amount.
4. Optional: to save changes to an order without submitting them, use POST /orders/{id}/save_as_draft.

flowchart LR
  Cust["Customer
  POST /customers"] --> Order
  Prev["Preview (optional)
  POST /orders/calculate"] -.-> Order
  Order["Order (draft)
  POST /orders"] --> Pay["4 · Collect payment"]

A new order is a draft. Nothing is charged until you collect payment in the next stage.

---

Order types

Set order_type to match what the customer is buying. See the request examples on Create order for each type.

---

Good to know

• To change an order, send the whole order to PATCH /orders/{id}, as when you created it. Fields you leave out are cleared, not kept.
• To cancel an order, use POST /orders/{id}/cancel. This also cancels its open scheduled payments. Cancelling a complete or already cancelled order changes nothing.

---

Next

Continue to 4 · Collect payment.