Reference

Endpoint Create an Invoice

Name

create_invoice

Description

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers. [API reference]

Parameters

Parameter

Required

Options

Name: customer

Label: Customer Id

The Id of the customer who will be billed.

YES

Name: auto_advance

Label: Auto Advance

Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice’s state will not automatically advance without an explicit action.

Option	Value
False	False
True	True

Name: collection_method

Label: Collection Method (charge_automatically or send_invoice)

Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to charge_automatically.

Option	Value
charge_automatically	charge_automatically
send_invoice	send_invoice

Name: description

Label: Description

An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.

Name: subscription

Label: Subscription Id

The Id of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription’s billing cycle and regular subscription events won’t be affected.

Name: account_tax_ids

Label: Account Tax Id

The account tax Ids associated with the invoice. Only editable when the invoice is a draft.

Name: application_fee_amount

Label: Application Fee Amount

A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account.

Name: days_until_due

Label: Days Until Due (Can be set if Collection Method = send_invoice)

The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.

Name: default_payment_method

Label: Default Payment Method Id

ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.

Name: default_source

Label: Default Source

ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.

Name: default_tax_rates

Label: Default Tax Rates

The tax rates that will apply to any line item that does not have tax_rates set.

Name: discounts_coupon

Label: Discounts Coupon Id

ID of the coupon to create a new discount for.

Name: discounts_discount

Label: Discounts Discount Id

ID of an existing discount on the object (or one of its ancestors) to reuse.

Name: due_date

Label: Due Date

The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice

Name: footer

Label: Footer

Footer to be displayed on the invoice.

Name: statement_descriptor

Label: Statement Desctiption

Extra information about a charge for the customer’s credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item’s product’s statement_descriptor.

Name: transfer_data_destination

Label: Transfer Data Destination Id

ID of an existing, connected Stripe account.

Name: transfer_data_amount

Label: Transfer Data Amount

The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.

Name: lines[0][invoice_line_item]

Label: Lines Object

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
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
InvoiceID	`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_WSTR`	`nvarchar(1020)`	1020
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_I8`	`bigint`
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(100)`	100
Description	`DT_WSTR`	`nvarchar(1020)`	1020
Discount	`DT_WSTR`	`nvarchar(1020)`	1020
Discounts	`DT_WSTR`	`nvarchar(100)`	100
DueDate	`DT_WSTR`	`nvarchar(1020)`	1020
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_WSTR`	`nvarchar(1020)`	1020
Number	`DT_WSTR`	`nvarchar(1020)`	1020
Paid	`DT_BOOL`	`bit`
PaymentIntent	`DT_WSTR`	`nvarchar(1020)`	1020
PeriodEnd	`DT_I8`	`bigint`
PeriodStart	`DT_I8`	`bigint`
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_I8`	`bigint`
StatusTransitionsMarkedUncollectibleAt	`DT_WSTR`	`nvarchar(1020)`	1020
StatusTransitionsPaidAt	`DT_I8`	`bigint`
StatusTransitionsVoidedAt	`DT_WSTR`	`nvarchar(1020)`	1020
Subscription	`DT_WSTR`	`nvarchar(1020)`	1020
Subtotal	`DT_I8`	`bigint`
Tax	`DT_WSTR`	`nvarchar(1020)`	1020
Total	`DT_I8`	`bigint`
TotalDiscountAmounts	`DT_WSTR`	`nvarchar(100)`	100
TotalTaxAmounts	`DT_WSTR`	`nvarchar(100)`	100
TransferData	`DT_WSTR`	`nvarchar(1020)`	1020
WebhooksDeliveredAt	`DT_I8`	`bigint`

Required columns that you need to supply are bolded.

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

Required Parameters
Customer Id	Fill-in the parameter...
Optional Parameters
Auto Advance
Collection Method (charge_automatically or send_invoice)
Description
Subscription Id
Account Tax Id
Application Fee Amount
Days Until Due (Can be set if Collection Method = send_invoice)
Default Payment Method Id
Default Source
Default Tax Rates
Discounts Coupon Id
Discounts Discount Id
Due Date
Footer
Statement Desctiption
Transfer Data Destination Id
Transfer Data Amount
Lines Object

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

Required Parameters
Customer Id	Fill-in the parameter...
Optional Parameters
Auto Advance
Collection Method (charge_automatically or send_invoice)
Description
Subscription Id
Account Tax Id
Application Fee Amount
Days Until Due (Can be set if Collection Method = send_invoice)
Default Payment Method Id
Default Source
Default Tax Rates
Discounts Coupon Id
Discounts Discount Id
Due Date
Footer
Statement Desctiption
Transfer Data Destination Id
Transfer Data Amount
Lines Object

SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Create an invoice

SELECT * FROM create_invoice
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

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

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];