Billing · Paylinks
Create paylink
Creates a paylink and returns its shortCode. Share https://user.vezmo.com/checkout/payments-links/{shortCode} with your customer to collect the payment.
environment is LIVE or TEST: the mode of the key that made the paylink. It never changes. A TEST key makes a sandbox paylink; see Test mode.
Authorization
HeaderSend Authorization: Bearer <accessToken>, the token from Create token.
Body parameters
title string Required
Shown on the payment page. Up to 120 characters.amount number Required
In major units, e.g. 199.99. At least the smallest amount that can be charged in the currency. Not needed with productId.currency string
USD (default), EUR, GBP, CAD, AUD, AED, SGD, INR, BDT or BRL.description string
Shown to the payer.dueDate date-time
Expire At, ISO 8601: the link stops taking new payments then. A date with no time lasts to the end of that day (UTC). After it the link reads EXPIRED and checkout answers 400 PAYLINK_EXPIRED. Leave it out for a link that never expires.clientId string
One of your clients, as the payer. Leave it out and the page asks the payer for their name and email.productId string
A recurring product. Makes a reusable subscribe link at the product’s price; amount and currency are ignored.billingPlanId string
With productId: another of the product’s prices. Default: its default price.quantityAdjustable boolean
With productId: let the subscriber choose a quantity. Default false.quantityMin number
Smallest quantity, 1 to 100000. Default 1.quantityMax number
Largest quantity, 1 to 100000. Default: quantityMin.