ChargebeeAPI

Pause dunning for invoice

Idempotency Supported
Try in API Explorer

Pause dunning for the specified invoice until expected_payment_date. Chargebee cancels all configured payment collection retry attempts and dunning email notifications for the invoice until expected_payment_date.

Prerequisites

This operation is only permitted for an invoice that meets all the following conditions:

Automatic dunning resumption

Unless you resume dunning for the invoice, Chargebee attempts to collect payment on the expected_payment_date. If payment collection fails, the next action is taken as follows:

  • If the expected_payment_date is within the dunning period for the invoice, Chargebee resumes any dunning retries and email notifications that remain after the pause period, and not attempt the retries or notifications that were canceled during the pause period.
  • If the expected_payment_date is after the dunning period for the invoice, the final action configured in Billing is initiated for the invoice and, if applicable, for the subscription.

Sample Request

URL Format

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

Input Parameters

expected_payment_date
required, timestamp(UTC) in seconds

The date and time at which dunning should resume. See also: Dunning resumption process.

comment
optional, string, max chars=300

An internal comment to add to the invoice for this operation. This comment is displayed on the Chargebee Billing UI. Note: This comment does not appear on any customer-facing hosted pages or documents, such as the invoice PDF.

Returns

invoiceInvoice object

Resource object representing invoice