POST /invoices/{invoice-id}/pause_dunning

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 {#ApiDescription}

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_collection set to on.
The invoice does not have dunning paused currently.

Automatic dunning resumption {#dunning_resume_process}

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.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`invoice-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name Type Required Description

Name	Type	Required	Description
`comment`	String	No	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.
`expected_payment_date`	Integer	Yes	The date and time at which dunning should resume. See also : Dunning resumption process.

comment

String

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.

expected_payment_date

Integer

Yes

The date and time at which dunning should resume.

See also : Dunning resumption process.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.