---
schema_version: "1"
id: aab065948fdd4e2898cc125f822f76d8ea73e1c10d0ee9e13c9a4c5d9c656af3
title: PaymentLinkEvent
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_paymentlinkevent.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentlinkevent.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 2ad39e4e7e33f9f4ac79d0fc29581f618fb97141b065da0428299978e37e02ae
description: Represents a payment link platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later.
---
# PaymentLinkEvent

Represents a payment link platform event. Subscribe to these events so you can listen and respond to them when they’re published. For example, create a Salesforce Flow that is triggered when one of these events is published. This object is available in API version 59.0 and later.

For more information about platform events, see the [Platform Events Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.264.0.platform_events.meta/platform_events/platform_events_intro.htm "HTML (New Window)").

## Supported Calls

describeSObjects()

## Special Access Rules

To access Salesforce Payments objects, you must have a Salesforce Payments license and Payments must be enabled for your org. Salesforce Payments objects are available only in Lightning Experience.

## Fields

| Field | Details |
| --- | --- |
| ChangeType | 
Type

picklist

Properties

Restricted picklist

Description

Type of payment link event, which triggers and event notification.

Possible values are:

- Create–Payment link created.
- Delete–Payment link deleted.
- Update–Payment link property changed.





 |
| PaymentLinkId | 

Type

reference

Properties

Nillable

Description

Type of payment link event. You can write code to operate conditionally on the value of this field. For example, you can ignore a create change but get notified of updates.

This field is a relationship field.

Relationship Name

PaymentLink

Relationship Type

Lookup

Refers To

PaymentLink



 |