See an order's payments over time, and manage the ones still to come.
A scheduled payment is a planned future collection on an instalment, subscription or metered order. BillPro collects it on its scheduled_at date.
A billing event is one row in an order's payment timeline. It's either a scheduled payment or a standalone payment, such as a single payment. Refunds, captures and reversals sit inside the row they belong to.
Scheduled payment statuses
| Icon | Status | API value | Meaning |
|---|---|---|---|
| Scheduled | scheduled | Still to be collected on its scheduled_at date. You can reschedule, merge, skip or execute it. | |
| Completed | complete | Collected in full. | |
| Recovered | recovered | Collected after a soft decline, by an automatic retry, a manual charge or a card replacement. | |
| Soft Declined | failed | Soft-declined. You can charge it again, or BillPro retries it automatically if auto-retry is on. | |
| Hard Declined | rejected | Hard-declined. It can't be charged again on the same card. Replace the card to collect it. | |
| Skipped | skipped | Not collected, and removed from the order total. It can't be collected later. | |
| Merged | merged | Combined with other payments into a new scheduled payment, which is collected instead. | |
| Paused | paused | The subscription is paused, so it won't be collected until the order resumes. | |
| Review | review | Held for a manual check on an instalment order in review. | |
| Cancelled | cancelled | The order was cancelled or completed, so it won't be collected. |
These match the billing event statuses in the BillPro dashboard. For more, see Billing event status in the guides.
To change a payment that's still to come, see Manage scheduled payments. To charge a metered order for usage, add a payment to it.