Skip to main content
PATCH
Update Paylink

Authorizations

X-API-KEY
string
header
required

Path Parameters

Unique payment link identifier (plink_...)

Body

application/json

Update paylink request

after_completion
object

Checkout behaviour after payment or when the link expires. Takes precedence over metadata.after_completion.

enabled
boolean

Whether the payment link is enabled.

metadata
object

Payment link metadata and checkout settings.

plan
object

Plan fields to update on this payment link.

Response

OK

data
object

Response payload when the request succeeded.

error
boolean

True when the request failed.

message
string

Human-readable status or error message.