| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Using the scheduled payments endpoint for an order, you can update scheduled payments as described in the following table.
| Status | Description | Can you update this payment | Settable status |
|---|---|---|---|
scheduled | BillPro collects the payment on the scheduled date. You can reschedule, merge (UI), skip, or cancel this payment | Yes | scheduled, skipped,cancelled |
soft-declined | This payment was declined due to a temporary issue with the card, such as lack of funds. You can retry (UI), reschedule, merge (UI), skip, or cancel this payment | Yes | scheduled, skipped,cancelled |
hard-declined | This payment was declined due to a permanent issue with the card, such as the theft of the card. You can reschedule, merge (UI), skip, or cancel this payment | Yes | scheduled, skipped,cancelled |
complete | BillPro has collected this payment on schedule. | No | |
review | This payment is part of an order that is marked for review because BillPro already collected the full amount of the order and this payment is still scheduled. BillPro will collect this payment if the user does not take action | No | |
merged | The scheduled payment was merged with another scheduled payment by a user. BillPro will collect a new merged scheduled payment | No | |
recovered | BillPro collected the scheduled payment on a retry | No | |
skipped | The scheduled payment was skipped by a user. BillPro did not collect the payment. | No | |
cancelled | The scheduled payment was cancelled by BillPro when the user cancelled the order. BillPro did not collect the payment | No | |
paused | The subscription order is paused and the scheduled payment is also paused. When you resume the order, BillPro will collect the next scheduled payment. | No |
Update the status of a scheduled payment
When you update a scheduled payment, you can change the status to set values cancelled, skipped, or scheduled. The following sections describe these operations.
Reschedule a payment or change the amount
To change the amount or date of a scheduled payment, set these values in the scheduled payment object.
Change a subscription amount
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. Payments of the new amount will be visible in the Scheduled Payments and Related Transactions sections of the order in the UI.
Recover a declined payment
To try to collect a declined scheduled payment, reschedule it to a future date and time. To do this, set the status to scheduled and change the date and time. This is valid for soft-declined and hard-declined scheduled payments.
Skip or cancel a scheduled payment
To cancel a scheduled payment, if it is scheduled, or if it was soft-declined or hard-declined, set the status to skipped or cancelled. BillPro will not collect this payment.
Change a subscription interval
When you create a subscription, you can set the recurring_collection_interval to MONTH, QUARTER or YEAR.
To change the subscription interval with more flexibility and precision, you can change the interval of the scheduled payments.
To do this, in the scheduled payment object, set the scheduled_interval to a numerical value, and set the scheduled_duration_unit to DAY, WEEK, MONTH, or YEAR.
For example, a pharmacy selling a prescription medication for four weeks would set the scheduled_duration_unit to WEEK and the scheduled_interval to 4. This will have priority over the previous value and the subscription will renew every four weeks, instead of monthly.
The new payment schedule will be visible in the Scheduled Payments and Related Transactions sections of the order in the UI.
Subscription orders and the pause functionality
To pause a subscription order 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.
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.
Terminate an order
To terminate an order, see Cancel order or mark it as Complete in the BillPro UI. BillPro assigns the status of cancelled to uncollected billing events.