Sign in
Invoices

Pause collection for an invoice

Stops collection of every payment request raised for this invoice by the named methods, leaving the customer's other invoices alone. Methods that are not named keep collecting, and a method that is already paused stays as it is.

put/invoices/{invoiceId}:pause_collection

Path parameters

invoiceIdstring uuid required

The identifier of the invoice.

Request body

collectionMethodsstring[] required

The collection methods to pause. At least one method is required.

Response

Collection is paused for the named methods.

Changes

Changed in 1 of the 8 revisions of this API.1