Stop an invoice recurrence

Ends a recurring or subscription series in one call. No further invoices are generated, and for a subscription your client's card is no longer charged automatically — the same thing the Bonsai app does when you end a billing cycle.

Nothing already issued is touched. An invoice that is outstanding stays outstanding and still needs paying, and nothing is deleted.

Pass any invoice in the series; the schedule always lives on the most recent one, and that is the invoice you get back. So the id in the response is often not the invoice_id you sent.

Read the result from recurrence_active, which is false once a series is stopped. repeat_interval keeps reporting the cadence the series ran on, because a stopped series keeps its schedule so it can be started again. kind still reads recurring when the series issued more than one invoice, because the invoice remains part of that series and keeps its series_id — the app shows this as a completed recurring invoice. Only an invoice that had not repeated yet comes back as single.

Stopping a series that never repeated leaves a draft invoice behind, and stopping a subscription also turns off the auto-send that issued it. Both match the app.

There is nothing to undo here and the call is not repeatable: an invoice with no live recurrence returns 422 rather than quietly doing nothing. A series that issued more than one invoice reports that it was already stopped; one that never repeated is a plain one-off afterwards, and reports that it is not recurring.

If your access is limited to certain projects and the most recent invoice in the series is not one you can reach, the call returns 422 and stops nothing, rather than stopping the newest invoice you happen to see and leaving the series running.