EndPoint Create an Invoice Item

Contents

1 Label
2 Description
3 Parameters
4 Output Columns
5 Input Columns

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

Label

Required

Options

Description

customer

Customer Id

YES

Create an invoice item for the Customer Id

amount

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.

currency

Currency

Three-letter ISO currency code, in lowercase.

description

Description

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

period_start

Period Start

The start of the period.

period_end

Period End

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

price

Price Id

The Id of the price object.

discountable

Discountable

Option	Value
True	True
False	False

discounts_coupon

Discounts Coupon Id

discounts_discount

Discounts Discount Id

invoice

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.

price_data_currency

Price Data Currency

Three-letter ISO currency code, in lowercase.

price_data_product

Price Data Product

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

price_data_unit_amount_decimal

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.

price_data_unit_amount

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.

quantity

Quantity

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

subscription

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.

tax_rates

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.

unit_amount_decimal

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.

unit_amount

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	Raw
Id	`DT_WSTR`	`nvarchar(255)`	255	False
Object	`DT_WSTR`	`nvarchar(100)`	100	False
AccountCountry	`DT_WSTR`	`nvarchar(100)`	100	False
AccountName	`DT_WSTR`	`nvarchar(1020)`	1020	False
AccountTaxId	`DT_WSTR`	`nvarchar(1020)`	1020	False
AmountDue	`DT_I8`	`bigint`		False
AmountPaid	`DT_I8`	`bigint`		False
AmountRemaining	`DT_I8`	`bigint`		False
ApplicationFeeAmount	`DT_I8`	`bigint`		False
AttemptCount	`DT_I8`	`bigint`		False
Attempted	`DT_BOOL`	`bit`		False
AutoAdvance	`DT_BOOL`	`bit`		False
BillingReason	`DT_WSTR`	`nvarchar(1020)`	1020	False
Charge	`DT_WSTR`	`nvarchar(255)`	255	False
CollectionMethod	`DT_WSTR`	`nvarchar(1020)`	1020	False
Created	`DT_DBTIMESTAMP`	`datetime`		False
Currency	`DT_WSTR`	`nvarchar(100)`	100	False
CustomFields	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerId	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerAddressCity	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerAddressCountry	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerAddressLine1	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerAddressLine2	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerAddressPostalCode	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerAddressState	`DT_WSTR`	`nvarchar(1020)`	1020	False
CustomerEmail	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerName	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerPhone	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingAddressCity	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingAddressCountry	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingAddressLine1	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingAddressLine2	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingAddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingAddressState	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingName	`DT_WSTR`	`nvarchar(100)`	100	False
CustomerShippingPhone	`DT_WSTR`	`nvarchar(100)`	100	False
TaxExempt	`DT_WSTR`	`nvarchar(100)`	100	False
TaxIDs	`DT_WSTR`	`nvarchar(1020)`	1020	False
DefaultPaymentMethod	`DT_WSTR`	`nvarchar(1020)`	1020	False
DefaultSource	`DT_WSTR`	`nvarchar(1020)`	1020	False
DefaultTaxRates	`DT_WSTR`	`nvarchar(1000)`	1000	False
Description	`DT_WSTR`	`nvarchar(1020)`	1020	False
Discount	`DT_WSTR`	`nvarchar(1020)`	1020	False
Discounts	`DT_WSTR`	`nvarchar(100)`	100	False
DueDate	`DT_DBTIMESTAMP`	`datetime`		False
EndingBalance	`DT_I8`	`bigint`		False
Footer	`DT_WSTR`	`nvarchar(1020)`	1020	False
HostedInvoiceURL	`DT_WSTR`	`nvarchar(1020)`	1020	False
InvoicePDF	`DT_WSTR`	`nvarchar(1020)`	1020	False
LastFinalizationError	`DT_WSTR`	`nvarchar(1020)`	1020	False
LinesObject	`DT_WSTR`	`nvarchar(100)`	100	False
LinesData	`DT_NTEXT`	`nvarchar(MAX)`		False
LinesHasMore	`DT_BOOL`	`bit`		False
LinesTotalCount	`DT_I8`	`bigint`		False
LinesUrl	`DT_WSTR`	`nvarchar(1020)`	1020	False
LiveMode	`DT_BOOL`	`bit`		False
NextPaymentAttempt	`DT_DBTIMESTAMP`	`datetime`		False
Number	`DT_WSTR`	`nvarchar(1020)`	1020	False
Paid	`DT_BOOL`	`bit`		False
PaymentIntent	`DT_WSTR`	`nvarchar(1020)`	1020	False
PeriodEnd	`DT_DBTIMESTAMP`	`datetime`		False
PeriodStart	`DT_DBTIMESTAMP`	`datetime`		False
PostPaymentCreditNotesAmount	`DT_I8`	`bigint`		False
PrepaymentCreditNotesAmount	`DT_I8`	`bigint`		False
ReceiptNumber	`DT_WSTR`	`nvarchar(255)`	255	False
StartingBalance	`DT_I8`	`bigint`		False
StatementDesctiption	`DT_WSTR`	`nvarchar(1020)`	1020	False
Status	`DT_WSTR`	`nvarchar(100)`	100	False
StatusTransitionsFinalizedAt	`DT_DBTIMESTAMP`	`datetime`		False
StatusTransitionsMarkedUncollectibleAt	`DT_DBTIMESTAMP`	`datetime`		False
StatusTransitionsPaidAt	`DT_DBTIMESTAMP`	`datetime`		False
StatusTransitionsVoidedAt	`DT_DBTIMESTAMP`	`datetime`		False
SubscriptionId	`DT_WSTR`	`nvarchar(1020)`	1020	False
Subtotal	`DT_I8`	`bigint`		False
Tax	`DT_I8`	`bigint`		False
Total	`DT_I8`	`bigint`		False
TotalDiscountAmounts	`DT_WSTR`	`nvarchar(100)`	100	False
TotalTaxAmounts	`DT_WSTR`	`nvarchar(100)`	100	False
TransferData	`DT_WSTR`	`nvarchar(1020)`	1020	False
WebhooksDeliveredAt	`DT_DBTIMESTAMP`	`datetime`		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.