PUT
/
v1
/
invoices
/
{invoice_id}
curl --request PUT \
  --url https://api.sandbox.hit-pay.com/v1/invoices/{invoice_id} \
  --header 'Content-Type: application/json' \
  --header 'X-BUSINESS-API-KEY: <x-business-api-key>' \
  --data '{
  "customer": {
    "name": "<string>",
    "email": "<string>",
    "address": {
      "name": "160 Paya Lebar Road 07-08 Orion Industrial ",
      "city": "Singapore",
      "state": "Singapore",
      "postal_code": "367903",
      "country": "sg"
    }
  },
  "customer_id": "<string>",
  "invoice_date": "<string>",
  "due_date": "<string>",
  "auto_invoice_number": "<string>",
  "invoice_number": "<string>",
  "currency": "<string>",
  "amount": 123,
  "subtotal": 123,
  "payment_by": "<string>",
  "tax_setting": "<string>",
  "send_email": 0,
  "webhook": "<string>",
  "reference": "<string>",
  "footer": "<string>",
  "allow_partial_payments": 0,
  "partial_payments": [
    {
      "amount": 0,
      "due_date": "<string>"
    }
  ],
  "products": [
    {
      "product_id": "<string>",
      "quantity": "<string>",
      "variation_id": "<string>",
      "discount": "<string>"
    }
  ],
  "stackable_discounts": [
    {
      "name": "<string>",
      "discount": "<string>",
      "percentage_discount": "<string>",
      "order": "<string>"
    }
  ],
  "recipients": [
    {
      "email": "<string>",
      "customer_id": "<string>"
    }
  ]
}'

Headers

​
X-BUSINESS-API-KEY
string
required
Example:

"b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d"

Path Parameters

​
invoice_id
string
required

It's required field

Body

application/json
​
invoice_date
string
required

The format(Y-m-d) is 2024-12-21

​
currency
string
required

Invoice currency

​
amount
number
required

Invoice amount, only required for payment by amount

​
payment_by
string
required

Payment is by product or amount

​
customer
object
​
customer_id
string

Customer id and it's required field if the customer's email and name are not present/

​
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

​
subtotal
number

The subtotal field is required when payment by is amount.

​
tax_setting
string

Tax id

​
send_email
integer
default:0

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
default:0

allow partial payment of invoice (0 or 1)

​
partial_payments
object[]
​
products
object[]
​
stackable_discounts
object[]
​
recipients
object[]

Was this page helpful?