`CreditLimitExceeded`

Smile emits this message when a subscription's usage causes the account to exceed the subscription credit limit. When calculating a subscription credit limit, Smile includes the value of outstanding account balances and any usage in the current invoicing cycle for that subscription. However, the subscription credit limit does not include the value of any usage in the current invoicing cycle for other subscriptions in the account.

Message header

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

Table 1. CreditLimitExceeded header parameters
Parameter	Type	Values
sid	integer	The service ID
usn	string	The unique subscription ID number for the subscription
creditLimit	string	The credit limit for the subscription or account
balance	string	The balance of the account associated with the subscription
currency	string	The ISO 4217 currency code of the account associated with the  subscription
smileMessageType	string	"CreditLimitExceeded"

Message body

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

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

Example: The <Subscription> element

This example shows a Subscription XML document that contains the <Subscription> element.

<Subscription xmlns="http://xml.inomial.com/smile/2.xsd">
  <USN>2142426838</USN>
  <SID>286</SID>
  <ServiceName>Test service 286</ServiceName>
  <Parent>2142426820</Parent>
  <Properties>
    <Object>
      <String name="username">joe.smith@example.com</String>
      <Boolean name="billPrintName">false</Boolean>
      <Boolean name="streetPrintName">true</Boolean>
    </Object>
  </Properties>
  <ProvisionStatus>Provisioned</ProvisionStatus>
  <SuspendStatus>Active</SuspendStatus>
  <ActivateStatus>Activated</ActivateStatus>
  <EnableStatus>Enabled</EnableStatus>
  <InvoicingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>24</CycleDay>
  </InvoicingCycle>
  <RatingCycle>
    <CycleType>Anniversary</CycleType>
    <CycleDay>24</CycleDay>
  </RatingCycle>
  <Timezone key="19">Australia/Sydney</Timezone>
  <CostCentre key="1">Example cost centre</CostCentre>
</Subscription>