Remove payment schedule scheme from an invoice

Cancels remaining unpaid schedule entries on an invoice.

Use this when a payment schedule was applied in error or is no longer required. Unpaid schedule entries are set to voided; paid entries and their payments are preserved. After this operation, Chargebee no longer collects the invoice through scheduled installments.

Note: The invoice must be in payment_due, posted, or not_paid status and must have an associated payment schedule. Use Retrieve payment schedules for an invoice to verify.

Prerequisites & Constraints

The invoice status must be payment_due, posted, or not_paid.
The invoice must have a payment schedule created via Apply payment schedule scheme to an invoice.
The invoice must not have any linked_payments with txn_status set to in_progress.
The operation is not allowed if all schedule_entries[].status on the payment schedule are paid.

Impacts

Invoice

Returns the updated invoice. Unpaid installment collection stops; any payments already collected for paid schedule entries remain applied on the invoice.

Payment schedule

The parent payment_schedule is retained on the invoice.
Paid schedule_entries are preserved.
Unpaid schedule_entries[].status values (posted or payment_due) are set to voided.

Related APIs

Apply payment schedule scheme to an invoice

Retrieve payment schedules for an invoice

Sample Request

Remove payment schedule scheme from an invoice

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/invoices/{invoice-id}/remove_payment_schedule_scheme

Input Parameters

comment

optional, string, max chars=300

An internal comment to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Invoice PDF .

Returns

invoice

Invoice object

Resource object representing invoice