POST /v1/invoices/{invoice}
Draft invoices are fully editable. Once an invoice is finalized,
monetary values, as well as collection_method
, become uneditable.
If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
sending reminders for, or automatically reconciling invoices, pass
auto_advance=false
.
Servers
- https://api.stripe.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
invoice |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
auto_advance |
Boolean | No |
Controls whether Stripe performs automatic collection of the invoice. |
discounts |
No |
The discounts that will apply to the invoice. Pass an empty string to remove previously-defined discounts. |
|
days_until_due |
Integer | No |
The number of days from which the invoice is created until it is due. Only valid for invoices where |
description |
String | No |
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. |
application_fee_amount |
Integer | No |
A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees documentation. |
metadata |
No |
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 |
|
collection_method |
String | No |
Either Possible values:
|
footer |
String | No |
Footer to be displayed on the invoice. |
on_behalf_of |
No |
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. |
|
default_tax_rates |
No |
The tax rates that will apply to any line item that does not have |
|
issuer |
Object | No |
The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. |
issuer.account |
String | No | |
issuer.type |
String | Yes |
Possible values:
|
statement_descriptor |
String | 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 |
custom_fields |
No |
A list of up to 4 custom fields to be displayed on the invoice. If a value for |
|
transfer_data |
No |
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. |
|
shipping_details |
No |
Shipping details for the invoice. The Invoice PDF will use the |
|
account_tax_ids |
No |
The account tax IDs associated with the invoice. Only editable when the invoice is a draft. |
|
number |
No |
Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. |
|
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
rendering |
Object | No |
The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. |
rendering.template |
String | No | |
rendering.pdf |
Object | No | |
rendering.pdf.page_size |
String | No |
Possible values:
|
rendering.template_version |
No | ||
rendering.amount_tax_display |
String | No |
Possible values:
|
automatic_tax |
Object | No |
Settings for automatic tax lookup for this invoice. |
automatic_tax.enabled |
Boolean | Yes | |
automatic_tax.liability |
Object | No | |
automatic_tax.liability.account |
String | No | |
automatic_tax.liability.type |
String | Yes |
Possible values:
|
shipping_cost |
No |
Settings for the cost of shipping for this invoice. |
|
automatically_finalizes_at |
Integer | No |
The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set |
payment_settings |
Object | No |
Configuration settings for the PaymentIntent that is generated when the invoice is finalized. |
payment_settings.default_mandate |
No | ||
payment_settings.payment_method_types |
No | ||
payment_settings.payment_method_options |
Object | No | |
payment_settings.payment_method_options.konbini |
No | ||
payment_settings.payment_method_options.customer_balance |
No | ||
payment_settings.payment_method_options.bancontact |
No | ||
payment_settings.payment_method_options.card |
No | ||
payment_settings.payment_method_options.us_bank_account |
No | ||
payment_settings.payment_method_options.acss_debit |
No | ||
payment_settings.payment_method_options.sepa_debit |
No | ||
default_payment_method |
String | 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 |
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. |
|
effective_at |
No |
The date when this invoice is in effect. Same as |
|
due_date |
Integer | No |
The date on which payment for this invoice is due. Only valid for invoices where |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.