Endpoint

Retrieve an Invoice Item

Name

get_invoice_item

Description

Retrieves the invoice item with the given Id. [API reference]

Related Tables

InvoiceItems

Parameters

Parameter	Label	Required	Options	Description
Id	Invoice Item Id	YES		Retrieve an invoice item for the Invoice Id.

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`

If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

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

Lookup a row in InvoiceItems table using API Destination

This Endpoint belongs to InvoiceItems table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Stripe

InvoiceItems

Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Retrieve an invoice item

SELECT * FROM get_invoice_item
WHERE Id = 'abcd-1234-id'

Get an Invoice Line Item

Read an invoice line item by Id

SELECT * FROM InvoiceItems
WHERE Id = 'abc'

get_invoice_item 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:

Retrieve an invoice item

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_invoice_item
WHERE Id = ''abcd-1234-id''';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

Get an Invoice Line Item

Read an invoice line item by Id

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];

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