`SubscriptionClosed`

Smile emits this message after a subscription is closed and billing is disabled. Business intelligence and audit listeners may use this information for reporting purposes. Listeners in other systems may need to disable or invalidate a user after receiving this message.

Message header

The following table lists the parameters in the SubscriptionClosed message header.

Table 1. SubscriptionClosed header parameters
Parameter	Type	Values
sid	integer	The service ID
usn	string	The unique subscription ID number for the subscription
smileMessageType	string	"SubscriptionClosed"

Message body

The message body contains the <SubscriptionUpdated> element and has the following format:

{http://xml.inomial.com/smile/2.xsd}SubscriptionUpdated

Example: The <SubscriptionUpdated> element

This example shows a SubscriptionUpdated XML document that contains the <SubscriptionUpdated> element for a closed subscription. Note that the subscription is deprovisioned and no longer activated.

<SubscriptionUpdated xmlns="http://xml.inomial.com/smile/2.xsd">
  <Subscription>
    <USN>2142426697</USN>
    <SID>17</SID>
    <ServiceName>Smile Access</ServiceName>
    <Parent>2142426689</Parent>
    <Properties>
      <Object>
        <String name="emailAddress">joe@example.com</String>
        <String name="username">joe@example.com</String>
      </Object>
    </Properties>
    <ProvisionStatus>Deprovisioned</ProvisionStatus>
    <SuspendStatus>Active</SuspendStatus>
    <ActivateStatus>NotActivated</ActivateStatus>
    <EnableStatus>Enabled</EnableStatus>
  </Subscription>
</SubscriptionUpdated>