post https://test.billing.gg/api/v1/orders/create_instalment_order
Before you create an instalment order
- Create a product in the UI with the
product_type
ofinstalment
. See Create your product catalogue and Create an instalment product. - Create a customer. See Create customer for the API, Create your customers for the UI, and Import customers from a CSV file.
Products in instalment orders
- You cannot switch between single purchase and instalment orders with these product types, as in the UI.
- In instalment orders, you can only add one product.
- If the pricing configuration of a product is not locked, you can change the pricing when you create an order. For discounts, fees, and taxes, you can specify an amount in each order, with no percentage discount.
- You can change the initial amount to
0
but to ensure the total amount of the order is correct, it is better to create a separate product with no deposit. To register cards with a deposit of0
, use the pre-authorisation amount for your merchant. You can get this from BillPro customer service. - If product payment configuration is not locked, you can change the payment configuration, e.g.
scheduled_unit
andscheduled_interval
.
Order status
- BillPro creates a payment link and sets the pending status for the order, but it does not automatically send an order is ready email with the payment link to the customer.
Taking payments
- You can send the payment link to the customer by email
- You can integrate with BillPro's payment link to redirect the customer to BillPro's secure checkout. See Integrate with payment links.
- When you create the order, you can create a checkout in the payment gateway to use in an iframe integration. See Integrate with custom checkout and payment iframe. If the user doesn't complete their transaction within 25 minutes, the checkout expires, so renew it with the Renew Checkout request.
Notifications
- BillPro sends payment reminders for
Pending
orders. To change this configuration, see Payment reminders in Get set up in BillPro and Configure email notifications.
Manage scheduled payments
- For instalments, you can use the API to manage scheduled payments, to skip or reschedule them. See Scheduled Payments and for the UI, see Manage billing events.
Delete old pending orders
- Create a process to regularly remove old orders with a
Pending
status in the UI. See Track pending orders.