Notification kinds

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhookNotification.Kind for Payment Method webhooks will be one of the following:


The following table describes the conditions that trigger each kind of webhook.

Notification Type Description

A payment instrument that was previously enabled has been revoked by the customer.
Currently this webhook will only be sent when a customer cancels their PayPal billing agreement.


Kind enum

The kind of webhook notification.

Timestamp date

The UTC time at which the webhook was triggered.


Metadata referencing the revoked payment method.

Token string

An alphanumeric value that references a specific payment method stored in your Vault.

CustomerId string

A value representing an existing customer stored in your Vault. Use Customer: Find call to look up a single customer.


The PaymentMethod object associated with the revoked payment method.