API Reference · Payment Links

Update a payment link

Edits an existing payment link.

PATCH/v1/payment-links/:id

You can freely edit name, description, and collection fields. Changing `amount` or `currency` is rejected if the link has any successful payments — create a new link instead.

Returnspayment_link object

Path parameters

idstringRequired

Payment link id (`pl_…`).

Body parameters

namestring

New dashboard name.

descriptionstring

New customer-facing description.

statusstring

Flip the link to cancelled.

Allowed values: ACTIVE CANCELLED

amountinteger

New amount. Only allowed on links with zero payments.

quantity_limitinteger

New quantity cap.

expires_atinteger

New expiry timestamp.

metadataobject

Merged into existing metadata.

Errors

404

resource_missing

No payment link exists with that id.

409

amount_locked

Attempted to change amount/currency on a link with payments.

Request

curl -X PATCH https://lunipay.io/api/v1/payment-links/pl_01JRZKB6SDE2HVKX8WCTNY4FRG \
  -H "Authorization: Bearer sk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "CANCELLED" }'

Response

{
  "id": "pl_01JRZKB6SDE2HVKX8WCTNY4FRG",
  "object": "payment_link",
  "livemode": false,
  "type": "MULTI",
  "name": "April 2026 donation drive",
  "slug": "april-drive",
  "url": "https://lunipay.io/p/rentelio/april-drive",
  "status": "CANCELLED",
  "amount_cents": 2500,
  "currency": "usd",
  "description": "Suggested donation — every bit helps.",
  "customer_id": null,
  "collect_name": true,
  "collect_email": true,
  "collect_phone": false,
  "installment_enabled": false,
  "quantity_limit": null,
  "view_count": 318,
  "payment_count": 42,
  "total_collected_cents": 105000,
  "expires_at": null,
  "metadata": null,
  "created": 1713100800,
  "updated": 1713100800
}