POST
/
v1
/
invoices

Authorizations

​
X-API-KEY
string
headerrequired

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
​
items
object[]
required

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

​
customer
string
required

Customer ID, Get the customer id from /customer api

​
title
string
required

Invoice title

Maximum length: 50
​
due_date
string
required

Invoice due date

​
discount_percentage
integer
default: 0

Discount percentage.

Required range: 0 < x < 100
​
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

​
custom_fields
object[] | null

Custom fields to add. Maximum of 5 allowed

​
success_url
string

URL to redirect to upon successful transaction completion

​
failure_url
string

URL to redirect to if the transaction fails.

Response

201 - application/json
​
id
string
required
​
reference_id
string
required
​
created
string
required
​
title
string
required
​
code
string
required
​
url
string
required

URL of the link or invoice,

​
amount
string
required
​
currency
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
​
discount
string
required
​
tax
string
required
​
shipping_address_required
boolean
required
​
items
object[]
required
​
note
string
required
​
expiry
string
required
​
user
object
required
​
tip
string
required
​
invoice_number
string
required
​
service_date
string
required
​
due_date
string
required
​
interval_count
integer
required
​
starts_at
string
required
​
ends_at
string
required
​
due_days
integer
required
​
files
object[]
required
​
reminders
object[]
required
​
events
object[]
required
​
customer
object
required
​
discount_percentage
string | null
​
tip_percentage
string | null
​
custom_fields
object[]
​
success_url
string

Redirects to the success URL after the invoice is completed.

​
failure_url
string

Redirects to the failure URL if the invoice payment fails.

List InvoicesGet Invoice