# Monetization webhook payloads Below are samples of the definition payloads included in the monetization webhooks. Use the information in the webhooks to properly provision paid services to customers. ## 1. Monthly subscription earnings overview webhook: _marketplace.dev_earnings_overview_ **Payload sample** ```json { "description": "Monthly subscription earnings overview", "event": "marketplace.dev_earnings_overview", "event_ts": 1701659922000, "payload": { "accountId": "F5Vjzd_lS0i04JwQYtjrtA", "appDetails": [ { "appId": "id1", "businessName": "FaxSiPit", "currency": "dollar", "earnings": "253", "representativeName": "soumya1" }, { "appId": "id1", "businessName": "FaxSiPit", "currency": "dollar", "earnings": "253", "representativeName": "soumya1" } ], "appId": "GdHT-XfAQce91V1fR7lxcQ", "email": "byron.liu+test10@zoom.us", "userId": "rcnyfXwuRnGGfVlWWSlg7w" } } ``` --- ## 2. Subscription canceled webhook: _marketplace.app_subscription_canceled_ **Payload sample** ```json { "description": "App subscription is cancelled", "event": "marketplace.app_subscription_canceled", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "cancellationEffectiveDate": "2024-01-05T03:18:26.000+00:00", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "email": "jon.doe@zoom.us", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 3. Subscription downgraded webhook: _marketplace.app_subscription_removed_ **Payload sample** ```json { "description": "Subscription downgraded", "event": "marketplace.app_subscription_removed", "event_ts": 1708585556577, "payload": { "accountId": "JhetYswKQdGMBlwOllgs1Q", "appId": "GdHT-XfAQce91V1fR7lxcQ", "appName": "test non monetized app", "developerAccountId": "JhetYswKQdGMBlwOllgs1Q", "developerUserId": "ope8rM5cR1iyp2TrxIRw4A", "discountAmt": 10, "email": "placeholder.name@zoom.us", "newBillingFrequency": "MONTHLY", "newPlanName": "Pro", "newQuantity": 2, "newUnitPrice": 10, "nextBillingDate": "2024-03-21T05:50:53.000+00:00", "nextBillingTotalAmt": 21.65, "oldBillingFrequency": "MONTHLY", "oldPlanName": "Pro", "oldQuantity": 5, "oldUnitPrice": 10, "orderId": "null", "subTotalAmt": 20, "taxes": [ { "amt": 0.2, "level": "City", "name": "Transit Tax" }, { "amt": 0.2, "level": "City", "name": "Sales Tax" }, { "amt": 1.25, "level": "State", "name": "Sales Tax" } ], "totalAmt": 0, "totalTax": 1.65, "userId": "ope8rM5cR1iyp2TrxIRw4A" } } ``` --- ## 4. Subscription ended webhook: _marketplace.app_subscription_ended_ **Payload sample** ```json { "description": "App subscription expired", "event": "marketplace.app_subscription_ended", "event_ts": 1701659922000, "payload": { "accountId": "JhetYswKQdGMBlwOllgs1Q", "appId": "GdHT-XfAQce91V1fR7lxcQ", "appName": "Multiple Currency App", "developerAccountId": "JhetYswKQdGMBlwOllgs1Q", "developerUserId": "ope8rM5cR1iyp2TrxIRw4A", "email": "placeholder.name@zoom.us", "planName": "Pro", "userId": "ope8rM5cR1iyp2TrxIRw4A" } } ``` --- ## 5. Subscription licenses assigned to users webhook: _marketplace.app_user_entitlements_added_ **Payload sample** ```json { "description": "App licenses assigned to users", "event": "marketplace.app_user_entitlements_added", "event_ts": 1626230691572, "payload:": { "account_id": "account1234", "app_id": "app1234", "app_name": "ZOOMAPP", "billingFrequency": "MONTHLY", "users": [ { "email": "jon.doe@zoom.us", "plan_id": "PRO1234", "plan_name": "pro", "user_id": "user12345" }, { "email": "jon.doe2@zoom.us", "plan_id": "PRO1234", "plan_name": "pro", "user_id": "user3456" }, { "email": "jon.doe3@zoom.us", "plan_id": "PRO1234", "plan_name": "pro", "user_id": "user87656" } ] } } ``` --- ## 6. Subscription licenses unassigned to users webhook: _marketplace.app_user_entitlements_removed_ **Payload sample** ```json { "description": "App licenses unassigned to users", "event": "marketplace.app_user_entitlements_removed", "event_ts": 1626230691572, "payload:": { "account_id": "account1234", "app_id": "app1234", "app_name": "ZOOMAPP", "billingFrequency": "MONTHLY", "users": [ { "email": "jon.doe@zoom.us", "plan_id": "PRO1234", "plan_name": "pro", "user_id": "user12345" }, { "email": "jon.doe2@zoom.us", "plan_id": "PRO1234", "plan_name": "pro", "user_id": "user3456" }, { "email": "jon.doe3@zoom.us", "plan_id": "PRO1234", "plan_name": "pro", "user_id": "user87656" } ] } } ``` --- ## 7. Subscription purchase failed webhook: _marketplace.app_purchase_failed_with_ach_for_create_ **Payload sample** ```json { "description": "Subscription purchase failed", "event": "marketplace.app_purchase_failed_with_ach_for_create", "event_ts": 1708583993831, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 8. Subscription purchase success webhook: _marketplace.app_purchase_success_ **Payload sample** ```json { "description": "Subscription purchase success", "event": "marketplace.app_purchase_success", "event_ts": 1714160960389, "payload": { "accountId": "JhetYswKQdGMBlwOllgs1Q", "appId": "GdHT-XfAQce91V1fR7lxcQ", "appName": "Multiple Currency App", "billingFrequency": "MONTHLY", "discountAmt": 10, "email": "placeholder.name@zoom.us", "nextBillingDate": "2024-02-04T03:18:26.000+00:00", "nextBillingTotalAmt": 98.25, "planName": "Pro", "purchaseDate": "2024-01-04T03:18:26.000+00:00", "quantity": 10, "subTotalAmt": 100, "taxes": [ { "amt": 1, "level": "City", "name": "Transit Tax" }, { "amt": 1, "level": "City", "name": "Sales Tax" }, { "amt": 6.25, "level": "State", "name": "Sales Tax" } ], "totalAmt": 98.25, "totalTax": 8.25, "unitPrice": 10, "userId": "ope8rM5cR1iyp2TrxIRw4A" } } ``` --- ## 9. Subscription renewal failed webhook: _marketplace.app_renewal_failed_ **Payload sample** ```json { "description": "App subscription renewal failed", "event": "marketplace.app_renewal_failed", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "cancellationEffectiveDate": "2024-01-05T03:18:26.000+00:00", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 10. Subscription renewal success webhook: _marketplace.app_renewal_success_ **Payload sample** ```json { "description": "App subscription renewal successfully", "event": "marketplace.app_renewal_success", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "billingFrequency": "MONTHLY", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "discountAmt": 10, "nextBillingDate": "2024-02-04T03:18:26.000+00:00", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "purchaseDate": "2024-01-04T03:18:26.000+00:00", "quantity": 10, "taxes": [ { "amt": 1, "exemptAmt": null, "level": "City", "name": "Transit Tax" }, { "amt": 1, "exemptAmt": null, "level": "City", "name": "Sales Tax" }, { "amt": 6.25, "exemptAmt": null, "level": "State", "name": "Sales Tax" } ], "totalAmt": 98.25, "totalTax": 8.25, "unitPrice": 10, "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 11. Subscription upgrade failed webhook: _marketplace.app_purchase_failed_with_ach_for_upsell_ **Payload sample** ```json { "description": "App purchase failed with ACH during upgrade for existing subscription", "event": "marketplace.app_purchase_failed_with_ach_for_upsell", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "email": "jon.doe@zoom.us", "newBillingFrequency": "MONTHLY", "newPlanName": "Pro", "newQuantity": 10, "oldBillingFrequency": "MONTHLY", "oldPlanName": "Basic", "oldQuantity": 10, "orderId": "7QVvokzRTZOQsW2cYk-N3A", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 12. Subscription upgraded webhook: _marketplace.app_subscription_added_ **Payload sample** ```json { "description": "Subscription upgraded", "event": "marketplace.app_subscription_added", "event_ts": 1714156459124, "payload": { "accountId": "JhetYswKQdGMBlwOllgs1Q", "appId": "GdHT-XfAQce91V1fR7lxcQ", "appName": "Multiple Currency App", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "discountAmt": 90, "email": "placeholder.name@zoom.us", "newBillingFrequency": "MONTHLY", "newPlanName": "Pro", "newQuantity": 10, "newUnitPrice": 100, "nextBillingDate": "2024-02-04T03:18:26.000+00:00", "nextBillingTotalAmt": 1008.25, "oldBillingFrequency": "MONTHLY", "oldPlanName": "Basic", "oldQuantity": 10, "oldUnitPrice": 10, "prorationAmt": 900, "prorationCreditAmt": -100, "purchaseDate": "2024-01-04T03:18:26.000+00:00", "subTotalAmt": 1000, "taxProrationCreditAmt": 5, "taxes": [ { "amt": 1, "level": "City", "name": "Transit Tax" }, { "amt": 1, "level": "City", "name": "Sales Tax" }, { "amt": 6.25, "level": "State", "name": "Sales Tax" } ], "totalAmt": 818.25, "totalTax": 8.25, "userId": "ope8rM5cR1iyp2TrxIRw4A" } } ``` --- ## 13. Trial subscription converted to paid webhook: _marketplace.app_convert_to_paid_in_trial_ **Payload sample** ```json { "description": "Trial subscription converted to paid", "event": "marketplace.app_convert_to_paid_in_trial", "event_ts": 1626230691572, "payload:": { "accountId": "JhetYswKQdGMBlwOllgs1Q", "appId": "GdHT-XfAQce91V1fR7lxcQ", "appName": "Multiple Currency App", "billingFrequency": "MONTHLY", "discountAmt": 10, "email": "jon.doe@zoom.us", "nextBillingDate": "2024-02-04T03:18:26.000+00:00", "nextBillingTotalAmt": 98.25, "planName": "Pro", "purchaseDate": "2024-01-04T03:18:26.000+00:00", "quantity": 10, "subTotalAmt": 100, "taxes": [ { "amt": 1, "level": "City", "name": "Transit Tax" }, { "amt": 1, "level": "City", "name": "Sales Tax" }, { "amt": 6.25, "level": "State", "name": "Sales Tax" } ], "totalAmt": 98.25, "totalTax": 8.25, "unitPrice": 10, "userId": "ope8rM5cR1iyp2TrxIRw4A" } } ``` --- ## 14. Trial subscription ended webhook: _marketplace.app_trial_end_ **Payload sample** ```json { "description": "App free trial ended", "event": "marketplace.app_trial_end", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "email": "jon.doe@zoom.us", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 15. Trial subscription started webhook: _marketplace.app_trial_by_days_started_ **Payload sample** ```json { "description": "App free trial started for paid plan", "event": "marketplace.app_trial_by_days_started", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "email": "jon.doe@zoom.us", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "trialEndTime": "2024-01-11T03:18:26.000+00:00", "trialStartTime": "2024-01-04T03:18:26.000+00:00", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` --- ## 16. Trial subscription will end in 3 days webhook: _marketplace.app_trial_will_end_ **Payload sample** ```json { "description": "App free trial will end in few days", "event": "marketplace.app_trial_will_end", "event_ts": 1701659922000, "payload": { "accountId": "QD-l7gVkRrOEou56SKqFzg", "appId": "KngJP4FjT2K-aqnGDzpj6wapp-currency-3", "appName": "Multiple Currency App", "developerAccountId": "MLU9TcHFTL-6YyHeL0oxpQ", "developerUserId": "cH_-istBT5-r3GRaJZtA-A", "email": "jon.doe@zoom.us", "orderId": "7QVvokzRTZOQsW2cYk-N3A", "planName": "Pro", "trialEndDays": 3, "trialEndTime": "2024-01-011T03:18:26.000+00:00", "userId": "S_aQzsl9QFqsGV9cnYoAYA" } } ``` ---