Update a payment link.

PATCH

/v1/payment-links/{id}

curl --request PATCH \
  --url https://api.ridleypay.com/v1/payment-links/41 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "Deposit for order 1042", "description": "Balance due on delivery.", "amount": 2500, "active": false, "success_url": "https://example.com/thanks", "cancel_url": "https://example.com/cart", "max_uses": 1, "expires_at": "2026-12-31T23:59:59Z", "taxable": true, "recurring": null, "metadata": { "order_id": "1042" } }'

Send only the fields to change. Set active to false to turn the link off; its payments are kept.

Authorizations

• default

Parameters

Path Parameters

id

required

integer

The payment link ID.

Example

41

Request Body

Media typeapplication/json

object

title

Shown to the customer on the checkout page. Must not be greater than 255 characters.

string

Example

Deposit for order 1042

description

More detail shown under the title. Must not be greater than 5000 characters.

string

nullable

Example

Balance due on delivery.

amount

The amount to charge. Required unless you pass products. Must be at least 0.01. Must not be greater than 999999.99.

number

Example

2500

active

Turn the link off (false) or back on (true).

boolean

Example

false

success_url

Where to send the customer after paying. Must be a valid URL. Must not be greater than 2048 characters.

string

nullable

Example

https://example.com/thanks

cancel_url

Where to send the customer if they cancel. Must be a valid URL. Must not be greater than 2048 characters.

string

nullable

Example

https://example.com/cart

max_uses

Turn the link off after this many payments. Use 1 for a one-off link. Must be at least 1.

integer

nullable

Example

1

expires_at

Turn the link off at this time (ISO 8601). Must be a valid date. Must be a date after now.

string

nullable

Example

2026-12-31T23:59:59Z

taxable

Add tax from your team’s tax settings on top of the amount. Defaults to false, so the customer pays exactly the amount.

boolean

nullable

Example

true

recurring

Bill the customer on a schedule after the first payment.

object

frequency

Daily, weekly, monthly or yearly. This field is required when recurring is present.

string

Allowed values: daily weekly monthly yearly

Example

monthly

interval_count

For example 3 with monthly bills every 3 months. Must be at least 1. Must not be greater than 365.

integer

nullable

Example

1

end_date

Stop billing after this date. Must be a valid date. Must be a date after today.

string

nullable

Example

2027-06-30

Example

null

metadata

Up to 50 keys of your own data. Copied onto every payment made with the link and included in its webhooks. Must not have more than 50 items.

object

Example

{
  "order_id": "1042"
}

Responses