Create orders with products for customers and display orders
You can create orders for all purchase types with the order endpoints in BillPro. This section describes the steps that you must do prior to creating orders, some integration information, and a maintenance step.
Before you create orders
- Create a product in the UI with the
product_type
to match the orderpurchase_type
. Reference: Create your product catalogue. - Create a customer in the API or UI, or using CSV import. See Create your customers and Import customers from a CSV file.
- For metered or instalment orders, define order amounts for card registration when the initial payment is
0
. See Card registration amount in Get set up in BillPro.
Accepting payments
- BillPro always creates a payment link for an order and sets thepending status. You can send the payment link to the customer by email, or you can integrate with BillPro's payment link to redirect the customer to BillPro's secure checkout. See Integrate with payment links. The BillPro payment link automatically renews the BillPro checkout when the user clicks on the payment link.
- When you create the order, you can also set the attribute to create a checkout in the payment gateway to use in an iframe integration. See Custom checkout with payment iframe. With a custom checkout, if the user doesn't complete their transaction within 25 minutes, the checkout expires, and you should renew it with the API request. See Renew Checkout.
Notifications
- By default, when you create an order with the API, BillPro does not automatically send the initial order is ready notification with the payment link to the customer. But BillPro sends payment reminders for all
Pending
orders. You can adapt or deactivate the configuration of these notifications. See Payment reminders in Get set up in BillPro and Configure email notifications.
Manage scheduled payments
- For orders with recurring payments, you can manage billing events for scheduled payments in the UI and with the API. See Manage billing events and Update scheduled payment
Manage subscriptions
- For subscriptions, when you manage scheduled payments, you can also change the payment intervals with the API. See Manage billing events and Update scheduled payment
- You can pause and restart subscription orders with the API. See Pause order and Resume order.
Cancel orders
- In the API, you can cancel orders by the order ID. There is only one endpoint to cancel orders, from which the API will cancel orders that have a preliminary status (
draft
,pending
, andrejected
), and mark as complete the orders that have a live status (active
,failed
,suspended
,paused
, andreview
). See Cancel order - Or in the UI, you can open each Order Summary and from the toggle switch actions menu, select Cancel Order. See Track pending orders.
Cancel old pending orders
- We recommend that you create a regular process to remove old orders with a
Pending
status. - To do this, you can filter the orders by the
pending
order status in the Orders report and download it in CSV format.