Order status

A formal description of order statuses in BillPro

BillPro has two main types of order statuses depending on if an initial payment or card registration has been approved yet, or not.


Preliminary order statuses

The preliminary order statuses apply to all purchase types, and they are for orders that have not had an approved initial payment or card registration.

IconStatusDescription
DraftA draft order is a new order where a) no payment has been submitted by the virtual terminal and b) no payment has been requested by payment link. A draft order can be a) saved as a draft, b) advanced to another status by submitting a payment through the terminal, or c) moved to pending status by requesting a payment by email or SMS link.
RejectedA rejected order is an order, a) with a previous status of draft; where b) the initial payment submitted through the terminal was declined. Rejected orders have the same characteristics as a draft order because you can try to submit a payment again through the terminal, or request a payment via payment link. If you request a payment via payment link, the rejected order becomes a pending order.
PendingA pending order is a new order where a) a payment or card registration was requested from the customer by payment link; and b) no payment or card registration has been successfully authorised (eg. a payment has not been submitted or was declined).
CancelledCancelled is a status that you can use to terminate draft, pending, or rejected orders. These are preliminary orders statuses, where an initial payment has not been successfully authorised, so the order has not been activated or completed. If you cannot or do not want to activate or complete the order, you can cancel it.


Live order statuses

The live order statuses apply to purchase types with recurring payments after the first payment or card registration is authorised, except for the Complete status, which applies to single payment and recurring payment order types.

IconStatusDescription
PausedPause is a manual function that is available to subscription orders only. Pausing an order stops the collection of payments until the order is resumed (unpaused) and you can change the billing cycle to restart from the resume date.
ActiveAn order is active when a) the most recent payment was successfully authorised; and b) the schedule of payments is not complete, or in the case of subscription or metered orders, the order has not been marked complete.
FailedAn order has a failed status when the most recent payment was declined with a soft decline reason code. Soft declines are caused by a temporary condition affecting the card (such as insufficient funds), so these payments may be retried up to 15 times in 30 days. When an order has a Failed status, BillPro continues to try to collect billing events
ReviewReview is a status for instalment orders only. Review status is applied if the collected amount exceeds the order amount (i.e. the total value of the order). When an order has a Review status, BillPro continues to try to collect billing events
SuspendedAn order is suspended when the most recent payment was declined with a hard decline reason code. Hard declines are caused by a permanent condition affecting the card (such as the account being closed), so these payments may not be retried, and the card must be replaced before the order can be restored to active status. When an order has a Suspended status, BillPro does not continue to try to collect billing events
CompleteComplete is the terminus for all active status orders and single payment orders. An order is complete when a) the total order amount was successfully collected over one or more payments; or b) an order with a live status (active, failed, suspended, paused, review) was manually marked complete.

For a full diagram of all order statuses, see Order flow.


Recommended reading

Process orders depending on the order status