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": "65e01f76d03692125f1f355e",
"event": "purchase.pass",
"contains": [
"user",
"purchase"
],
"payload": {
"user": {
"phoneNumber": "8838239889",
"userId": "65e01f76d03692125f1f355e",
"country": "IN",
"address": {
"apartment": "",
"area": "",
"pincode": "",
"landmark": "",
"city": "",
"state": "",
"country": ""
},
"name": "",
"city": "new delhi (okhla phase i)",
"location": {
"latitude": 28.5223,
"longitude": 77.2849,
"postcode": "110001"
},
"username": "8838239889"
},
"purchase": {
"location": {
"latitude": 28.5223,
"longitude": 77.2849,
"postcode": "110001"
},
"gstComponents": {
"physical": 0,
"digital": 0
},
"inrGstComponents": {
"physical": 0,
"digital": 0
},
"_id": "65e0239ad03692125f1f35c5",
"cancelAccess": false,
"contentType": {
"digital": true,
"adFree": false,
"_id": "65e0239a36cfe5f49666f7ec"
},
"categories": [],
"bundle": false,
"bundleContentIds": [],
"paymentType": [
"NEW"
],
"migrated": false,
"partialAccess": false,
"sectionsInclude": [],
"authorsInclude": [],
"sectionsExclude": [],
"authorsExclude": [],
"tagsInclude": [],
"tagsExclude": [],
"proRataAppliedPurchases": [],
"userAccount": "65e01f76d03692125f1f355e",
"clientId": "65015ff10070846629fb981e",
"paywallId": "65cb7057e57605058015b407",
"clientContentId": "Client-Story-Id-6",
"contentId": "65c32600aa9ec1057a23254a",
"buyingPrice": 2400,
"price": 3000,
"country": "IN",
"city": "new delhi (okhla phase i)",
"userCountry": "IN",
"expiryDate": "2024-02-29T13:26:23.617Z",
"passTitle": "Pass",
"priceDetails": {
"price": 3000,
"currency": "INR",
"_id": "65e0239a36cfe5f49666f7ed"
},
"type": "PASS",
"operatingSystem": "Mac OS",
"device": "desktop",
"transactionId": "65e02390d03692125f1f35c4",
"bundleSubscriptions": [],
"createdAt": "2024-02-29T06:26:34.259Z",
"updatedAt": "2024-02-29T06:26:34.259Z",
"__v": 0
}
},
"client_info": {
"deviceType": "desktop"
},
"created_at": 1709187994
}
Purchase.subscription: This event is triggered when a purchase is created after a successful transaction of a Subscription.
{
"entity": "event",
"user_id": "65e01719d03692125f1f323f",
"event": "purchase.subscription",
"contains": [
"purchase",
"user"
],
"payload": {
"purchase": {
"location": {
"latitude": 28.5223,
"longitude": 77.2849,
"postcode": "110001"
},
"gstComponents": {
"physical": 0,
"digital": 0
},
"inrGstComponents": {
"physical": 0,
"digital": 0
},
"_id": "65e01774d03692125f1f3316",
"cancelAccess": false,
"contentType": {
"digital": true,
"adFree": false,
"_id": "65e0177536cfe5f49666f460"
},
"categories": [],
"bundle": false,
"bundleContentIds": [],
"paymentType": [
"NEW"
],
"migrated": false,
"partialAccess": true,
"sectionsInclude": [
"pawn",
"goal",
"batting",
"goalkeeper"
],
"authorsInclude": [
"virat",
"messi",
"chand"
],
"sectionsExclude": [],
"authorsExclude": [],
"tagsInclude": [
"cricket",
"football",
"chess",
"hockey"
],
"tagsExclude": [],
"proRataAppliedPurchases": [
"65e01745d03692125f1f3279"
],
"userAccount": "65e01719d03692125f1f323f",
"clientId": "65015ff10070846629fb981e",
"paywallId": "65cb7057e57605058015b407",
"landingPageId": "652e3c6ce7354805632dc7ce",
"clientContentId": "Client-Story-Id-2",
"contentId": "65115336f1a61f0a58d4ae4e",
"buyingPrice": 1.02,
"price": 1.07,
"country": "IN",
"discountCouponUserId": null,
"discountCouponTemplateId": null,
"originalPriceDetails": {
"currency": "INR"
},
"originalInrPrice": 2,
"city": "new delhi (okhla phase i)",
"userCountry": "IN",
"expiryDate": "2024-03-29T05:34:36.199Z",
"priceDetails": {
"price": 1.07,
"currency": "INR",
"_id": "65e0177536cfe5f49666f461"
},
"type": "SUBSCRIPTION",
"subscriptionTitle": "super set",
"operatingSystem": "Mac OS",
"device": "desktop",
"subscriptionType": {
"physical": false,
"digital": true,
"adFree": false,
"_id": "65e0177536cfe5f49666f462"
},
"previouslyPurchasedSubscriptionId": null,
"subscriptionId": "65c4e3bff296fa057f3efaaf",
"tierId": "65c4e3bff296fa057f3efab1",
"subscriptionDetails": {
"inrPrice": 1.07,
"duration": 1,
"_id": "65e0177536cfe5f49666f463"
},
"transactionId": "65e0176cd03692125f1f32e5",
"bundleSubscriptions": [],
"createdAt": "2024-02-29T05:34:44.141Z",
"updatedAt": "2024-02-29T05:34:44.141Z",
"__v": 0
},
"user": {
"phoneNumber": "8383884833",
"email": "fvdzcxz@rsgfdcx.fvc",
"freeTrial": 0,
"userId": "65e01719d03692125f1f323f",
"country": "IN",
"address": {
"apartment": "",
"area": "",
"pincode": "",
"landmark": "",
"city": "",
"state": "",
"country": ""
},
"name": "dfsxzc dvzxc",
"city": "new delhi (okhla phase i)",
"location": {
"latitude": 28.5223,
"longitude": 77.2849,
"postcode": "110001"
},
"username": "8383884833",
"clientTierId": "65c4e3bff296fa057f3efab1"
}
},
"client_info": {
"deviceType": "desktop"
},
"created_at": 1709184885
}
Purchase.pay_per_use: This event is triggered when a purchase is created after a successful transaction of a Pay-per-use.
{
"entity": "event",
"user_id": "65e01f76d03692125f1f355e",
"event": "purchase.pay_per_use",
"contains": [
"purchase",
"user"
],
"payload": {
"purchase": {
"location": {
"latitude": 28.5223,
"longitude": 77.2849,
"postcode": "110001"
},
"gstComponents": {
"physical": 0,
"digital": 0
},
"inrGstComponents": {
"physical": 0,
"digital": 0
},
"_id": "65e0235ed03692125f1f35c2",
"cancelAccess": false,
"contentType": {
"digital": true,
"adFree": false,
"_id": "65e0235e36cfe5f49666f7b2"
},
"categories": [],
"bundle": false,
"bundleContentIds": [],
"paymentType": [
"NEW"
],
"migrated": false,
"partialAccess": false,
"sectionsInclude": [],
"authorsInclude": [],
"sectionsExclude": [],
"authorsExclude": [],
"tagsInclude": [],
"tagsExclude": [],
"proRataAppliedPurchases": [],
"userAccount": "65e01f76d03692125f1f355e",
"clientId": "65015ff10070846629fb981e",
"paywallId": "65cb7057e57605058015b407",
"clientContentId": "Client-Story-Id-2",
"contentId": "65115336f1a61f0a58d4ae4e",
"buyingPrice": 8,
"price": 10,
"country": "IN",
"city": "new delhi (okhla phase i)",
"userCountry": "IN",
"expiryDate": "2024-03-07T06:25:24.493Z",
"priceDetails": {
"price": 10,
"currency": "INR",
"_id": "65e0235e36cfe5f49666f7b3"
},
"type": "CONTENT",
"operatingSystem": "Mac OS",
"device": "desktop",
"transactionId": "65e02354d03692125f1f35c0",
"bundleSubscriptions": [],
"createdAt": "2024-02-29T06:25:34.333Z",
"updatedAt": "2024-02-29T06:25:34.333Z",
"__v": 0
},
"user": {
"phoneNumber": "8838239889",
"userId": "65e01f76d03692125f1f355e",
"country": "IN",
"address": {
"apartment": "",
"area": "",
"pincode": "",
"landmark": "",
"city": "",
"state": "",
"country": ""
},
"name": "",
"city": "new delhi (okhla phase i)",
"location": {
"latitude": 28.5223,
"longitude": 77.2849,
"postcode": "110001"
},
"username": "8838239889"
}
},
"client_info": {
"deviceType": "desktop"
},
"created_at": 1709187934
}
Purchase.bundle:
{
"entity": "event",
"user_id": "65e59ddb6efe72055d89ec87",
"event": "purchase.bundle",
"contains": [
"purchase",
"user"
],
"payload": {
"purchase": {
"location": {
"latitude": 28.5246,
"longitude": 77.2793,
"postcode": "110001"
},
"gstComponents": {
"physical": 0,
"digital": 899
},
"inrGstComponents": {
"physical": 0,
"digital": 899
},
"_id": "65e5a2576efe72055d89ed11",
"cancelAccess": false,
"contentType": {
"digital": true,
"adFree": false,
"_id": "65e5a26036cfe5f496673315"
},
"categories": [],
"bundle": true,
"bundleContentIds": [],
"paymentType": [
"NEW"
],
"migrated": false,
"partialAccess": false,
"sectionsInclude": [],
"authorsInclude": [],
"sectionsExclude": [],
"authorsExclude": [],
"tagsInclude": [],
"tagsExclude": [],
"proRataAppliedPurchases": [],
"userAccount": "65e59ddb6efe72055d89ec87",
"clientId": "65015ff10070846629fb981e",
"buyingPrice": 854.05,
"price": 899,
"clientName": "Black Panther",
"country": "IN",
"city": "new delhi (pocket c)",
"userCountry": "IN",
"priceDetails": {
"price": 899,
"currency": "INR",
"_id": "65e5a26036cfe5f496673316"
},
"type": "SUBSCRIPTION",
"subscriptionType": {
"physical": false,
"digital": true,
"adFree": false,
"_id": "65e5a26036cfe5f496673317"
},
"subscriptionTitle": "Bundled Subscription",
"utmParameters": {
"utm_source": "KJK"
},
"operatingSystem": "Mac OS",
"device": "desktop",
"bundleSubscriptions": [
{
"_id": "650166680070846629fb9866",
"clientId": "601a8ea4f2149f089782814f",
"tierId": "650166680070846629fb9868"
}
],
"subscriptionDetails": {
"inrPrice": 899,
"duration": 0,
"_id": "65e5a26036cfe5f496673318"
},
"transactionId": "65e5a2576efe72055d89ed13",
"expiryDate": "2024-03-04T10:28:47.967Z",
"createdAt": "2024-03-04T10:28:47.967Z",
"updatedAt": "2024-03-04T10:28:47.967Z",
"__v": 0
},
"user": {
"phoneNumber": "9821828889",
"userId": "65e59ddb6efe72055d89ec87",
"country": "IN",
"address": {
"apartment": "1212",
"pincode": "12",
"city": "1212",
"country": "India",
"state": "1212",
"area": "",
"landmark": ""
},
"name": "ajdkllasd",
"dateOfBirth": "0222-03-12T00:00:00.000Z",
"city": "new delhi (pocket c)",
"location": {
"latitude": 28.5246,
"longitude": 77.2793,
"postcode": "110001"
},
"username": "9821828889"
}
},
"client_info": {
"deviceType": "desktop"
},
"created_at": 1709548128
}Last updated