Overview
Cancels the active payment plan for a debt. Pending installments are removed, while already-paid installments are preserved as payment history. Use this when an external payment platform cancels or replaces a negotiated plan and no new schedule should remain active in GetBill. For grouped debts, calling this endpoint with any debt ID cancels the single shared plan for the whole group.This endpoint targets a known debt by its GetBill encrypted ID. If your system sends the complete view of a campaign, cancel the payment plan in
rows[].payment_plan of the campaign snapshot instead.data.active set to false.
Authentication
Requires a valid OAuth 2.0 access token with thedebts:write scope.