Cancelling a billing run stops any remaining work. Deleting a billing run permanently removes the run and its planned or completed actions, except for any batch the run opened while executing. You can cancel a run in the Console, but the Console does not include a screen for deleting one outright.
When to Use This
Cancel a billing run when you do not want it to continue, whether it is scheduled, still being planned, or reviewed and waiting to execute. Cancelling also removes the run from the work that still needs attention.
Prerequisites
- Permission to work with billing runs.
- The run must still be in a status that allows cancellation: draft, scheduled, ready for execution, or scheduled for execution. A run that has already started executing, completed, or already been cancelled does not show this button.
Cancel a Billing Run
- Open the billing run's page.
- Select Cancel Run.
- Confirm the warning, which reads "Cancelling the billing run cannot be undone."
Result
The run's status changes to Cancelled, and the page reloads immediately. You see only the Clone option, and the buttons to refresh, pre-process, or run the billing run are gone.
Warning
Cancelling is final. You cannot move a cancelled run back to a scheduled or ready state. If you need the same billing work later, clone it into a new run instead. See Create or Edit a Billing Run.
Cancel Run is not available after a run is running, completed, timed out, or already cancelled. At that point, the run's page shows only Clone, so you need to build a new run from it.
What Happens to a Cancelled Run's Planned Actions
When you cancel a run, Rhythm removes any pending actions that had not happened yet. Actions the run already completed are not affected, and the cancelled run still shows that earlier work on its Actions tab. See Review and Run a Billing Plan for how to read that list.
Tip
Cancel Run is hidden while the run's page is automatically refreshing, which happens while a run is being pre-processed or run. If you need to stop a run at that point, wait for the current step to finish so the button can reappear.
Deleting a Billing Run
The Console does not have a button to delete a billing run outright. Deletion is only possible through an integration that calls Rhythm directly, and it removes the run along with every action it planned or carried out. Because deletion removes the record of what the run did to your customers, it is not offered as an everyday Console action. A batch the run opened while executing is not deleted with the run.
Warning
Deleting a billing run is permanent and removes the record of everything the run planned and did, not just its future work. Cancelling, not deleting, is almost always the right choice when you simply want to stop a run. Use deletion only when the run record itself, including its history, should not exist at all.
Removing Invoices a Billing Run Already Created
Cancelling or deleting a run does not remove invoices it already created. If those invoices are pro forma and still have an outstanding balance, find them with an invoice query and mass-delete them using Bulk Changes. After the mass deletion, confirm the affected invoices' Date State Updated field shows Updated; if an order's status still needs to change, resave the invoice.
Warning
Mass deletion this way only works for pro forma invoices. An invoice that is not pro forma cannot be handled the same way — open its order and cancel it by hand instead.
Warning
There is no bulk cancel or bulk void action for invoices a billing run already created, whether they are pro forma or not. If a run executed incorrectly and created invoices you need to reverse, plan to handle them individually — through the mass-delete path above for pro forma invoices, or one at a time otherwise — since no bulk reversal option exists.
Related Reading
To build a new run instead of continuing a cancelled one, see Create or Edit a Billing Run. To find a run you want to cancel, see Search and Review Billing Runs.