Query invoices
Use when listing or searching invoices (e.g. admin view or customer history). Returns a paginated list; supports filtering by customer, status, date range.
Request body
amount_due_gt filters invoices with a total amount due greater than the specified value Useful for finding invoices above a certain threshold or identifying high-value invoices
amount_remaining_gt filters invoices with an outstanding balance greater than the specified value Useful for finding invoices that still have significant unpaid amounts
currency filters invoices by their currency (ISO 4217 code, e.g. "usd", "eur"). Matches on the invoices.currency column exactly.
customer_id filters invoices for a specific customer using FlexPrice's internal customer ID This is the ID returned by FlexPrice when creating or retrieving customers
external_customer_id filters invoices for a customer using your system's customer identifier This is the ID you provided when creating the customer in FlexPrice
invoice_ids restricts results to invoices with the specified IDs Use this to retrieve specific invoices when you know their exact identifiers
invoice_status filters by the current state of invoices in their lifecycle Multiple statuses can be specified to include invoices in any of the listed states
payment_status filters by the payment state of invoices Multiple statuses can be specified to include invoices with any of the listed payment states
period_end_gte filters invoices with period_end >= value
period_end_lte filters invoices with period_end <= value
period_start_gte filters invoices with period_start >= value
period_start_lte filters invoices with period_start <= value
SkipLineItems if true, will not include line items in the response
subscription_customer_id filters invoices by the subscription owner's customer ID
subscription_id filters invoices generated for a specific subscription Only returns invoices that were created as part of the specified subscription's billing
Response
OK