---
title: "Update the invoice"
method: PUT
path: "/v1/invoices/{invoice_id}"
---

# Update the invoice

`PUT /v1/invoices/{invoice_id}`

Update the invoice

## Path parameters

- `invoice_id` string, required

## Headers

- `X-BUSINESS-API-KEY` string, required

## Request body

- object
  - `customer` object
    - `name` string — Customer's name. It's required field when customer id is not present.
    - `email` string — Customer's email. It's required field when customer id is not present.
    - `address` object
      - `name` string
      - `city` string
      - `state` string
      - `postal_code` string
      - `country` string
  - `customer_id` string — Customer id and it's required field if the customer's email and name are not present/
  - `invoice_date` string, required — The format(Y-m-d) is 2024-12-21
  - `due_date` string — Invoice Due Date, format Y-m-d. Example: 2024-12-21
  - `auto_invoice_number` string — auto_invoice_number
  - `invoice_number` string — Invoice Number, required if auto_invoice_number set 0
  - `currency` string, required — Invoice currency
  - `payment_methods` string[] — The available payment methods support on your account and currency.
  - `amount` number, double, required — Invoice amount, only required for payment by amount
  - `subtotal` number, double — The subtotal field is required when payment by is amount.
  - `payment_by` string, required — Payment is by product or amount
  - `tax_setting` string — Tax id
  - `send_email` integer — HitPay to send email receipts to the customer. Default value is 0
  - `webhook` string — Optional URL value to which HitPay will send a POST request when there is a new charge or if there is an error charging the card
  - `reference` string — Invoice Description
  - `footer` string — Invoice Footer
  - `allow_partial_payments` string — allow partial payment of invoice (0 or 1)
  - `partial_payments` object[]
    - `amount` integer — It's required field if allow_partial_payments = 1
    - `due_date` string — It's required field if allow_partial_payments = 1
  - `products` object[]
    - `product_id` string, required — It's required field if payment_by = product
    - `quantity` string — It's required field if payment_by = product
    - `variation_id` string — It's required field if payment_by = product
    - `discount` string — It's required field if payment_by = product
  - `stackable_discounts` object[]
    - `name` string, required — Discount name. Max 255 chars
    - `discount` string, required — Discount value >= 0
    - `percentage_discount` string, required — Discount percentage must be between 0 and 1.
    - `order` string, required — The order of discount
  - `recipients` object[]
    - `email` string — The email address. The user can user either email or customer for recipients
    - `customer_id` string — The customer id

## Response `200`

200

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/versions/6aae1a736990/schema)