payment_link.canceled

{ "event": "payment_link.canceled", "timestamp": "2026-06-23T14:30:00.000Z", "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f", "mode": "live", "apiVersion": "2026-08-27", "data": { "paymentId": "pay_l1m2n3", "status": "canceled", "amount": 5000, "currency": "usd", "description": "One-time onboarding fee", "customerId": "user_123" } }

When this fires

When a pending payment link is canceled before the customer pays it. A canceled link can no longer be paid.

Payment links never expire on their own — there is no expiry event. A link stays payable until it is paid or explicitly canceled.

The event fires the same way regardless of which payment provider processes the charge.

Body

application/json

string

required

event

string

required

Allowed value: "payment_link.canceled"

timestamp

string

required

organizationId

string

required

mode

enum<string>

required

Available options:

live,

sandbox

apiVersion

string

required

data

object

required

Show child attributes

Response

200

Return any 2xx status code to acknowledge receipt of the event.

Overview

Events

payment_link.canceled

When this fires

Body

Response

​When this fires

Body

Response

When this fires