Webhooks events for Billing Agreements

Last updated: Aug 15th, 7:41am

Note: The Billing Agreements API and its webhooks are in limited release.

The Billing Agreements API creates an agreement for a recurring PayPal or debit card payment for goods or services.

This integration includes 2 webhook events:

Event	Trigger	Related method
`BILLING_AGREEMENTS.AGREEMENT.CREATED`	A reference transaction agreement is created.	Create agreement
`BILLING_AGREEMENTS.AGREEMENT.CANCELLED`	A reference transaction agreement is cancelled.	Cancel agreement

Make a POST call to the Webhooks API to subscribe to Billing Agreement webhook events:

1curl -v -X POST https://api-m.paypal.com/v1/notifications/webhooks -H 'Content-Type: application/json' -H 'PayPal-Request-Id: UNIQUE-CALL-ID' -H 'Authorization: Bearer PARTNER-ACCESS-TOKEN' -H 'PayPal-Partner-Attribution-Id: BN-CODE' -d '[
2  {
3    "url": "https://example.com/example_webhook",
4    "event _types": [
5      {
6      "name": "BILLING_AGREEMENTS.AGREEMENT.CREATED"
7      },
8      {
9      "name": "BILLING_AGREEMENTS.AGREEMENT.CANCELLED"
10      }
11    ]
12  }
13]'

More information

Webhooks v1 API

Webhooks for billing plans and subscriptions

Webhooks events for Billing Agreements

Subscribe to billing agreement webhooks

More information