Billing · Paylinks
Update paylink
Changes only the fields you send. To stop a link taking payments, send isActive: false. A paylink of the other mode (environment) answers 404.
Authorization
HeaderSend Authorization: Bearer <accessToken>, the token from Create token.
Path parameters
id string Required
The paylink’s id, not its shortCode.Body parameters
isActive boolean
false switches the link off: its page says it is no longer active and checkout answers 400 PAYLINK_INACTIVE. true turns it back on.title string
Shown on the payment page. Up to 120 characters.description string
Shown to the payer.amount number
In major units, e.g. 249.00. Can’t change once the link is paid or while a bank payment on it is clearing.currency string
USD, EUR, GBP, CAD, AUD, AED, SGD, INR, BDT or BRL. A subscription link keeps its price’s currency.dueDate date-time
Expire At, ISO 8601. A date with no time lasts to the end of that day (UTC). Move it later, or send null to clear it, and an expired link takes payments again.status enum
PENDING, EXPIRED or CANCELLED. Only PENDING links take payments, and a PENDING link past its dueDate reads EXPIRED. You can’t set PAID: a link becomes PAID when it’s paid, and then its status can’t be changed (400).clientId string
One of your clients, as the payer. null detaches the client.metadata object
Your own JSON object. Replaces the stored metadata.