Stripe Connector
Documentation
Version: 2
Documentation
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 Label Required Options Description
customer Customer Id YES The Id of the customer who will be billed.
auto_advance Auto Advance NO
Option Value
False False
True True
Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice’s state will not automatically advance without an explicit action.
collection_method Collection Method (charge_automatically or send_invoice) NO
Option Value
charge_automatically charge_automatically
send_invoice 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.
description Description NO An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.
subscription Subscription Id NO 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.
account_tax_ids Account Tax Id NO The account tax Ids associated with the invoice. Only editable when the invoice is a draft.
application_fee_amount Application Fee Amount NO A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account.
days_until_due Days Until Due (Can be set if Collection Method = send_invoice) NO The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
default_payment_method Default Payment Method Id NO 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.
default_source Default Source NO 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.
default_tax_rates Default Tax Rates NO The tax rates that will apply to any line item that does not have tax_rates set.
discounts_coupon Discounts Coupon Id NO ID of the coupon to create a new discount for.
discounts_discount Discounts Discount Id NO ID of an existing discount on the object (or one of its ancestors) to reuse.
due_date Due Date NO The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice
footer Footer NO Footer to be displayed on the invoice.
statement_descriptor Statement Desctiption NO 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.
transfer_data_destination Transfer Data Destination Id NO ID of an existing, connected Stripe account.
transfer_data_amount Transfer Data Amount NO The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
lines[0][invoice_line_item] Lines Object NO

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
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
If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Raw Description
InvoiceID 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_WSTR nvarchar(1020) 1020 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_I8 bigint 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(100) 100 False
Description DT_WSTR nvarchar(1020) 1020 False
Discount DT_WSTR nvarchar(1020) 1020 False
Discounts DT_WSTR nvarchar(100) 100 False
DueDate DT_WSTR nvarchar(1020) 1020 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_WSTR nvarchar(1020) 1020 False
Number DT_WSTR nvarchar(1020) 1020 False
Paid DT_BOOL bit False
PaymentIntent DT_WSTR nvarchar(1020) 1020 False
PeriodEnd DT_I8 bigint False
PeriodStart DT_I8 bigint 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_I8 bigint False
StatusTransitionsMarkedUncollectibleAt DT_WSTR nvarchar(1020) 1020 False
StatusTransitionsPaidAt DT_I8 bigint False
StatusTransitionsVoidedAt DT_WSTR nvarchar(1020) 1020 False
Subscription DT_WSTR nvarchar(1020) 1020 False
Subtotal DT_I8 bigint False
Tax DT_WSTR nvarchar(1020) 1020 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_I8 bigint False
Required columns that you need to supply are bolded.

Examples

SSIS

Use Stripe Connector in API Source component to read data or in API Destination component to read/write data:

Create an Invoice using API Source

Stripe
Create an Invoice
SSIS API Source - Read from table or endpoint

Create an Invoice using API Destination

Stripe
Create an Invoice
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];