Skip to main content
GET
List recurring invoices

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.

Query Parameters

filter[status]
string

Filter by one or more statuses, comma-separated. One of: scheduled, active, suspended, canceled, finished. Invalid values return a 422.

filter[payment_method]
string

Filter by one or more payment methods, comma-separated. direct_debit matches recurring invoices collected by SEPA direct debit. credit_card, apple_pay, paypal, bank_transfer and ideal match the methods in payment_link. A recurring invoice matches if it has any of the values. Unknown values match nothing.

filter[client_id]
string

Filter by one or more client ids, comma-separated. Ids that are not UUIDs return a 422.

filter[next_invoice_date_from]
string<date>

Only return recurring invoices whose next invoice date is on or after this date, in YYYY-MM-DD format. A suspended recurring invoice can match even though its next_invoice_date is left out of the response.

filter[next_invoice_date_to]
string<date>

Only return recurring invoices whose next invoice date is on or before this date, in YYYY-MM-DD format.

filter[invoice_id]
string

Return the recurring invoices that generated one or more client invoices, as comma-separated client invoice ids. Ids that are not UUIDs return a 422.

page
integer
default:1

Returned page (cf. Pagination).

per_page
integer
default:100

Number of recurring invoices per page (cf. Pagination).

Required range: x <= 500

Response

Returns a list of recurring invoices.

recurring_invoices
object[]
required
meta
object
required