StripeAPI.Operations.PostInvoicesInvoice

POST /v1/invoices/{invoice}

<p>Draft invoices are fully editable. Once an invoice is <a href="/docs/billing/invoices/workflow#finalized">finalized</a>, monetary values, as well as <code>collection_method</code>, become uneditable.</p>

<p>If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or <a href="/docs/billing/invoices/reconciliation">automatically reconciling</a> invoices, pass <code>auto_advance=false</code>.</p>

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Create a new PostInvoicesInvoiceRequestBody with all required fields.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.account_tax_ids.anyOf in the specification.

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

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.automatic_tax in the specification.

Settings for automatic tax lookup for this invoice.

Create a new PostInvoicesInvoiceRequestBodyAutomaticTax' with all required fields.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.collection_method in the specification.

Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.custom_fields.anyOf.items in the specification.

Create a new PostInvoicesInvoiceRequestBodyCustomFields'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.custom_fields.anyOf in the specification.

A list of up to 4 custom fields to be displayed on the invoice. If a value for `custom_fields` is specified, the list specified will replace the existing custom field list on this invoice. Pass an empty string to remove previously-defined fields.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.default_tax_rates.anyOf in the specification.

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.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf.items in the specification.

Create a new PostInvoicesInvoiceRequestBodyDiscounts'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.discounts.anyOf in the specification.

The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.on_behalf_of.anyOf in the specification.

The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings in the specification.

Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings' with all required fields.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions' with all required fields.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'AcssDebit'OneOf1 with all required fields.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf.properties.mandate_options in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'AcssDebit'OneOf1MandateOptions' with all required fields.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf.properties.mandate_options.properties.transaction_type in the specification.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf.properties.verification_method in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.acss_debit.anyOf in the specification.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'Bancontact'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf.properties.preferred_language in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.bancontact.anyOf in the specification.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'Card'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf.properties.request_three_d_secure in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.card.anyOf in the specification.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'CustomerBalance'OneOf1 with all required fields.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf.properties.bank_transfer in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'CustomerBalance'OneOf1BankTransfer' with all required fields.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf.properties.bank_transfer.properties.eu_bank_transfer in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'CustomerBalance'OneOf1BankTransfer'EuBankTransfer' with all required fields.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.customer_balance.anyOf in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.konbini.anyOf in the specification.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'UsBankAccount'OneOf1 with all required fields.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf.properties.financial_connections in the specification.

Create a new PostInvoicesInvoiceRequestBodyPaymentSettings'PaymentMethodOptions'UsBankAccount'OneOf1FinancialConnections' with all required fields.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf.properties.financial_connections.properties.permissions.items in the specification.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf.properties.verification_method in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_options.properties.us_bank_account.anyOf in the specification.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_types.anyOf.items in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.payment_settings.properties.payment_method_types.anyOf in the specification.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.rendering_options.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyRenderingOptions'OneOf1 with all required fields.

Defines the enum schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.rendering_options.anyOf.properties.amount_tax_display in the specification.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.rendering_options.anyOf in the specification.

Options for invoice PDF rendering.

Defines the object schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf in the specification.

Create a new PostInvoicesInvoiceRequestBodyTransferData'OneOf1 with all required fields.

Defines the oneOf schema located at paths./v1/invoices/{invoice}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data.anyOf in the specification.

If specified, the funds from the invoice will be transferred to the destination and the ID of the resulting transfer will be found on the invoice's charge. This will be unset if you POST an empty value.

Represents a response of the operation postInvoicesInvoice.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostInvoicesInvoiceResponseError is used.