Skip to main content
PATCH
Update a payment link
Authenticate with an API key that belongs to the link’s organization and has Full access or the products:payment_links:write permission (Payment links under Can create and change in the dashboard). Only the Owner and Admin roles can grant it.
  • linkId is the ID of a payment link in your organization, such as an item returned by Get product payment links.
  • The body takes title, description and successUrl, all optional. Only the fields you send change.
  • successUrl is an absolute HTTPS URL. Send an empty string to clear it; the customer then sees the Anyway receipt.
  • Price, currency and billing can’t be changed. To sell at a different price, create a new payment link.
  • The response is the full updated link, whether it is active or not, with the same shape as an item from Get product payment links.
  • Unknown fields are rejected with 400. There is no Idempotency-Key for this endpoint.

Authorizations

X-API-Key
string
header
required

Merchant API key (format: ak_BASE64)

Path Parameters

Payment link ID

Body

application/json

Fields to change

title
string

New title shown on the pay page

Maximum string length: 255
description
string

New description shown on the pay page

Maximum string length: 2000
successUrl
string

Absolute HTTPS URL to send the customer to after paying. Send an empty string to clear it.

Maximum string length: 1000

Response

OK

data
object
error
object
message
string
success
boolean