# PostInvoiceitemsInvoiceitem From **Stripe API**. `POST /v1/invoiceitems/{invoiceitem}`

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.

## Parameters ### `invoiceitem` - Location: path - Required: true - Type: `string` - maxLength: `5000` ## Request body - Required: false ### `application/x-www-form-urlencoded` - Type: `object` ```json {"additionalProperties":false,"properties":{"amount":{"description":"The integer amount in %s of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.","type":"integer"},"description":{"description":"An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.","maxLength":5000,"type":"string"},"discountable":{"description":"Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.","type":"boolean"},"discounts":{"anyOf":[{"items":{"properties":{"coupon":{"maxLength":5000,"type":"string"},"discount":{"maxLength":5000,"type":"string"}},"title":"discounts_data_param","type":"object"},"type":"array"},{"enum":[""],"type":"string"}],"description":"The coupons \u0026 existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts."},"expand":{"description":"Specifies which fields in the response should be expanded.","items":{"maxLength":5000,"type":"string"},"type":"array"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"enum":[""],"type":"string"}],"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`."},"period":{"description":"The period associated with this invoice item.","properties":{"end":{"format":"unix-time","type":"integer"},"start":{"format":"unix-time","type":"integer"}},"required":["end","start"],"title":"period","type":"object"},"price":{"description":"The ID of the price object.","maxLength":5000,"type":"string"},"price_data":{"description":"Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.","properties":{"currency":{"type":"string"},"product":{"maxLength":5000,"type":"string"},"tax_behavior":{"enum":["exclusive","inclusive","unspecified"],"type":"string"},"unit_amount":{"type":"integer"},"unit_amount_decimal":{"format":"decimal","type":"string"}},"required":["currency","product"],"title":"one_time_price_data","type":"object"},"quantity":{"description":"Non-negative integer. The quantity of units for the invoice item.","type":"integer"},"tax_rates":{"anyOf":[{"items":{"maxLength":5000,"type":"string"},"type":"array"},{"enum":[""],"type":"string"}],"description":"The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates."},"unit_amount":{"description":"The integer unit amount in %s of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.","type":"integer"},"unit_amount_decimal":{"description":"Same as `unit_amount`, but accepts a decimal value in %s with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.","format":"decimal","type":"string"}},"type":"object"} ``` ## Security ### `basicAuth` - Type: `http` - Request header: `Authorization` - Scheme: `basic` Send credentials in the `Authorization` request header using the `Basic` scheme. Basic HTTP authentication. Allowed headers-- Authorization: Basic | Authorization: Basic ### `bearerAuth` - Type: `http` - Request header: `Authorization` - Scheme: `bearer` - Bearer format: `auth-scheme` Send the token in the `Authorization` request header using the `Bearer` scheme. Bearer HTTP authentication. Allowed headers-- Authorization: Bearer ## Responses ### `200` Successful response. ### `application/json` - Type: `object` Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. Related guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). ```json {"description":"Sometimes you want to add a charge or credit to a customer, but actually\ncharge or credit the customer's card only at the end of a regular billing\ncycle. This is useful for combining several charges (to minimize\nper-transaction fees), or for having Stripe tabulate your usage-based billing\ntotals.\n\nRelated guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).","properties":{"amount":{"description":"Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.","type":"integer"},"currency":{"description":"Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).","type":"string"},"customer":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/customer"},{"$ref":"#/components/schemas/deleted_customer"}],"description":"The ID of the customer who will be billed when this invoice item is billed.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/customer"},{"$ref":"#/components/schemas/deleted_customer"}]}},"date":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users.","maxLength":5000,"nullable":true,"type":"string"},"discountable":{"description":"If true, discounts will apply to this invoice item. Always false for prorations.","type":"boolean"},"discounts":{"description":"The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.","items":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/discount"}],"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/discount"}]}},"nullable":true,"type":"array"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"invoice":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/invoice"}],"description":"The ID of the invoice this invoice item belongs to.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/invoice"}]}},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","nullable":true,"type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["invoiceitem"],"type":"string"},"period":{"$ref":"#/components/schemas/invoice_line_item_period"},"price":{"anyOf":[{"$ref":"#/components/schemas/price"}],"description":"The price of the invoice item.","nullable":true},"proration":{"description":"Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.","type":"boolean"},"quantity":{"description":"Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.","type":"integer"},"subscription":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/subscription"}],"description":"The subscription that this invoice item has been created for, if any.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/subscription"}]}},"subscription_item":{"description":"The subscription item that this invoice item has been created for, if any.","maxLength":5000,"type":"string"},"tax_rates":{"description":"The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.","items":{"$ref":"#/components/schemas/tax_rate"},"nullable":true,"type":"array"},"unit_amount":{"description":"Unit amount (in the `currency` specified) of the invoice item.","nullable":true,"type":"integer"},"unit_amount_decimal":{"description":"Same as `unit_amount`, but contains a decimal value with at most 12 decimal places.","format":"decimal","nullable":true,"type":"string"}},"required":["amount","currency","customer","date","discountable","id","livemode","object","period","proration","quantity"],"title":"InvoiceItem","type":"object","x-expandableFields":["customer","discounts","invoice","period","price","subscription","tax_rates"],"x-resourceId":"invoiceitem"} ``` ### `default` Error response. ### `application/json` - Type: `object` An error response from the Stripe API ```json {"description":"An error response from the Stripe API","properties":{"error":{"$ref":"#/components/schemas/api_errors"}},"required":["error"],"type":"object"} ``` ## Request examples ### cURL ```shell curl --request POST \ --url https://api.stripe.com/v1/invoiceitems/{invoiceitem} \ --header 'content-type: application/x-www-form-urlencoded' \ --data '{ "amount": 1, "description": "string", "discountable": true, "discounts": "string", "expand": [ "string" ], "metadata": "string", "period": { "end": 1, "start": 1 }, "price": "string", "price_data": { "currency": "string", "product": "string", "tax_behavior": "string", "unit_amount": 1, "unit_amount_decimal": "string" }, "quantity": 1, "tax_rates": "string", "unit_amount": 1, "unit_amount_decimal": "string" }' ```