POST /v1/invoices/{invoice}/update_lines

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.

Servers

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
invoice_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 metadata. For type=subscription line items, the incoming metadata specified on the request is directly used to set this value, in contrast to type=invoiceitem line items, where any existing metadata on the invoice line is merged with the incoming data.

expand[] Array No

Specifies which fields in the response should be expanded.

lines[] Array Yes

The line items to update.

lines[].id String Yes
lines[].discounts No
lines[].pricing Object No
lines[].pricing.price String No
lines[].description String No
lines[].tax_amounts No
lines[].tax_rates No
lines[].period Object No
lines[].period.end Integer Yes
lines[].period.start Integer Yes
lines[].amount Integer No
lines[].discountable Boolean No
lines[].price_data Object No
lines[].price_data.unit_amount Integer No
lines[].price_data.unit_amount_decimal String No
lines[].price_data.product String No
lines[].price_data.tax_behavior String No

Possible values:

  • "inclusive"
  • "unspecified"
  • "exclusive"
lines[].price_data.currency String Yes
lines[].price_data.product_data Object No
lines[].price_data.product_data.name String Yes
lines[].price_data.product_data.description String No
lines[].price_data.product_data.tax_code String No
lines[].price_data.product_data.images[] Array No
lines[].price_data.product_data.metadata Object No
lines[].quantity Integer No
lines[].metadata No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.