Webhooks events for Billing Agreements
Last updated: Aug 15th, 6:02am
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 |
Subscribe to billing agreement webhooks
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 -H2 'Content-Type: application/json' -H 'PayPal-Request-Id: UNIQUE-CALL-ID' -H3 'Authorization: Bearer PARTNER-ACCESS-TOKEN' -H4 'PayPal-Partner-Attribution-Id: BN-CODE' -d '[ { "url":5 "https://example.com/example_webhook", "event _types": [ { "name":6 "BILLING_AGREEMENTS.AGREEMENT.CREATED" }, { "name":7 "BILLING_AGREEMENTS.AGREEMENT.CANCELLED" } ] } ]'
More information
- Webhooks v1 API
- Webhooks for billing plans and subscriptions