Create orders, then pause, resume, complete or cancel them.
An order links a customer to the products they buy, and sets how they pay.
Create every order with Create order. Its order_type sets how the customer pays: single_payment, instalment, subscription or metered. Each type needs different parameters. Create order lists them.
How an order moves
- Create the order. Its status is
draft, and nothing is collected yet. - Collect the first payment. See 4 · Collect payment.
- A scheduled order becomes
active. BillPro collects each payment on its date. - When nothing more is due, the order is
complete.
You can pause, resume, complete or cancel an order. The order's available_actions shows which you can do now.
Order statuses
| Status | Meaning |
|---|---|
draft | Created, nothing collected yet. New orders start here. |
pending | Waiting for the first payment. |
registered | The card is saved and the first payment is waiting. |
active | Collecting payments on its schedule. |
paused | Paused by the merchant. Payments restart when it's resumed. |
failed | A payment was declined but can be retried. |
suspended | Stopped after a failed payment, on an order that had already collected a payment. |
rejected | Declined because of a card problem. Retrying won't help. |
review | Needs a manual check, for example after an overpayment. |
complete | Nothing more is due. |
cancelled | Cancelled. Nothing more is collected. |