> For the complete documentation index, see [llms.txt](https://docs.roamingiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roamingiq.com/developers/sample-webhook-payloads.md).

# Sample Webhook Payloads

```
Webhooks for venue / unit configuration:

(V7) KeyStart
(V8) KeyEnd

(VU1) VenueUnitAdded
(VU2) VenueUnitUpdated

Webhooks for subscribers:

(S1) LoginPasswordCreated

Webhooks for subscriptions:

(SU1) SubscriptionSetupSuccess
(SU2) SubscriptionPlanUpdated
(SU3) SubscriptionVenueUnitUpdated
(SU4) SubscriptionPriceUpdated
(SU5) SubscriptionNextInvoiceAdjustment
(SU6) SubscriptionStartDateAdjustment
(SU7) SubscriptionEndDateAdjustment
(SU8) SubscriptionStarted
(SU9) SubscriptionEnded

Webhooks for Stripe-enabled subscriptions:

(SUS2) StripePaymentSuccess
(SUS3) StripePaymentFailed
(SUS4) StripePaymentMethodUpdated
(SUS5) StripeChargeRefunded

(V7) KeyStart

"Payload": {
    "Type": "KeyStart",
    "dateAddedUTC.ISO8601": "2023-03-23T04:09:08.125Z",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.Unit 10-TEMP-1953.DEFAULT.DEFAULT",
    "PrimaryUnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT10.DEFAULT.DEFAULT",
    "externalVenueUnitID": "",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "purpose": "wiredunit",
    "externalVenueID": "",
    "UnitID": "Unit 10-TEMP-1953",
    "UnitFloor": "DEFAULT",
    "UnitBuilding": "DEFAULT",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "Country.ISO3166A3": "USA",
    "PostalCode": "90000",
    "vlan": 1953,
    "RealPageUnitID": "",
    "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.500MBPS",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "psk": "ExampleWiFiPass1"
}

(V8) KeyEnd

"Payload": {
    "Type": "KeyEnd",
    "dateAddedUTC.ISO8601": "2023-03-23T05:09:08.125Z",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.Unit 10-TEMP-1953.DEFAULT.DEFAULT",
    "PrimaryUnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT10.DEFAULT.DEFAULT",
    "externalVenueUnitID": "",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "purpose": "wiredunit",
    "externalVenueID": "",
    "UnitID": "Unit 10-TEMP-1953",
    "UnitFloor": "DEFAULT",
    "UnitBuilding": "DEFAULT",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "Country.ISO3166A3": "USA",
    "PostalCode": "90000",
    "vlan": 1953,
    "RealPageUnitID": "",
    "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.500MBPS",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "psk": "ExampleWiFiPass1"
}

(VU1) VenueUnitAdded

"Payload": {
    "Type": "VenueUnitAdded",
    "dateAddedUTC.ISO8601": "2023-03-23T04:09:08.125Z",
    "SourceIP": "203.0.113.42",
    "Administrator": "admin.sample@example.com",
    "AdministratorOS": "",
    "AdministratorBrowser": "Make/production",
    "SourceLocale": "en-us",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.Unit 10-TEMP-1953.DEFAULT.DEFAULT",
    "PrimaryUnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT10.DEFAULT.DEFAULT",
    "externalVenueUnitID": "",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "",
    "UnitID": "Unit 10-TEMP-1953",
    "UnitFloor": "DEFAULT",
    "UnitBuilding": "DEFAULT",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "Country.ISO3166A3": "USA",
    "PostalCode": "90000",
    "vlan": 1953,
    "purpose": "wiredunit",
    "ServicePlanID_globalroaming": "",
    "RealPageUnitID": "",
    "SMSCode": "",
    "VenueUnitPriceAdjustment": 0,
    "event": "Unit USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.Unit 10-TEMP-1953.DEFAULT.DEFAULT added. "
}

(VU2) VenueUnitUpdated

"Payload": {
    "Type": "VenueUnitUpdated",
    "dateAddedUTC.ISO8601": "2023-02-22T23:57:45.923Z",
    "SourceIP": "203.0.113.42",
    "Administrator": "admin.sample@example.com",
    "AdministratorOS": "Mac OS 10.15.7",
    "AdministratorBrowser": "Safari 16.3",
    "SourceLocale": "en-us",
    "UnitID_internal": "USA.VA.00001.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLETESTVENUE.SAMPLETON.UNITT1.1.1",
    "externalVenueUnitID": "",
    "VenueID": "USA.VA.00001.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLETESTVENUE.SAMPLETON",
    "externalVenueID": "3287-ext",
    "UnitID": "Unit T1",
    "UnitFloor": "1",
    "UnitBuilding": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Venue",
    "City": "Sampleton",
    "State": "CA",
    "Country.ISO3166A3": "USA",
    "PostalCode": "90000",
    "vlan": 1007,
    "purpose": "wiredunit",
    "ServicePlanID_globalroaming": "",
    "RealPageUnitID": "",
    "SMSCode": "",
    "VenueUnitPriceAdjustment": -1500,
    "singleuseVenueUnitPriceAdjustment": "Inherit"
}

(S1) LoginPasswordCreated

"Payload": {
    "Type": "LoginPasswordCreated",
    "dateAddedUTC.ISO8601": "2023-03-15T03:12:49.743Z",
    "SourceIP": "203.0.113.42",
    "Administrator": "",
    "AdministratorOS": "",
    "AdministratorBrowser": "PostmanRuntime/7.31.1",
    "SourceLocale": "en-us",
    "EmailAddress": "sample.user@example.com",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "event": "Subscriber accepted TandC. ",
    "PhoneNumber.E164": "+15555010100"
}

(SU1) SubscriptionSetupSuccess

"Payload": {
    "Type": "SubscriptionSetupSuccess",
    "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "PrimaryUnitID_internal": "",
    "externalVenueUnitID": "",
    "UnitID": "Unit 11",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "Currency": "USD",
    "CurrencySymbol": "$",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.500MBPS",
        "externalServicePlanID": "External SERVICEPLAN_.500MBPS",
        "VenueUnitPriceAdjustment": -200,
        "BillingCyclePrice.USD": 11099,
        "ListBillingCyclePrice.USD": 11099,
        "NetBillingCyclePrice.USD": 8899
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "SourceIP": "203.0.113.42",
    "AdministratorOS": "Mac OS 10.15.7",
    "AdministratorBrowser": "Safari 16.3",
    "SourceLocale": "en-us",
    "StartDateTimeUTC.ISO8601": "2023-03-26T07:00:00.000Z",
    "EndDateTimeUTC.ISO8601": "",
    "AccountAddedByAdministrator": "",
    "Status": "AUP not accepted",
    "AccountStatusAtCreation": "AUP not accepted",
    "AccountStatus": "AUP not accepted",
    "SetupSuccessDateTimeUTC.ISO8601": "2023-03-22T21:40:18.134Z",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "Events": []
}

(SU2) SubscriptionPlanUpdated

"Payload": {
    "Type": "SubscriptionPlanUpdated",
    "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "externalVenueUnitID": "",
    "UnitID": "Unit 11",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "Currency": "USD",
    "CurrencySymbol": "$",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.750MBPS",
        "externalServicePlanID": "SP700MBPS",
        "VenueUnitPriceAdjustment": -200,
        "BillingCyclePrice.USD": 8970,
        "ListBillingCyclePrice.USD": 8970,
        "NetBillingCyclePrice.USD": 6770
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "AccountStatusAtCreation": "AUP not accepted",
    "AccountStatus": "In Service",
    "SourceIP": "203.0.113.42",
    "AdministratorOS": "Mac OS 10.15.7",
    "AdministratorBrowser": "Safari 16.3",
    "SourceLocale": "en-us",
    "StartDateTimeUTC.ISO8601": "2023-03-26T07:00:00.000Z",
    "EndDateTimeUTC.ISO8601": "",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "BillingCyclePriceAdjustment": 0,
    "Events": [
        {
            "timestamp": "2023-03-22T21:54:47.971Z",
            "event": "Service plan updated from EMERGENCYSERVICE to 750MBPS. New plan price = 89.70 USD. Payment success. ",
            "reason": "",
            "Administrator": "",
            "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.750MBPS",
            "function_name": "PaymentScheduler_paymentsuccess"
        },
        {
            "timestamp": "2023-03-22T21:40:18.134Z",
            "event": "Payment method updated. "
        }
    ]
}

(SU3) SubscriptionVenueUnitUpdated

"Payload": {
    "Type": "SubscriptionVenueUnitUpdated",
    "dateAddedUTC.ISO8601": "2023-03-22T16:51:47.466Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT14.1.1",
    "externalVenueUnitID": "",
    "UnitID": "Unit 14",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "Currency": "USD",
    "CurrencySymbol": "$",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
        "externalServicePlanID": "EXT1000E31",
        "VenueUnitPriceAdjustment": -1200,
        "BillingCyclePrice.USD": 17999,
        "ListBillingCyclePrice.USD": 17999,
        "NetBillingCyclePrice.USD": 14799
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "SourceIP": "203.0.113.42",
    "AdministratorOS": "Mac OS 10.15.7",
    "AdministratorBrowser": "Safari 16.3",
    "SourceLocale": "en-us",
    "StartDateTimeUTC.ISO8601": "2023-03-22T17:22:38.522Z",
    "EndDateTimeUTC.ISO8601": "2023-04-01T06:59:59.999Z",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "Events": [
        {
            "timestamp": "2023-03-22T21:35:50.361Z",
            "event": "Subscription unit updated from Unit 11-1-1 to Unit 14-1-1",
            "reason": "",
            "Administrator": "admin.sample@example.com"
        }
    ]
}

(SU4) SubscriptionPriceUpdated

"Payload": {
    "Type": "SubscriptionPriceUpdated",
    "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "UnitID": "Unit 11",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "Currency": "USD",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.750MBPS",
        "VenueUnitPriceAdjustment": -500,
        "BillingCyclePrice.USD": 8970,
        "NetBillingCyclePrice.USD": 6470
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "BillingCyclePriceAdjustment": 0,
    "Events": [
        {
            "timestamp": "2023-03-22T21:59:26.453Z",
            "event": "Updated unit-level price adjustment to -500",
            "reason": "Text",
            "Administrator": "admin.sample@example.com"
        }
    ]
}

(SU5) SubscriptionNextInvoiceAdjustment

"Payload": {
    "Type": "SubscriptionNextInvoiceAdjustment",
    "dateAddedUTC.ISO8601": "2023-03-22T21:40:02.060Z",
    "SubscriberToken": "PhonRant",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.750MBPS",
        "VenueUnitPriceAdjustment": -500,
        "BillingCyclePrice.USD": 8970,
        "NetBillingCyclePrice.USD": 6470
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "BillingCyclePriceAdjustment": -500,
    "Events": [
        {
            "timestamp": "2023-03-22T22:02:35.464Z",
            "event": "Updating one-time adjustment for next billing cycle -500",
            "reason": "Text",
            "Administrator": "admin.sample@example.com"
        }
    ]
}

(SU6) SubscriptionStartDateAdjustment

"Payload": {
    "Type": "SubscriptionStartDateAdjustment",
    "dateAddedUTC.ISO8601": "2023-03-21T19:55:43.231Z",
    "SubscriberToken": "PhonRant",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.500MBPS",
        "VenueUnitPriceAdjustment": -200,
        "BillingCyclePrice.USD": 11099,
        "NetBillingCyclePrice.USD": 8899
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "StartDateTimeUTC.ISO8601": "2023-04-02T07:00:00.000Z",
    "EndDateTimeUTC.ISO8601": "",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "Events": [
        {
            "timestamp": "2023-03-22T01:08:17.414Z",
            "event": "Subscription start date updated to 2023-04-02T07:00:00.000Z",
            "reason": "",
            "Administrator": "admin.sample@example.com"
        }
    ]
}

(SU7) SubscriptionEndDateAdjustment

"Payload": {
    "Type": "SubscriptionEndDateAdjustment",
    "dateAddedUTC.ISO8601": "2023-03-22T01:50:42.702Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": true,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "externalVenueUnitID": "",
    "UnitID": "Unit 11",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
        "VenueUnitPriceAdjustment": 0,
        "BillingCyclePrice.USD": 10000,
        "NetBillingCyclePrice.USD": 10000
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "Administrator": "",
    "SourceIP": "203.0.113.42",
    "AdministratorOS": "Windows 10",
    "AdministratorBrowser": "Chrome 150.0.0.0",
    "SourceLocale": "en-us",
    "StartDateTimeUTC.ISO8601": "2023-01-15T00:59:09.713Z",
    "EndDateTimeUTC.ISO8601": "2023-03-22T01:50:42.564Z",
    "CancellationSource": "Subscription end date updated by subscriber via self-service portal.",
    "CancellationReasons": [
        "Moving"
    ],
    "AccountStatusAtCreation": "AUP not accepted",
    "AccountStatus": "In Service",
    "AmountRefunded": 0,
    "AmountProcessed": 10000,
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "Events": [
        {
            "timestamp": "2023-01-15T00:59:15.371Z",
            "event": "Updating phone_number_verified=true. "
        }
    ]
}

(SU8) SubscriptionStarted

"Payload": {
    "Type": "SubscriptionStarted",
    "dateAddedUTC.ISO8601": "2026-08-01T00:23:03.651Z",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.Unit 10-TEMP-1953.DEFAULT.DEFAULT",
    "PrimaryUnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT10.DEFAULT.DEFAULT",
    "externalVenueUnitID": "",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "",
    "UnitID": "Unit 10-TEMP-1953",
    "UnitFloor": "DEFAULT",
    "UnitBuilding": "DEFAULT",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "Country.ISO3166A3": "USA",
    "PostalCode": "90000",
    "vlan": 1953,
    "purpose": "wiredunit",
    "RealPageUnitID": "",
    "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.500MBPS",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "psk": "ExampleWiFiPass1"
}

(SU9) SubscriptionEnded

"Payload": {
    "Type": "SubscriptionEnded",
    "dateAddedUTC.ISO8601": "2026-08-01T00:27:04.521Z",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "PrimaryUnitID_internal": "",
    "externalVenueUnitID": "",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "",
    "UnitID": "Unit 11",
    "UnitFloor": "1",
    "UnitBuilding": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "Country.ISO3166A3": "USA",
    "PostalCode": "90000",
    "vlan": "",
    "purpose": "wiredunit",
    "RealPageUnitID": "",
    "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "psk": "ExampleWiFiPass2"
}

(SUS2) StripePaymentSuccess

"Payload": {
    "Type": "StripePaymentSuccess",
    "dateAddedUTC.ISO8601": "2023-03-15T03:10:21.062Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "externalVenueUnitID": "",
    "UnitID": "Unit 11",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "Currency": "USD",
    "CurrencySymbol": "$",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
        "VenueUnitPriceAdjustment": -1000,
        "BillingCyclePrice.USD": 14999,
        "NetBillingCyclePrice.USD": 14999,
        "ListBillingCyclePrice.USD": 17999
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "AccountStatusAtCreation": "AUP not accepted",
    "AccountStatus": "In Service",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "PaymentSuccessDateTimeUTC.ISO8601": "2023-03-15T03:10:21.062Z",
    "StripePaymentIntentId": "pi_EXAMPLE0000000000000",
    "StripePaymentChargeId": "ch_EXAMPLE0000000000000",
    "StripeReceiptURL": "https://pay.stripe.com/receipts/payment/EXAMPLE_RECEIPT_TOKEN",
    "AmountProcessed": 14999,
    "AmountReceived": 14999,
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "Events": []
}

(SUS3) StripePaymentFailed

"Payload": {
    "Type": "StripePaymentFailed",
    "dateAddedUTC.ISO8601": "2023-03-16T23:51:03.902Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "externalVenueUnitID": "",
    "UnitID": "Unit 11",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "Currency": "USD",
    "CurrencySymbol": "$",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
        "VenueUnitPriceAdjustment": -1000,
        "BillingCyclePrice.USD": 17999,
        "ListBillingCyclePrice.USD": 17999,
        "NetBillingCyclePrice.USD": 14999
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "AccountStatusAtCreation": "AUP not accepted",
    "AccountStatus": "In Service",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "PaymentFailureReason": " Card was declined for an unknown reason. ",
    "Events": [
        {
            "timestamp": "2023-03-17T00:01:20.311Z",
            "event": "Payment failed - Card was declined for an unknown reason. (generic_decline). "
        }
    ]
}

(SUS4) StripePaymentMethodUpdated

"Payload": {
    "Type": "StripePaymentMethodUpdated",
    "dateAddedUTC.ISO8601": "2023-03-15T23:55:56.301Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "GivenName": "Sample",
    "FamilyName": "User",
    "locale": "en-us",
    "contactpref_sms": false,
    "contactpref_email": false,
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "externalVenueUnitID": "",
    "UnitID": "Unit 11",
    "UnitBuilding": "1",
    "UnitFloor": "1",
    "AddressLine1": "100 Example Plaza Dr",
    "AddressLine2": "Sample Test Property",
    "City": "Sampleton",
    "State": "CA",
    "PostalCode": "90000",
    "Country.ISO3166A3": "USA",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "externalVenueID": "3768-ext-Update1",
    "Currency": "USD",
    "CurrencySymbol": "$",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
        "VenueUnitPriceAdjustment": -1000,
        "BillingCyclePrice.USD": 17999,
        "ListBillingCyclePrice.USD": 17999,
        "NetBillingCyclePrice.USD": 14999
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "AccountStatusAtCreation": "AUP not accepted",
    "AccountStatus": "In Service",
    "SourceIP": "203.0.113.42",
    "AdministratorOS": "Mac OS 10.15.7",
    "AdministratorBrowser": "Safari 16.3",
    "SourceLocale": "en-us",
    "StartDateTimeUTC.ISO8601": "2023-03-16T00:03:35.964Z",
    "EndDateTimeUTC.ISO8601": "",
    "SetupSuccessDateTimeUTC.ISO8601": "2023-03-16T01:06:17.532Z",
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentMethod": "pm_EXAMPLE0000000000000",
    "Events": [
        {
            "timestamp": "2023-03-16T01:05:11.488Z",
            "event": "Payment method update requested."
        },
        {
            "timestamp": "2023-03-16T01:05:28.624Z",
            "event": "Payment method updated. "
        }
    ]
}

(SUS5) StripeChargeRefunded

"Payload": {
    "Type": "StripeChargeRefunded",
    "dateAddedUTC.ISO8601": "2023-03-15T15:24:20.557Z",
    "EmailAddress": "sample.user@example.com",
    "PhoneNumber.E164": "+15555010100",
    "SubscriberToken": "PhonRant",
    "externalSubscriberID": "",
    "externalSubscriptionID": "00000000-0000-4000-8000-000000000000",
    "UnitID_internal": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON.UNIT11.1.1",
    "VenueID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3VENUE_.USA.CA.90000.SAMPLEPROP.SAMPLETON",
    "ServicePlan": {
        "ServicePlanID": "USA.CO.00000.EXAMPLEISP.WALPOLE._V3SERVICEPLAN_.1GBPS",
        "VenueUnitPriceAdjustment": -1000,
        "BillingCyclePrice.USD": 14999,
        "NetBillingCyclePrice.USD": 14999,
        "ListBillingCyclePrice.USD": 17999
    },
    "StripeCustomerID": "cus_EXAMPLE0000000000000",
    "AmountRefunded": 14978,
    "StripeSetupIntentId": "seti_EXAMPLE0000000000000",
    "StripePaymentIntentId": "pi_EXAMPLE0000000000000",
    "RefundDateTimeUTC.ISO8601": "2023-03-15T15:25:00.422Z",
    "StripeRefundReceiptURL": "https://pay.stripe.com/receipts/payment/EXAMPLE_RECEIPT_TOKEN",
    "AmountProcessed": 14999
}

```