Order status
A formal description of order statuses in BillPro
BillPro order statuses fall into two groups, depending on whether the order's first payment or card registration has been approved yet.
For the complete documentation index, see llms.txt
Preliminary order statuses
Preliminary statuses apply to every purchase type, until an initial payment or card registration is approved.
| Icon | Status | Description |
|---|---|---|
| Draft | A new order with no payment taken by phone and no payment link sent. You can take a phone payment, send a payment link, or cancel it. | |
| Rejected | A phone payment for a draft or pending order was declined. You can take another phone payment, send a payment link, or cancel it. | |
| Pending | You sent a payment link, and no payment or card registration has been approved yet. If a phone payment is then declined, the order becomes Rejected. | |
| Cancelled | You cancelled a draft, pending or rejected order. Nothing was collected. |
Live order statuses
Live statuses apply once an initial payment or card registration is approved. Most are for recurring orders. Complete applies to every purchase type, and Active also covers single payment orders with a pre-authorised amount.
| Icon | Status | Description |
|---|---|---|
| Paused | A subscription you paused. BillPro collects nothing until it resumes, on a date you set or when you resume it. | |
| Active | A recurring order whose most recent payment was approved and whose schedule isn't finished. Or a single payment order with a pre-authorised amount you haven't captured or reversed yet. | |
| Failed | The most recent payment was soft-declined, a temporary problem such as insufficient funds. Card schemes allow up to 15 retries in 30 days, and BillPro can retry automatically. See Auto-retry billing events. | |
| Review | An instalment order where BillPro collected more than the order value. BillPro still tries to collect the remaining billing events. | |
| Suspended | The most recent payment was hard-declined, a permanent problem such as a closed account. It can't be retried. Update the card to make the order Active again. | |
| Complete | The final status. The full order amount was collected, a pre-authorised amount was captured or reversed, or you marked a live order Complete. |
For developers: the API returns these statuses in lower case, such as draft and active. See Orders in the API reference.
Updated 12 days ago
Did this page help you?