Update an invoice's line item
POST {{baseUrl}}/v1/invoices/:invoice/lines/:line_item_id
Updates an invoice’s line item. Some fields, such as tax_amounts
, only live on the invoice line item,
so they can only be updated through this endpoint. Other fields, such as amount
, live on both the invoice
item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
Updating an invoice’s line item is only possible before the invoice is finalized.
Request Body
[{"name"=>"amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"description", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discountable", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"discounts[0][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][discount]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[0][promotion_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][coupon]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][discount]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"discounts[1][promotion_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"period[end]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"period[start]", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"price", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[currency]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product_data][name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product_data][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product_data][images][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product_data][images][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[product_data][metadata]", "value"=>"<object>", "datatype"=>"string"}, {"name"=>"price_data[product_data][tax_code]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[tax_behavior]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"price_data[unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"price_data[unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"quantity", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][display_name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][inclusive]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][percentage]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][jurisdiction]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][tax_rate_data][tax_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[0][taxable_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][display_name]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][inclusive]", "value"=>"<boolean>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][percentage]", "value"=>"<number>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][country]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][jurisdiction]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][state]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][tax_rate_data][tax_type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_amounts[1][taxable_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"tax_rates[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"tax_rates[1]", "value"=>"<string>", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |