POST
/
v1
/
links

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.

​
title
string
required

Craft a beautiful name for your link

Maximum length: 50
​
note
string | null

Type out a quick note describing what you're selling

Maximum length: 280
​
discount_percentage
integer
default: 0

Discount percentage.

Required range: 0 < x < 100
​
shipping_address_required
boolean
default: false

Whether shipping address is required.

​
allow_tip
boolean
default: false

Allow tips.

​
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
​
title
string
required
​
url
string
required
​
amount
string
required
​
currency
string
required
​
status
enum<string>
required
  • paid - paid
  • unpaid - unpaid
  • overdue - overdue
  • cancelled - cancelled
  • scheduled - scheduled
Available options:
paid,
unpaid,
overdue,
cancelled,
scheduled
​
discount
string
required
​
allow_tip
boolean
required
​
shipping_address_required
boolean
required
​
items
object[]
required
​
tax
string
required
​
note
string
required
​
taxes
object[]
required
​
discount_percentage
integer
required
​
tip
string
required
​
tip_percentage
integer
required
​
custom_fields
object[]
required
List LinksGet Link