Invoices

Query invoices

Changed on

Use when listing or searching invoices (e.g. admin view or customer history). Returns a paginated list; supports filtering by customer, status, date range.

post/invoices/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/invoices/search
  • Auth
    API key in header x-api-key

Request body

amount_due_gtnumber

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_gtnumber

amount_remaining_gt filters invoices with an outstanding balance greater than the specified value Useful for finding invoices that still have significant unpaid amounts

billing_reason'SUBSCRIPTION_CREATE' | 'SUBSCRIPTION_CYCLE' | 'SUBSCRIPTION_UPDATE' | 'SUBSCRIPTION_TRIAL_END' | 'SUBSCRIPTION_TRIAL_START' | 'PRORATION' | 'MANUAL' | 'AUTO_INVOICE_THRESHOLD' | 'WALLET_AUTO_TOPUP' | 'SUBSCRIPTION_PAUSED' | 'SUBSCRIPTION_RESUME'
currencystring

currency filters invoices by their currency (ISO 4217 code, e.g. "usd", "eur"). Matches on the invoices.currency column exactly.

customer_idstring

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

end_timestring date-time
expandstring
external_customer_idstring

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

finalized_at_gtestring date-time

finalized_at_gte filters invoices finalized at or after the given instant

invoice_idsstring[]

invoice_ids restricts results to invoices with the specified IDs Use this to retrieve specific invoices when you know their exact identifiers

invoice_statusTypesInvoiceStatus[]

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

invoice_type'SUBSCRIPTION' | 'ONE_OFF' | 'CREDIT'
limitinteger
offsetinteger
order'asc' | 'desc'
payment_statusTypesPaymentStatus[]

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_gtestring

period_end_gte filters invoices with period_end >= value

period_end_ltestring

period_end_lte filters invoices with period_end <= value

period_start_gtestring

period_start_gte filters invoices with period_start >= value

period_start_ltestring

period_start_lte filters invoices with period_start <= value

skip_line_itemsboolean

SkipLineItems if true, will not include line items in the response

start_timestring date-time
status'published' | 'deleted' | 'archived'
subscription_customer_idstring[]

subscription_customer_id filters invoices by the subscription owner's customer ID

subscription_idstring

subscription_id filters invoices generated for a specific subscription Only returns invoices that were created as part of the specified subscription's billing

voided_at_gtestring date-time

voided_at_gte filters invoices voided at or after the given instant

Response

OK

Changes

  • 84cb4a3af400Revision changes
    • info

      added the optional property // to the response with the status

  • 96879a6887fcRevision changes
    • info

      added the new SUBSCRIPTION_PAUSED enum value to the request property

    • info

      added the new SUBSCRIPTION_RESUME enum value to the request property