EndPoint Create an Invoice

Contents

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

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

Parameters

Parameter

Label

Required

Options

Description

customer

Customer Id

YES

The Id of the customer who will be billed.

auto_advance

Auto Advance

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)

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

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

subscription

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.

account_tax_ids

Account Tax Id

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

application_fee_amount

Application Fee Amount

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)

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

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

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

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

discounts_coupon

Discounts Coupon Id

ID of the coupon to create a new discount for.

discounts_discount

Discounts Discount Id

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

due_date

Due Date

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

footer

Footer

Footer to be displayed on the invoice.

statement_descriptor

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.

transfer_data_destination

Transfer Data Destination Id

ID of an existing, connected Stripe account.

transfer_data_amount

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.

lines[0][invoice_line_item]

Lines Object

Output Columns

Label	DataType	Length	Raw
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
InvoiceID	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_WSTR	1020	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_I8	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	100	False
Description	DT_WSTR	1020	False
Discount	DT_WSTR	1020	False
Discounts	DT_WSTR	100	False
DueDate	DT_WSTR	1020	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_WSTR	1020	False
Number	DT_WSTR	1020	False
Paid	DT_BOOL	0	False
PaymentIntent	DT_WSTR	1020	False
PeriodEnd	DT_I8	0	False
PeriodStart	DT_I8	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_I8	0	False
StatusTransitionsMarkedUncollectibleAt	DT_WSTR	1020	False
StatusTransitionsPaidAt	DT_I8	0	False
StatusTransitionsVoidedAt	DT_WSTR	1020	False
Subscription	DT_WSTR	1020	False
Subtotal	DT_I8	0	False
Tax	DT_WSTR	1020	False
Total	DT_I8	0	False
TotalDiscountAmounts	DT_WSTR	100	False
TotalTaxAmounts	DT_WSTR	100	False
TransferData	DT_WSTR	1020	False
WebhooksDeliveredAt	DT_I8	0	False