Skip to main content
POST
Suspend a recurring invoice
Authentication: API key OAuth 2.0
Scope: client_invoice.write
Suspending does not pause the schedule. While suspended, next_invoice_date is left out of responses, but the schedule keeps moving. If you suspend for three months and then reactivate, generation resumes at the next scheduled date. The three skipped invoices are not generated.
Only an active recurring invoice can be suspended. A scheduled one, whose first invoice has not been generated yet, returns 412 recurring_invoice_status_transition_forbidden. Cancel it instead. canceled and finished are final and cannot be suspended either. Takes no request body.

Authorizations

Authorization
string
header
required

Bearer authorization header: Bearer <token>, where <token> is the access token received from the authorization server at the end of the OAuth 2.0 flow.

Headers

X-Qonto-Staging-Token
string

Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.

Path Parameters

id
string<uuid>
required

The unique identifier of the recurring invoice.

Response

The recurring invoice, now suspended.

recurring_invoice
object
required