getSubscriptionValuePoolStates()

SubscriptionValuePoolState getSubscriptionValuePoolStates(string usn)

This method returns information about the current state of each value pool associated with a subscription. Use this method to retrieve and display information about a subscription's value pools.

Note: You must enable pre-rating before you use this method.

Parameters

usn
Format: string
Purpose: Specifies the subscription associated with the value pools.

Results

This method returns a SubscriptionValuePoolState XML document that lists information about the current state of each of the subscription's value pools, for example, the value pool limit, amount spent in the period to date, alert thresholds and reset date.

Note: Smile updates the values in this XML document each time the pre-rating process runs.

There are no messages defined by this method.

Example: A returned SubscriptionValuePoolState XML document

This example shows a SubscriptionValuePoolState XML document for a subscription with two value pools. The Included Local Calls and SMS value pool has a limit of $500 and the Included Calls value pool has a limit of $50. The balance of both value pools is $0.

<SubscriptionValuePoolState xmlns="http://xml.inomial.com/smile/2.xsd">
  <SubscriptionValuePool>
    <ValuePool>
      <valuePoolId>252</valuePoolId>
      <sid>137</sid>
      <name>Included Local Calls and SMS</name>
      <alertThresholds>
        <alertThreshold>50</alertThreshold>
        <alertThreshold>80</alertThreshold>
        <alertThreshold>100</alertThreshold>
      </alertThresholds>
    </ValuePool>
    <periodEnd>2012-08-31+12:00</periodEnd>
    <limit>500.00</limit>
    <effectiveAlertThresholds>
      <alertThreshold>50</alertThreshold>
      <alertThreshold>80</alertThreshold>
      <alertThreshold>100</alertThreshold>
    </effectiveAlertThresholds>
    <currentSpend>0.00</currentSpend>
    <currentThreshold>0</currentThreshold>
    <previousThreshold>0</previousThreshold>
    <resetDate>2012-09-01T00:00:00.000+12:00</resetDate>
  </SubscriptionValuePool>
  <SubscriptionValuePool>
    <ValuePool>
      <valuePoolId>183</valuePoolId>
      <sid>137</sid>
      <name>Included Calls</name>
      <alertThresholds>
        <alertThreshold>80</alertThreshold>
        <alertThreshold>100</alertThreshold>
      </alertThresholds>
    </ValuePool>
    <periodEnd>2012-08-31+12:00</periodEnd>
    <limit>50.00</limit>
    <effectiveAlertThresholds>
      <alertThreshold>80</alertThreshold>
      <alertThreshold>100</alertThreshold>
    </effectiveAlertThresholds>
    <currentSpend>0.00</currentSpend>
    <currentThreshold>0</currentThreshold>
    <previousThreshold>0</previousThreshold>
    <resetDate>2012-09-01T00:00:00.000+12:00</resetDate>
  </SubscriptionValuePool>
</SubscriptionValuePoolState>

Faults

NoSuchItemException


This fault is returned when the subscription does not exist.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.GetSubscriptionValuePoolStates usn
usn
Purpose: Specifies the subscription associated with the value pools.
Note: For more information about the Java client and the options it accepts, see Java client syntax.