Stripe Connector
Documentation
Version: 2
Documentation
Home » API Integration Hub » Stripe Connector » EndPoints > Create an Invoice Item

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 Help]

Parameters

Parameter Label Required Options Description
customer Customer Id YES Create an invoice item for the Customer Id
amount Amount NO 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 NO Three-letter ISO currency code, in lowercase.
description Description NO 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 NO The start of the period.
period_end Period End NO The end of the period, which must be greater than or equal to the start.
price Price Id NO The Id of the price object.
discountable Discountable NO
Option Value
True True
False False
discounts_coupon Discounts Coupon Id NO
discounts_discount Discounts Discount Id NO
invoice Invoice Id NO 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 NO Three-letter ISO currency code, in lowercase.
price_data_product Price Data Product NO The Id of the product that this price will belong to.
price_data_unit_amount_decimal Price Data Unit Amount Decimal NO 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 NO 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 NO Non-negative integer. The quantity of units for the invoice item.
subscription Subscription Id NO 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 NO 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 NO 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 NO 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 DataType Length Raw Description
Id DT_WSTR 255 False
Object DT_WSTR 100 False
AccountCountry DT_WSTR 100 False
AccountName DT_WSTR 1020 False
AccountTaxId DT_WSTR 1020 False
AmountDue DT_I8 0 False
AmountPaid DT_I8 0 False
AmountRemaining DT_I8 0 False
ApplicationFeeAmount DT_I8 0 False
AttemptCount DT_I8 0 False
Attempted DT_BOOL 0 False
AutoAdvance DT_BOOL 0 False
BillingReason DT_WSTR 1020 False
Charge DT_WSTR 255 False
CollectionMethod DT_WSTR 1020 False
Created DT_DBTIMESTAMP 0 False
Currency DT_WSTR 100 False
CustomFields DT_WSTR 1020 False
CustomerId DT_WSTR 1020 False
CustomerAddressCity DT_WSTR 1020 False
CustomerAddressCountry DT_WSTR 1020 False
CustomerAddressLine1 DT_WSTR 1020 False
CustomerAddressLine2 DT_WSTR 1020 False
CustomerAddressPostalCode DT_WSTR 1020 False
CustomerAddressState DT_WSTR 1020 False
CustomerEmail DT_WSTR 100 False
CustomerName DT_WSTR 100 False
CustomerPhone DT_WSTR 100 False
CustomerShippingAddressCity DT_WSTR 100 False
CustomerShippingAddressCountry DT_WSTR 100 False
CustomerShippingAddressLine1 DT_WSTR 100 False
CustomerShippingAddressLine2 DT_WSTR 100 False
CustomerShippingAddressPostalCode DT_WSTR 100 False
CustomerShippingAddressState DT_WSTR 100 False
CustomerShippingName DT_WSTR 100 False
CustomerShippingPhone DT_WSTR 100 False
TaxExempt DT_WSTR 100 False
TaxIDs DT_WSTR 1020 False
DefaultPaymentMethod DT_WSTR 1020 False
DefaultSource DT_WSTR 1020 False
DefaultTaxRates DT_WSTR 1000 False
Description DT_WSTR 1020 False
Discount DT_WSTR 1020 False
Discounts DT_WSTR 100 False
DueDate DT_DBTIMESTAMP 0 False
EndingBalance DT_I8 0 False
Footer DT_WSTR 1020 False
HostedInvoiceURL DT_WSTR 1020 False
InvoicePDF DT_WSTR 1020 False
LastFinalizationError DT_WSTR 1020 False
LinesObject DT_WSTR 100 False
LinesData DT_NTEXT 0 False
LinesHasMore DT_BOOL 0 False
LinesTotalCount DT_I8 0 False
LinesUrl DT_WSTR 1020 False
LiveMode DT_BOOL 0 False
NextPaymentAttempt DT_DBTIMESTAMP 0 False
Number DT_WSTR 1020 False
Paid DT_BOOL 0 False
PaymentIntent DT_WSTR 1020 False
PeriodEnd DT_DBTIMESTAMP 0 False
PeriodStart DT_DBTIMESTAMP 0 False
PostPaymentCreditNotesAmount DT_I8 0 False
PrepaymentCreditNotesAmount DT_I8 0 False
ReceiptNumber DT_WSTR 255 False
StartingBalance DT_I8 0 False
StatementDesctiption DT_WSTR 1020 False
Status DT_WSTR 100 False
StatusTransitionsFinalizedAt DT_DBTIMESTAMP 0 False
StatusTransitionsMarkedUncollectibleAt DT_DBTIMESTAMP 0 False
StatusTransitionsPaidAt DT_DBTIMESTAMP 0 False
StatusTransitionsVoidedAt DT_DBTIMESTAMP 0 False
SubscriptionId DT_WSTR 1020 False
Subtotal DT_I8 0 False
Tax DT_I8 0 False
Total DT_I8 0 False
TotalDiscountAmounts DT_WSTR 100 False
TotalTaxAmounts DT_WSTR 100 False
TransferData DT_WSTR 1020 False
WebhooksDeliveredAt DT_DBTIMESTAMP 0 False

Input Columns

Label DataType Length Raw Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.