Reference

Endpoint Create an Invoice Item

Name

create_invoice_item

Description

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified. [API reference]

Parameters

Parameter Required Options
Name: customer

Label: Customer Id

Create an invoice item for the Customer Id 		YES
Name: amount

Label: Amount

The integer amount in cents of the charge to be applied to the upcoming invoice. Passing in a negative amount will reduce the amount_due on the invoice.
Name: currency

Label: Currency

Three-letter ISO currency code, in lowercase.
Name: description

Label: Description

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
Name: period_start

Label: Period Start

The start of the period.
Name: period_end

Label: Period End

The end of the period, which must be greater than or equal to the start.
Name: price

Label: Price Id

The Id of the price object.
Name: discountable

Label: Discountable
Option Value
True True
False False
Name: discounts_coupon

Label: Discounts Coupon Id
Name: discounts_discount

Label: Discounts Discount Id
Name: invoice

Label: Invoice Id

The Id of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice.
Name: price_data_currency

Label: Price Data Currency

Three-letter ISO currency code, in lowercase.
Name: price_data_product

Label: Price Data Product

The Id of the product that this price will belong to.
Name: price_data_unit_amount_decimal

Label: Price Data Unit Amount Decimal

Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
Name: price_data_unit_amount

Label: Price Data Unit Amount

A positive integer in cents (or 0 for a free price) representing how much to charge. Only one of unit_amount and unit_amount_decimal can be set.
Name: quantity

Label: Quantity

Non-negative integer. The quantity of units for the invoice item.
Name: subscription

Label: Subscription Id

The Id of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
Name: tax_rates

Label: Tax Rates

The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
Name: unit_amount_decimal

Label: Unit Amount Decimal

Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
Name: unit_amount

Label: Unit Amount

The integer unit amount in cents of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.

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

API Source - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Create an Invoice Item
Required Parameters
Customer Id Fill-in the parameter...
Optional Parameters
Amount
Currency
Description
Period Start
Period End
Price Id
Discountable
Discounts Coupon Id
Discounts Discount Id
Invoice Id
Price Data Currency
Price Data Product
Price Data Unit Amount Decimal
Price Data Unit Amount
Quantity
Subscription Id
Tax Rates
Unit Amount Decimal
Unit Amount
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Create an Invoice Item
Required Parameters
Customer Id Fill-in the parameter...
Optional Parameters
Amount
Currency
Description
Period Start
Period End
Price Id
Discountable
Discounts Coupon Id
Discounts Discount Id
Invoice Id
Price Data Currency
Price Data Product
Price Data Unit Amount Decimal
Price Data Unit Amount
Quantity
Subscription Id
Tax Rates
Unit Amount Decimal
Unit Amount
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Create an invoice item 

SELECT * FROM create_invoice_item
WITH
(
    "customer" = 'abcd-1234-customer'
)

SQL Server

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

Create an invoice item 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM create_invoice_item
WITH
(
    "customer" = ''abcd-1234-customer''
)';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];