Subscriptions webhooks

DocsCurrent


A webhook is an HTTP callback that receives notification messages for events. See configure webhooks for more details.

PayPal APIs use webhooks for event notification. Most subscription-related actions trigger webhook events:

WebhookTriggerRelated method
CATALOG.PRODUCT.CREATEDA product is created.Create product
CATALOG.PRODUCT.UPDATEDA product is updated.Update product
PAYMENT.SALE.COMPLETEDA payment is made on a subscription.
PAYMENT.SALE.REFUNDEDA merchant refunds a sale.
PAYMENT.SALE.REVERSEDA payment is reversed on a subscription.
BILLING.PLAN.CREATEDA billing plan is created.Create plan
BILLING.PLAN.UPDATEDA billing plan is updated.Update plan
BILLING.PLAN.ACTIVATEDA billing plan is activated.Activate plan
BILLING.PLAN.PRICING-CHANGE.ACTIVATEDA price change for the plan is activated.Update pricing
BILLING.PLAN.DEACTIVATEDA billing plan is deactivated.Deactivate plan
BILLING.SUBSCRIPTION.CREATEDA subscription is created.Create subscription
BILLING.SUBSCRIPTION.ACTIVATEDA subscription is activated.Activate subscription
BILLING.SUBSCRIPTION.UPDATEDA subscription is updated.Update subscription
BILLING.SUBSCRIPTION.EXPIREDA subscription expires.Show subscription details
BILLING.SUBSCRIPTION.CANCELLEDA subscription is cancelled.Cancel subscription
BILLING.SUBSCRIPTION.SUSPENDEDA subscription is suspended.Suspend subscription
BILLING.SUBSCRIPTION.PAYMENT.FAILEDPayment failed on subscription.Subscription failed payment details