Invoice
Update the invoice
Update the invoice
PUT
/v1/invoices/{invoice_id}
X-BUSINESS-API-KEY*
X-Requested-With
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 '{
"amount": 0,
"currency": "<currency>",
"customer_email": "<customer_email>",
"customer_name": "<customer_name>",
"invoice_date": "<invoice_date>",
"payment_by": "<payment_by>"
}'
Authorizations
X-BUSINESS-API-KEYheaderrequired
string
Headers
X-Requested-With
Default: "XMLHttpRequest"string
Path Parameters
invoice_idrequired
string
It's required field
Body
application/json
allow_partial_payments
string
allow partial payment of invoice (0 or 1)
amountrequired
number
Invoice amount, only required for payment by amount
auto_invoice_number
string
auto_invoice_number
currencyrequired
string
Invoice currency
customer_emailrequired
string
Customer's name
customer_namerequired
string
Customer's email
due_date
string
Invoice Due Date, format d/m/Y. Example: 31/12/2022
footer
string
Invoice Footer
invoice_daterequired
string
The format is 31/12/2022
invoice_number
string
Invoice Number, required if auto_invoice_number set 0
partial_payments
object
payment_byrequired
string
Payment is by product or amount
products
object
reference
string
Invoice Description
send_email
Default: "0"integer
Hitpay to send email receipts to the customer. Default value is 0
stackable_discounts
object
tax_setting
string
Tax id
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
Response
200
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 '{
"amount": 0,
"currency": "<currency>",
"customer_email": "<customer_email>",
"customer_name": "<customer_name>",
"invoice_date": "<invoice_date>",
"payment_by": "<payment_by>"
}'