Skip to main content
GET
Get a payment link

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Response

Success.

id
string<uuid>
required
url
string<uri>
required

The checkout URL to send the customer to.

type
enum<string>
required
Available options:
PRODUCT_BASED,
FIXED_AMOUNT,
SUBSCRIPTION,
FLEXIBLE_AMOUNT
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
archived
boolean
version
integer

Revision counter, bumped by every edit.

title
string | null
description
string | null
amount
number | null

Null on product-based links, where the total comes from the products.

currency
string | null
currentUsage
integer | null
maxUsage
integer | null
calculateTaxes
boolean
requestShippingAddress
boolean
requestPhoneNumber
boolean
allowPromotionCodes
boolean
callToActionMessage
string | null
onSuccessAction
string | null
redirectUrl
string | null
customConfirmationMessage
string | null
allowedTerms
integer[] | null

The installment plans the checkout offers, as numbers of monthly installments (1 is a single payment). null offers every plan active on your account. Always null on SUBSCRIPTION links, which are charged in a single payment every cycle.

Example:
billingPeriod
string | null

Subscription links only.

subscriptionDurationType
string | null

Subscription links only.

fixedBillingCycles
integer | null

Subscription links only.

trialPeriodValue
integer | null

Subscription links only.

trialPeriodUnit
string | null

Subscription links only.

createdAt
string<date-time>
updatedAt
string<date-time>
fields
object[]
products
object[]