ChargebeeAPI

Remove payment from an invoice

Idempotency Supported
Try in API Explorer

Removes a payment transaction that was applied to an invoice and moves the amount to the customer's excess payments balance.

This API does not refund the payment to the customer. To refund a payment transaction, use one of the following APIs:

Prerequisites & Constraints

  • The invoice must not have any refunds or refundable credits issued. Specifically, there must be no issued_credit_notes with a cn_status value of refunded or refund_due for the invoice.
  • The specified transaction must be linked to the invoice. It must match one of the linked_payments[].txn_id for the invoice.
  • The status of the transaction must be success, in_progress, or needs_attention.

Impacts

Invoice

  • The amount_due on the invoice increases by the amount of the removed payment.
  • If the invoice status was payment_due, not_paid, or posted, the status does not change after a payment is removed.
  • If the invoice status was paid:
    • The status changes to posted if the due_date is in the future.
    • The status changes to payment_due if the due_date is in the past and auto_collection is off, or if auto_collection is on and dunning is in progress for the invoice.
    • The status changes to not_paid if the due date is in the past, auto_collection is on, and dunning was not in progress for the invoice.

Transaction

The amount_unused on the transaction increases by the amount of the removed payment.

Customer excess payments balance

The customer's excess_payments balance increases by the amount of the removed payment.

Invoice dunning process

  • If the invoice status was payment_due before this operation, and dunning was in progress for the invoice, the dunning process continues as configured.
  • If the invoice status was paid before this operation, the dunning process does not resume.

Implementation Notes

Before you call this API, make sure that:

  • There are no issued_credit_notes with a cn_status value of refunded or refund_due for the invoice.
  • The specified transaction matches one of the linked_payments[].txn_id for the invoice.
  • The status of the transaction is success, in_progress, or needs_attention.

FAQs

Can I remove payments from multiple invoices at once?

Yes. To remove payments from multiple invoices in bulk, go to Settings > Import > Export Data > Bulk Operation, and select Remove payment from Invoice.

How can I track the history of payments removed from invoices?

You can view the history of payments removed from invoices in the Activity Log section of the invoice. The log shows all actions taken, including payments removed.

Sample Request

URL Format

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

Input Parameters

transaction
optional, string

Parameters for transaction

Returns

invoiceInvoice object

Resource object representing invoice

transactionTransaction object

Resource object representing transaction