Reference

Endpoint List All Invoice Items

Name

get_invoice_items

Description

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first. [API reference]

Related Tables

InvoiceItems

Parameters

Parameter Required Options
Name: customer

Label: Customer Id

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

Label: Invoice Id

Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
Name: pending

Label: Pending

Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied.
Option Value
true true
false false
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

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(100) 100
InvoiceId DT_WSTR nvarchar(1020) 1020
Object DT_WSTR nvarchar(100) 100
Amount DT_I8 bigint
AmountDecimal DT_WSTR nvarchar(4000) 4000
Currency DT_WSTR nvarchar(100) 100
Customer DT_WSTR nvarchar(1020) 1020
Date DT_DBTIMESTAMP datetime
Description DT_WSTR nvarchar(255) 255
Discountable DT_BOOL bit
Discounts DT_WSTR nvarchar(100) 100
Livemode DT_BOOL bit
PeriodEnd DT_DBTIMESTAMP datetime
PeriodStart DT_DBTIMESTAMP datetime
PriceID DT_WSTR nvarchar(120) 120
PriceObject DT_WSTR nvarchar(100) 100
PriceActive DT_BOOL bit
PriceBillingScheme DT_WSTR nvarchar(100) 100
PriceCreated DT_DBTIMESTAMP datetime
PriceCurrency DT_WSTR nvarchar(100) 100
PriceLivemode DT_BOOL bit
PriceLookupKey DT_WSTR nvarchar(1020) 1020
PriceNickname DT_WSTR nvarchar(100) 100
PriceProductId DT_WSTR nvarchar(100) 100
PriceRecurringAggregateUsage DT_WSTR nvarchar(100) 100
PriceRecurringInterval DT_WSTR nvarchar(100) 100
PriceRecurringIntervalCount DT_I8 bigint
PriceRecurringTrialPeriodDays DT_I8 bigint
PriceRecurringUsageType DT_WSTR nvarchar(100) 100
PriceTiersMode DT_WSTR nvarchar(1020) 1020
PriceTransformQuantity DT_WSTR nvarchar(1020) 1020
PriceType DT_WSTR nvarchar(100) 100
PriceUnitAmount DT_I8 bigint
PriceUnitAmountDecimal DT_WSTR nvarchar(100) 100
Proration DT_BOOL bit
Quantity DT_I8 bigint
SubscriptionId DT_WSTR nvarchar(100) 100
TaxRates DT_WSTR nvarchar(100) 100
UnitAmount DT_I8 bigint
UnitAmountDecimal DT_WSTR nvarchar(100) 100
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 InvoiceItems 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
InvoiceItems
Optional Parameters
Customer Id
Invoice Id
Pending
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)
SSIS API Source - Read from table or endpoint

API Destination

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

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
InvoiceItems
Select
Optional Parameters
Customer Id
Invoice Id
Pending
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)
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get all Invoice Line Items

Read all Invoice Line Items 

SELECT * FROM InvoiceItems

get_invoice_items endpoint belongs to InvoiceItems 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 Invoice Line Items

Read all Invoice Line Items 

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

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