Create Invoice

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 64

Client reference of the customer

uuid

Unique identifier for the customer

billing_information
object

Billing information for the customer

string
enum
required

Currency of the invoice

string
length ≤ 1024

Optional Terms and conditions for the invoice

string
length ≤ 1024

Notes for the invoice

string
length ≤ 1024

Description of the invoice

date-time

Due date of the invoice

number | null
≥ 0

Shipping amount of the invoice in minor units (kobo, cents, etc)

discount

Apply discounts to the invoice. Choose between:

Fixed Discount: Subtract a specific amount in minor units
Percentage Discount: Subtract a percentage from the total (0-100%)

All monetary amounts are in minor currency units (cents, kobo, etc.)

tax
required

Configure how taxes are calculated for this invoice item. Choose the appropriate method based on your tax requirements:

Fixed Tax: Apply a specific tax amount in minor currency units. Best for flat fees, processing charges, or regulatory fees that don't vary with item value.

Percentage Tax: Apply a percentage-based tax rate. Best for standard VAT, GST, sales tax, or any tax calculated as a percentage of the item value.

All monetary amounts must be specified in minor currency units (cents for USD, kobo for NGN, etc.).

settings
object

Settings for the invoice

settlement_account
object

How you want this invoice to be paid

items
array
length between 0 and 50
Defaults to []

Items in the invoice

Invoice Line Items
boolean
Defaults to false

Whether to finalize the invoice after creation

metadata
object | null

Optional metadata for the invoice

payment_instructions
array of objects | null
Defaults to []
payment_instructions
Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json