GET
/
v1
/
links
/
{uuid}

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

Response

200 - application/json
allow_tip
boolean
required
amount
string
required
currency
string
required
custom_fields
object[]
required
discount
string
required
discount_percentage
integer
required
id
string
required
items
object[]
required
note
string
required
shipping_address_required
boolean
required
status
enum<string>
required
  • paid - paid
  • unpaid - unpaid
  • overdue - overdue
  • cancelled - cancelled
  • scheduled - scheduled
Available options:
paid,
unpaid,
overdue,
cancelled,
scheduled
tax
string
required
taxes
object[]
required
tip
string
required
tip_percentage
integer
required
title
string
required
url
string
required