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]

Parameters

Parameter

Label

Required

Options

Description

customer

Customer Id

Only return invoices for the customer specified by this customer Id.

invoice

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.

pending

Pending

Option	Value
true	true
false	false

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.

created_gt

Created later than (yyyy-MM-dd)

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)

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)

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)

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.

Output Columns

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

Stripe

List All Invoice Items

SSIS API Source - Read from table or endpoint

List All Invoice Items using API Destination

Stripe

List All Invoice Items