getSubscriptionPlans()

PlanConfigurations getSubscriptionPlans(string usn, date timestamp)

This method returns a list of published plans available to a subscription. Available plans may also be listed at a specific date and time.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription for which to return available plans.
timestamp: Format: date; Purpose: (Optional) Specifies a specific point in time at which to list available plans.

Results

This method returns a list of published plans available for the subscription. The private plans of an account that this subscription belongs to will be included in the returned list. If you do not specify a date and time, it will return a list of valid plans at the time the request is sent.

There are no messages defined by this method.

Example: A returned PlanConfigurationsType XML document

This example shows a PlanConfigurationsType XML document when subscription USN and, optional, date and time are given as parameters. Each <PlanConfiguration> element contains information about the plan.

<PlanConfigurations xmlns:ns2="http://xml.inomial.com/smile/2.xsd" xmlns:ns3="http://ws.inomial.com/smile.2">
  <PlanConfiguration>
    <Plan>tp858_1</Plan>
    <PlanName>Test plan 858 _1</PlanName>
    <Company>1</Company>
    <RecurringCharges/>
    <PlanOptions/>
    <ChargingRules/>
    <IncludedValuePools>
      <IncludedValuePool id="2455">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
  <PlanConfiguration>
    <Plan>tp858_2</Plan>
    <PlanName>Test plan 858 _2</PlanName>
    <Company>1</Company>
    <RecurringCharges/>
    <PlanOptions/>
    <ChargingRules/>
    <IncludedValuePools>
      <IncludedValuePool id="2457">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
  <PlanConfiguration>
    <Plan>tpp859</Plan>
    <PlanName>Test private plan 859</PlanName>
    <Company>1</Company>
    <RecurringCharges/>
    <PlanOptions/>
    <ChargingRules/>
    <IncludedValuePools>
      <IncludedValuePool id="2467">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
</PlanConfigurations>

Faults

NoSuchItemException

This fault is returned when the specified USN does not match a subscription.

InvalidRequestException

This fault is returned when the subscription USN is not provided as a parameter.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetSubscriptionPlans usn [timestamp]

usn: Purpose: Specifies the USN of the subscription for which to return available plans.
timestamp: Purpose: (Optional) Specifies a specific point in time at which to list available plans.

Note: For more information about the Java client and the options it accepts, see Java client syntax.