PATCH
/
v1
/
invoices
/
{uuid}
/
edit

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

Path Parameters

​
uuid
string
required

Body

application/json
​
status
enum<string>
  • cancelled - Cancelled
Available options:
cancelled
​
title
string

Craft a beautiful name for your link

Maximum length: 50

Response

200 - 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
​
id
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