Create Invoice

Authorizations

X-API-KEY

string

header

required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Body

application/json

currency

string

required

ISO 4217 currency code for the link. Retrieve codes from the /currencies endpoint.

Maximum length: 3

customer

string

required

Customer ID, Get the customer id from /customer api

due_date

string

required

Invoice due date

items

object[]

required

List of items associated with this link, including name and amount.

title

string

required

Invoice title

Maximum length: 50

custom_fields

object[] | null

Custom fields to add. Maximum of 5 allowed

discount_percentage

integer

default:

Discount percentage.

Required range: 0 < x < 100

failure_url

string

URL to redirect to if the transaction fails.

invoice_number

string

Invoice number

Maximum length: 30

note

string | null

A note to describle what you're selling

Maximum length: 280

shipping_address_required

boolean

default:

false

Whether shipping address is required.

starts_at

string

Invoice start date

success_url

string

URL to redirect to upon successful transaction completion

Response

201 - application/json

amount

string

required

code

string

required

created

string

required

currency

string

required

customer

object

required

discount

string

required

due_date

string

required

due_days

integer

required

ends_at

string

required

events

object[]

required

expiry

string

required

files

object[]

required

string

required

interval_count

integer

required

invoice_number

string

required

items

object[]

required

note

string

required

reference_id

string

required

reminders

object[]

required

service_date

string

required

shipping_address_required

boolean

required

starts_at

string

required

status

enum<string>

required

enabled - Enabled
disabled - disabled
archived - Archived
paid - Paid
unpaid - Unpaid
overdue - Overdue
cancelled - Cancelled
scheduled - Scheduled

Available options:

enabled,

disabled,

archived,

paid,

unpaid,

overdue,

cancelled,

scheduled

tax

string

required

tip

string

required

title

string

required

url

string

required

URL of the link or invoice,

user

object

required

custom_fields

object[]

discount_percentage

string | null

failure_url

string

Redirects to the failure URL if the invoice payment fails.

success_url

string

Redirects to the success URL after the invoice is completed.

tip_percentage

string | null