Reference

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]

Related Tables

Invoices

Parameters

Parameter Required Options
Name: customer

Label: Customer Id

Only return invoices for the customer specified by this customer Id.
Name: status

Label: Status (draft or open or paid or uncollectible or void)

The status of the invoice, one of draft, open, paid, uncollectible, or void
Option Value
draft draft
open open
paid paid
uncollectible uncollectible
void void
Name: subscription

Label: Subscription Id

Only return invoices for the subscription specified by this subscription Id.
Name: collection_method

Label: Collection method (charge_automatically or send_invoice)

The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.
Option Value
charge_automatically charge_automatically
send_invoice. send_invoice.
Name: created_gt

Label: Created later than (yyyy-MM-dd)

Return results where the created field is greater than this value.
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
Name: created_gte

Label: Created on or later than (yyyy-MM-dd)

Return results where the created field is greater than or equal to this value.
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
Name: created_lt

Label: Created earlier than (yyyy-MM-dd)

Return results where the created field is less than this value.
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
Name: created_lte

Label: Created on or earlier than (yyyy-MM-dd)

Return results where the created field is less than or equal to this value.
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
Name: due_date_gt

Label: Due Date later than (yyyy-MM-dd)

Return results where the Due Date field is greater than this value.
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
Name: due_date_gte

Label: Due Date on or later than (yyyy-MM-dd)

Return results where the Due Date field is greater than or equal to this value.
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
Name: due_date_lt

Label: Due Date earlier than (yyyy-MM-dd)

Return results where the Due Date field is less than this value.
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
Name: due_date_lte

Label: Due Date on or earlier than (yyyy-MM-dd)

Return results where the Due Date field is less than or equal to this value.
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

Output Columns

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

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length 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 or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Invoices table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Invoices
Optional Parameters
Customer Id
Status (draft or open or paid or uncollectible or void)
Subscription Id
Collection method (charge_automatically or send_invoice)
Created later than (yyyy-MM-dd)
Created on or later than (yyyy-MM-dd)
Created earlier than (yyyy-MM-dd)
Created on or earlier than (yyyy-MM-dd)
Due Date later than (yyyy-MM-dd)
Due Date on or later than (yyyy-MM-dd)
Due Date earlier than (yyyy-MM-dd)
Due Date on or earlier than (yyyy-MM-dd)
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Invoices table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to list all invoices:

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Invoices
Select
Optional Parameters
Customer Id
Status (draft or open or paid or uncollectible or void)
Subscription Id
Collection method (charge_automatically or send_invoice)
Created later than (yyyy-MM-dd)
Created on or later than (yyyy-MM-dd)
Created earlier than (yyyy-MM-dd)
Created on or earlier than (yyyy-MM-dd)
Due Date later than (yyyy-MM-dd)
Due Date on or later than (yyyy-MM-dd)
Due Date earlier than (yyyy-MM-dd)
Due Date on or earlier than (yyyy-MM-dd)
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get all Invoices

Read all invoices 

SELECT * FROM Invoices

get_invoices endpoint belongs to Invoices table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get all Invoices

Read all invoices 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Invoices';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

get_invoices endpoint belongs to Invoices table(s), and can therefore be used via those table(s).