Purchase Webhook

A Purchase Webhook is used in payment processing systems to notify or trigger actions in response to purchase transactions.

Purchase.pass: This event is triggered when a purchase is created after a successful transaction of a Pass

{
  "entity": "event",
  "user_id": "67a33080b06ceb81ad1a0962",
  "event": "purchase.subscription",
  "contains": [
    "purchase",
    "user"
  ],
  "payload": {
    "purchase": {
      "_id": "67a33168b06ceb81ad1a0dbf",
      "location": {
        "latitude": 28.4112,
        "longitude": 77.3132
      },
      "gstComponents": {
        "physical": 0,
        "digital": 0
      },
      "inrGstComponents": {
        "physical": 0,
        "digital": 0
      },
      "cancelAccess": false,
      "contentType": {
        "digital": true,
        "adFree": false,
        "_id": "67a33168b06ceb81ad1a0dbe"
      },
      "migrated": false,
      "partialAccess": false,
      "sectionsInclude": [],
      "authorsInclude": [],
      "sectionsExclude": [],
      "authorsExclude": [],
      "tagsInclude": [],
      "tagsExclude": [],
      "userAccount": "67a33080b06ceb81ad1a0962",
      "clientId": "661907c2487ae1aba956dcc4",
      "clientReferenceId": "undefined",
      "buyingPrice": 108,
      "price": 120,
      "country": "IN",
      "city": "faridabad",
      "priceDetails": {
        "price": 120,
        "currency": "INR"
      },
      "type": "SUBSCRIPTION",
      "subscriptionType": {
        "physical": false,
        "digital": true,
        "adFree": false,
        "epaper": false
      },
      "subscriptionTitle": "kuchbhi",
      "subscriptionDetails": {
        "inrPrice": 120,
        "duration": 1
      },
      "transactionId": "67a33168b06ceb81ad1a0dbd",
      "expiryDate": "2025-03-05T09:37:44.468Z",
      "createdAt": "2025-02-05T09:37:44.508Z",
      "updatedAt": "2025-02-05T09:37:44.508Z"
    },
    "user": {
      "email": "[email protected]",
      "freeTrial": 0,
      "userId": "67a3307bb06ceb81ad1a0945",
      "externalUserId": "67a3307bb06ceb81ad1a0945",
      "address": {
        "apartment": "",
        "landmark": "",
        "city": "",
        "name": "asdf",
        "area": "asdf",
        "pincode": "1234",
        "state": "adsf",
        "country": "AX"
      },
      "name": "ayush",
      "billingAddress": [
        {
          "name": "asdf",
          "apartment": "",
          "area": "asdf",
          "pincode": "1234",
          "landmark": "",
          "city": "",
          "state": "adsf",
          "country": "AX",
          "_id": "67a3313db06ceb81ad1a0b35"
        }
      ],
      "shippingAddress": [
        {
          "name": "adsf",
          "apartment": "",
          "area": "sadf",
          "pincode": "5346576",
          "landmark": "",
          "city": "",
          "state": "asdd",
          "country": "HT",
          "_id": "67a3313db06ceb81ad1a0b36"
        }
      ],
      "dateOfBirth": null,
      "location": {},
      "clientTierId": "673c315bb2deb6e310fbd8f3"
    }
  },
  "client_info": {
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/132.0.0.0 Safari/537.36",
    "country": "India",
    "countryCode": "IN",
    "deviceType": "desktop",
    "deviceModel": "Macintosh"
  },
  "created_at": 1738748267
}

Purchase.subscription: This event is triggered when a purchase is created after a successful transaction of a Subscription.

Purchase.pay_per_use: This event is triggered when a purchase is created after a successful transaction of a Pay-per-use.

Purchase.bundle:

Last updated