You can update scheduled payments that have a status of scheduled, soft-declined, and hard-declined.
You cannot update scheduled payments that have a status of complete, review, merged, or recovered.
For subscriptions, you can change the interval of the scheduled payments, by setting the scheduled_interval to a numerical value, and setting the scheduled_duration_unit to DAY, WEEK, MONTH, or YEAR.
For subscriptions, if you change the amount of the scheduled payment, then BillPro will update the order so that future billing events will be for the new amount.
Change the status of a scheduled payment
For the status of a scheduled payment, you can set values cancelled, skipped, and scheduled.
- To pause a subscription in the API, see Pause order. In this case, you will need to manually resume it with the API or in the UI. See Resume order.
- To pause the order and programme it to resume at a future date, use the BillPro UI.
- It is also possible to pause a subscription by rescheduling the next billing event to a future date and time, but this is not recommended.
- To try to collect a declined billing event, you can reschedule it to a future date and time. To do this, set the
statustoscheduledand change the date and time. - To cancel a billing event, if it is
scheduled, or if it was declined, set thestatustoskippedorcancelled. BillPro will not collect this payment. - To cancel an order, see Cancel order or mark it as
Completein the BillPro UI. BillPro assigns the status ofcancelledto uncollected billing events.
If the status of the order is paused and the scheduled payment is paused, you should not update it with the API, but even if you set it to scheduled, BillPro will not collect the payment until the order is resumed.