Stripe Connector
Documentation
Version: 2
Documentation
Home » API Integration Hub » Stripe Connector » EndPoints » List All Invoices

EndPoint List All Invoices

Name

get_invoices

Description

You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. [API reference]

Parameters

Parameter Label Required Options Description
customer Customer Id NO Only return invoices for the customer specified by this customer Id.
status Status (draft or open or paid or uncollectible or void) NO
Option Value
draft draft
open open
paid paid
uncollectible uncollectible
void void
The status of the invoice, one of draft, open, paid, uncollectible, or void
subscription Subscription Id NO Only return invoices for the subscription specified by this subscription Id.
collection_method Collection method (charge_automatically or send_invoice) NO
Option Value
charge_automatically charge_automatically
send_invoice. send_invoice.
The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.
created_gt Created later than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the created field is greater than this value.
created_gte Created on or later than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the created field is greater than or equal to this value.
created_lt Created earlier than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the created field is less than this value.
created_lte Created on or earlier than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the created field is less than or equal to this value.
due_date_gt Due Date later than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the Due Date field is greater than this value.
due_date_gte Due Date on or later than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the Due Date field is greater than or equal to this value.
due_date_lt Due Date earlier than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the Due Date field is less than this value.
due_date_lte Due Date on or earlier than (yyyy-MM-dd) NO
Option Value
today today
yesterday yesterday
monthstart monthstart
monthend monthend
yearstart yearstart
yearend yearend
weekstart weekstart
weekend weekend
yearstart-1y yearstart-1y
yearend-1y yearend-1y
monthstart-1d monthstart-1d
monthend+1d monthend+1d
2022-01-31 2022-01-31
2022-01-31 23:59:59 2022-01-31 23:59:59
Return results where the Due Date field is less than or equal to this value.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
Id DT_WSTR nvarchar(255) 255 False
Object DT_WSTR nvarchar(100) 100 False
AccountCountry DT_WSTR nvarchar(100) 100 False
AccountName DT_WSTR nvarchar(1020) 1020 False
AccountTaxId DT_WSTR nvarchar(1020) 1020 False
AmountDue DT_I8 bigint False
AmountPaid DT_I8 bigint False
AmountRemaining DT_I8 bigint False
ApplicationFeeAmount DT_I8 bigint False
AttemptCount DT_I8 bigint False
Attempted DT_BOOL bit False
AutoAdvance DT_BOOL bit False
BillingReason DT_WSTR nvarchar(1020) 1020 False
Charge DT_WSTR nvarchar(255) 255 False
CollectionMethod DT_WSTR nvarchar(1020) 1020 False
Created DT_DBTIMESTAMP datetime False
Currency DT_WSTR nvarchar(100) 100 False
CustomFields DT_WSTR nvarchar(1020) 1020 False
CustomerId DT_WSTR nvarchar(1020) 1020 False
CustomerAddressCity DT_WSTR nvarchar(1020) 1020 False
CustomerAddressCountry DT_WSTR nvarchar(1020) 1020 False
CustomerAddressLine1 DT_WSTR nvarchar(1020) 1020 False
CustomerAddressLine2 DT_WSTR nvarchar(1020) 1020 False
CustomerAddressPostalCode DT_WSTR nvarchar(1020) 1020 False
CustomerAddressState DT_WSTR nvarchar(1020) 1020 False
CustomerEmail DT_WSTR nvarchar(100) 100 False
CustomerName DT_WSTR nvarchar(100) 100 False
CustomerPhone DT_WSTR nvarchar(100) 100 False
CustomerShippingAddressCity DT_WSTR nvarchar(100) 100 False
CustomerShippingAddressCountry DT_WSTR nvarchar(100) 100 False
CustomerShippingAddressLine1 DT_WSTR nvarchar(100) 100 False
CustomerShippingAddressLine2 DT_WSTR nvarchar(100) 100 False
CustomerShippingAddressPostalCode DT_WSTR nvarchar(100) 100 False
CustomerShippingAddressState DT_WSTR nvarchar(100) 100 False
CustomerShippingName DT_WSTR nvarchar(100) 100 False
CustomerShippingPhone DT_WSTR nvarchar(100) 100 False
TaxExempt DT_WSTR nvarchar(100) 100 False
TaxIDs DT_WSTR nvarchar(1020) 1020 False
DefaultPaymentMethod DT_WSTR nvarchar(1020) 1020 False
DefaultSource DT_WSTR nvarchar(1020) 1020 False
DefaultTaxRates DT_WSTR nvarchar(1000) 1000 False
Description DT_WSTR nvarchar(1020) 1020 False
Discount DT_WSTR nvarchar(1020) 1020 False
Discounts DT_WSTR nvarchar(100) 100 False
DueDate DT_DBTIMESTAMP datetime False
EndingBalance DT_I8 bigint False
Footer DT_WSTR nvarchar(1020) 1020 False
HostedInvoiceURL DT_WSTR nvarchar(1020) 1020 False
InvoicePDF DT_WSTR nvarchar(1020) 1020 False
LastFinalizationError DT_WSTR nvarchar(1020) 1020 False
LinesObject DT_WSTR nvarchar(100) 100 False
LinesData DT_NTEXT nvarchar(MAX) False
LinesHasMore DT_BOOL bit False
LinesTotalCount DT_I8 bigint False
LinesUrl DT_WSTR nvarchar(1020) 1020 False
LiveMode DT_BOOL bit False
NextPaymentAttempt DT_DBTIMESTAMP datetime False
Number DT_WSTR nvarchar(1020) 1020 False
Paid DT_BOOL bit False
PaymentIntent DT_WSTR nvarchar(1020) 1020 False
PeriodEnd DT_DBTIMESTAMP datetime False
PeriodStart DT_DBTIMESTAMP datetime False
PostPaymentCreditNotesAmount DT_I8 bigint False
PrepaymentCreditNotesAmount DT_I8 bigint False
ReceiptNumber DT_WSTR nvarchar(255) 255 False
StartingBalance DT_I8 bigint False
StatementDesctiption DT_WSTR nvarchar(1020) 1020 False
Status DT_WSTR nvarchar(100) 100 False
StatusTransitionsFinalizedAt DT_DBTIMESTAMP datetime False
StatusTransitionsMarkedUncollectibleAt DT_DBTIMESTAMP datetime False
StatusTransitionsPaidAt DT_DBTIMESTAMP datetime False
StatusTransitionsVoidedAt DT_DBTIMESTAMP datetime False
SubscriptionId DT_WSTR nvarchar(1020) 1020 False
Subtotal DT_I8 bigint False
Tax DT_I8 bigint False
Total DT_I8 bigint False
TotalDiscountAmounts DT_WSTR nvarchar(100) 100 False
TotalTaxAmounts DT_WSTR nvarchar(100) 100 False
TransferData DT_WSTR nvarchar(1020) 1020 False
WebhooksDeliveredAt DT_DBTIMESTAMP datetime False

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Stripe Connector in API Source component to read data or in API Destination component to read/write data:

List All Invoices using API Source

Stripe
List All Invoices
SSIS API Source - Read from table or endpoint

List All Invoices using API Destination

Stripe
List All Invoices
SSIS API Destination - Access table or endpoint