{
  "generated_from": "hookdeck/webhook-registry",
  "registry_commit": "a24c8d9784c9e9fe937c63f76adbce108201378f",
  "registry_committed_at": "2026-11-19T08:56:09Z",
  "disclaimer": "Independent reference. Not affiliated with PayPal.",
  "vendor": "paypal",
  "event": "BILLING.SUBSCRIPTION.CANCELLED",
  "resource": "subscription",
  "url": "https://hookdeck.com/webhooks/paypal/events#BILLING.SUBSCRIPTION.CANCELLED",
  "description": "Subscription or billing agreement gets cancelled",
  "trigger": null,
  "listed_in": "https://developer.paypal.com/api/rest/webhooks/event-names/#subscriptions",
  "confidence": "verified",
  "schema_source": "from a captured delivery",
  "identified_by": "event_type field in the body",
  "payload": {
    "provenance": "sample-repo",
    "value_realism": "real-shape-redacted-values",
    "field_count": 75,
    "key_fields": [
      {
        "path": "id",
        "type": "string",
        "example": "WH-6TD369808N914414D-1YJ376786E892292F"
      }
    ],
    "delivery": {
      "title": "Seen in a captured delivery",
      "content_type": "application/json",
      "headers": [
        "user-agent",
        "cal_poolstack",
        "client_pid",
        "content-type",
        "correlation-id",
        "paypal-auth-algo",
        "paypal-auth-version",
        "paypal-cert-url",
        "paypal-transmission-id",
        "paypal-transmission-time",
        "x-b3-spanid"
      ]
    },
    "body": {
      "id": "WH-6TD369808N914414D-1YJ376786E892292F",
      "event_version": "1.0",
      "create_time": "2016-04-28T11:53:10Z",
      "resource_type": "Agreement",
      "event_type": "BILLING.SUBSCRIPTION.CANCELLED",
      "summary": "A billing subscription was cancelled",
      "resource": {
        "id": "I-PE7JWXKGVN0R",
        "shipping_address": {
          "recipient_name": "Jane Doe",
          "line1": "3rd st",
          "line2": "cool",
          "city": "San Jose",
          "state": "CA",
          "postal_code": "95112",
          "country_code": "US"
        },
        "plan": {
          "curr_code": "USD",
          "links": [],
          "payment_definitions": [
            {
              "type": "TRIAL",
              "frequency": "Month",
              "frequency_interval": "1",
              "amount": {
                "value": "5.00"
              },
              "cycles": "5",
              "charge_models": [
                {
                  "type": "TAX",
                  "amount": {
                    "value": "1.00"
                  }
                },
                {
                  "type": "SHIPPING",
                  "amount": {
                    "value": "1.00"
                  }
                }
              ]
            },
            {
              "type": "REGULAR",
              "frequency": "Month",
              "frequency_interval": "1",
              "amount": {
                "value": "10.00"
              },
              "cycles": "15",
              "charge_models": [
                {
                  "type": "TAX",
                  "amount": {
                    "value": "2.00"
                  }
                },
                {
                  "type": "SHIPPING",
                  "amount": {
                    "value": "1.00"
                  }
                }
              ]
            }
          ],
          "merchant_preferences": {
            "setup_fee": {
              "value": "0.00"
            },
            "auto_bill_amount": "YES",
            "max_fail_attempts": "21"
          }
        },
        "payer": {
          "payment_method": "paypal",
          "status": "verified",
          "payer_info": {
            "email": "coolbuyer@example.com",
            "first_name": "Jane",
            "last_name": "Doe",
            "payer_id": "XLHKRXRA4H7QY",
            "shipping_address": {
              "recipient_name": "Jane Doe",
              "line1": "3rd st",
              "line2": "cool",
              "city": "San Jose",
              "state": "CA",
              "postal_code": "95112",
              "country_code": "US"
            }
          }
        },
        "agreement_details": {
          "outstanding_balance": {
            "value": "0.00"
          },
          "num_cycles_remaining": "5",
          "num_cycles_completed": "0",
          "last_payment_date": "2016-04-28T11:29:54Z",
          "last_payment_amount": {
            "value": "1.00"
          },
          "final_payment_due_date": "2017-11-30T10:00:00Z",
          "failed_payment_count": "0"
        },
        "description": "update desc",
        "state": "Cancelled",
        "links": [
          {
            "href": "https://api.paypal.com/v1/payments/billing-agreements/I-PE7JWXKGVN0R",
            "rel": "self",
            "method": "GET"
          }
        ],
        "start_date": "2016-04-30T07:00:00Z"
      },
      "links": [
        {
          "href": "https://api.paypal.com/v1/notifications/webhooks-events/WH-6TD369808N914414D-1YJ376786E892292F",
          "rel": "self",
          "method": "GET"
        },
        {
          "href": "https://api.paypal.com/v1/notifications/webhooks-events/WH-6TD369808N914414D-1YJ376786E892292F/resend",
          "rel": "resend",
          "method": "POST"
        }
      ]
    }
  }
}