Description: Stripe Invoices represent billing documents issued to customers for goods or services provided through the Stripe platform. Each Invoice object contains details such as itemized charges, payment terms, and customer information. This tool returns previously synced records, it does not create or modify records.
Category: Billing and Invoicing
This tool is paginated. Default page size is 10 records; only increase 'limit' if the user explicitly requests more records per page.
Filterable fields: status (eq, ne, in, contains); collection_method (eq, ne, in, contains); livemode (eq, ne); webhooks_delivered_at (eq, ne, gt, gte, lt, lte, in); subtotal_excluding_tax (eq, ne, gt, gte, lt, lte, in); attempted (eq, ne); amount_remaining (eq, ne, gt, gte, lt, lte, in); amount_shipping (eq, ne, gt, gte, lt, lte, in); subtotal (eq, ne, gt, gte, lt, lte, in); invoice_pdf (eq, ne, in, contains); amount_due (eq, ne, gt, gte, lt, lte, in); billing_reason (eq, ne, in, contains); starting_balance (eq, ne, gt, gte, lt, lte, in); next_payment_attempt (eq, ne, gt, gte, lt, lte, in); customer_account (eq, ne, in, contains); object (eq, ne, in, contains); automatically_finalizes_at (eq, ne, gt, gte, lt, lte, in); latest_revision (eq, ne, in, contains); customer_phone (eq, ne, in, contains); statement_descriptor (eq, ne, in, contains); default_payment_method (eq, ne, in, contains); created (eq, ne, gt, gte, lt, lte, in); footer (eq, ne, in, contains); ending_balance (eq, ne, gt, gte, lt, lte, in); receipt_number (eq, ne, in, contains); id (eq, ne, in, contains); number (eq, ne, in, contains); period_start (eq, ne, gt, gte, lt, lte, in); account_country (eq, ne, in, contains); application (eq, ne, in, contains); customer_name (eq, ne, in, contains); effective_at (eq, ne, gt, gte, lt, lte, in); customer_email (eq, ne, in, contains); account_name (eq, ne, in, contains); total (eq, ne, gt, gte, lt, lte, in); hosted_invoice_url (eq, ne, in, contains); total_excluding_tax (eq, ne, gt, gte, lt, lte, in); on_behalf_of (eq, ne, in, contains); due_date (eq, ne, gt, gte, lt, lte, in); auto_advance (eq, ne); amount_paid (eq, ne, gt, gte, lt, lte, in); amount_overpaid (eq, ne, gt, gte, lt, lte, in); pre_payment_credit_notes_amount (eq, ne, gt, gte, lt, lte, in); currency (eq, ne, in, contains); period_end (eq, ne, gt, gte, lt, lte, in); default_source (eq, ne, in, contains); customer_tax_exempt (eq, ne, in, contains); post_payment_credit_notes_amount (eq, ne, gt, gte, lt, lte, in); attempt_count (eq, ne, gt, gte, lt, lte, in); description (eq, ne, in, contains); customer (eq, ne, in, contains); test_clock (eq, ne, in, contains). On text fields, eq/ne/in match exact values case-insensitively; contains matches a substring, also case-insensitively.
Aggregation: for totals, counts, averages, min/max, or chart data, pass `aggregate` instead of paging through records — results are computed exactly on the server. sum/avg fields: subtotal_excluding_tax, amount_remaining, amount_shipping, subtotal, amount_due, starting_balance, ending_balance, total, total_excluding_tax, amount_paid, amount_overpaid, pre_payment_credit_notes_amount, post_payment_credit_notes_amount, attempt_count. min/max fields: subtotal_excluding_tax, amount_remaining, amount_shipping, subtotal, amount_due, starting_balance, ending_balance, total, total_excluding_tax, amount_paid, amount_overpaid, pre_payment_credit_notes_amount, post_payment_credit_notes_amount, attempt_count, webhooks_delivered_at, next_payment_attempt, automatically_finalizes_at, created, period_start, effective_at, due_date, period_end. Date fields (groupBy may set bucket day/week/month/quarter/year): webhooks_delivered_at, next_payment_attempt, automatically_finalizes_at, created, period_start, effective_at, due_date, period_end. count without a field counts rows; with a field it counts non-null values. Bucket values are the first day of the period as YYYY-MM-DD (weeks start Monday; timestamp-with-time-zone fields are bucketed in UTC). Numeric results are strings to preserve exact precision; counts are integers. Text groups are exact, case-sensitive values; nulls form their own group. At most 500 groups are returned (truncated is set if there are more).
get_stripe_invoice