Endpoint Retrieve an Invoice Item
Name
get_invoice_item
Description
Retrieves the invoice item with the given Id. [API reference]
Related Tables
Parameters
| Parameter | Required | Options |
|---|---|---|
|
Name:
Label: Invoice Item Id Retrieve an invoice item for the Invoice Id. |
YES |
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 |
Input Columns
| Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
|---|---|---|---|---|
| Id |
DT_WSTR
|
nvarchar(4000)
|
4000 |
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:
| Required Parameters | |
|---|---|
| Invoice Item Id | Fill-in the parameter... |
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 retrieve an invoice item:
| Required Parameters | |
|---|---|
| Invoice Item Id | Fill-in the parameter... |
ODBC application
Use these SQL queries in your ODBC application data source:
Read an invoice line item
<p>Reads a single invoice line item from the <code>InvoiceItems</code> table by specifying the <code>Id</code>. This example demonstrates how to filter results to a specific line item using the WHERE clause.</p>
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:
Read an invoice line item
<p>Reads a single invoice line item from the <code>InvoiceItems</code> table by specifying the <code>Id</code>. This example demonstrates how to filter results to a specific line item using the WHERE clause.</p>
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).