POST
/
v1
/
invoices

Headers

X-BUSINESS-API-KEY
string
required

Body

application/json
amount
number
required

Invoice amount, only required for payment by amount

currency
string
required

Invoice currency

invoice_date
string
required

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

payment_by
string
required

Payment is by product or amount

allow_partial_payments
string
default:
0

allow partial payment of invoice (0 or 1)

auto_invoice_number
string

auto_invoice_number

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

Invoice Footer

invoice_number
string

Invoice Number, required if auto_invoice_number set 0

partial_payments
object[]
products
object[]
recipients
object[]
reference
string

Invoice Description

send_email
integer
default:
0

HitPay to send email receipts to the customer. Default value is 0

stackable_discounts
object[]
subtotal
number

The subtotal field is required when payment by is amount.

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