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

EndPoint Update an Invoice

Name

update_invoice

Description

Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable. [API Help]

Parameters

Parameter Label Required Options Description
Id Invoice Id YES Update an invoice for the Invoice Id
auto_advance Auto Advance NO
Option Value
False False
True True
Controls whether Stripe will perform automatic collection of the invoice.
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. This field can be updated only on draft invoices.
description Description NO An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.
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 which the invoice is created until it is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
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. Pass an empty string to remove previously-defined tax rates.
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. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
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.
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.

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
Id DT_WSTR 255 False
AutoAdvance DT_BOOL 0 False
CollectionMethod DT_WSTR 1020 False
Description DT_WSTR 1020 False
AccountTaxId DT_WSTR 1020 False
ApplicationFeeAmount DT_WSTR 1020 False
DaysUntilDue DT_WSTR 1020 False
DefaultPaymentMethod DT_WSTR 1020 False
DefaultSource DT_WSTR 1020 False
DefaultTaxRates DT_WSTR 100 False
Discounts Coupon Id DT_WSTR 1020 False
Discounts Discount Id DT_WSTR 1020 False
DueDate DT_WSTR 1020 False
Footer DT_WSTR 1020 False
StatementDesctiption DT_WSTR 1020 False
TransferDataDestination DT_WSTR 1020 False
TransferDataAmount DT_WSTR 1020 False