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:
- The status of the invoice is
payment_due. - The invoice belongs to a subscription or customer with
auto_collectionset toon. - The invoice does not have dunning paused currently.
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_dateis 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_dateis 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
Input Parameters
The date and time at which dunning should resume. See also: Dunning resumption process.
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
Resource object representing invoice