getPlanChargeDescription()

PlanChargeDescriptionType getPlanChargeDescription(string usn, integer planScheduleItem)

This method returns a document describing the charge configuration for the subscription, according to the given plan schedule item.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription or account.
planScheduleItem: Format: integer; Purpose: Specifies a plan schedule item to also consult.

Results

This method returns a ConnectionListType XML document that contains information about the charge configuration for the subscription, according to the given plan schedule item.

The ConnectionListType XML document has a number of parts:

planScheduleItem—details of the plan schedule item
planConfiguration - charging details of the plan. It includes both recurring charges, and usage charging rules.
planScheduleItemOverrides—the overrides to the plan configuration from the plan schedule item. Any non-empty fields are considered to be overrides for the values in the plan configuration.

There are no messages defined by this method.

Example: A returned ConnectionListType XML document

This example shows a ConnectionListType XML document with two connection historys and has no more existing results.

<PlanChargeDescription xmlns="http://xml.inomial.com/smile/2.xsd">
  <PlanScheduleItem>
    <PlanCode>tp2841</PlanCode>
    <PlanScheduleType>1</PlanScheduleType>
    <Start>2013-05-10T00:00:00.000+10:00</Start>
    <Options>
      <Object>
        <Integer name="option1">49</Integer>
        <Integer name="option2">1</Integer>
      </Object>
    </Options>
    <PlanScheduleItem>417</PlanScheduleItem>
  </PlanScheduleItem>
  <PlanConfiguration>
    <RecurringCharges>
      <RecurringCharge id="223">
        <ChargeQuantity>1</ChargeQuantity>
        <Frequency type="Rating Periods">1</Frequency>
        <WhenToCharge>In Advance</WhenToCharge>
        <AdvancePeriods>1</AdvancePeriods>
        <ProRataAction>Pro-Rata</ProRataAction>
        <MinProRataDays>1</MinProRataDays>
        <LineItemDescription>
          <ItemCode>002307</ItemCode>
          <Name>Invoice item description</Name>
          <UnitSize>1</UnitSize>
          <ChargeGst>true</ChargeGst>
          <Rate currency="AUD" formatted="$100.00">100</Rate>
          <DisplayRate>$100.00 excludes GST</DisplayRate>
        </LineItemDescription>
        <ValidFrom>2013-05-10+10:00</ValidFrom>
      </RecurringCharge>
      <RecurringCharge id="224">
        <ChargeQuantity>1</ChargeQuantity>
        <Frequency type="Rating Periods">1</Frequency>
        <WhenToCharge>In Advance</WhenToCharge>
        <AdvancePeriods>1</AdvancePeriods>
        <ProRataAction>Pro-Rata</ProRataAction>
        <MinProRataDays>1</MinProRataDays>
        <LineItemDescription>
          <ItemCode>002308</ItemCode>
          <Name>Invoice item description</Name>
          <UnitSize>1</UnitSize>
          <ChargeGst>true</ChargeGst>
          <Rate currency="AUD" formatted="$90.00">90</Rate>
        </LineItemDescription>
      </RecurringCharge>
    </RecurringCharges>
    <PlanOptions>
      <PlanOption option="option1">
        <Name>Option 1</Name>
        <DisplayType>NUMERIC</DisplayType>
        <MinimumQuantity>1</MinimumQuantity>
        <MaximumQuantity>100</MaximumQuantity>
        <RecurringCharges>
          <RecurringCharge id="225">
            <ChargeQuantity>1</ChargeQuantity>
            <Frequency type="Rating Periods">1</Frequency>
            <WhenToCharge>In Advance</WhenToCharge>
            <AdvancePeriods>1</AdvancePeriods>
            <ProRataAction>Pro-Rata</ProRataAction>
            <MinProRataDays>1</MinProRataDays>
            <LineItemDescription>
              <ItemCode>002309</ItemCode>
              <Name>Invoice item description</Name>
              <UnitSize>1</UnitSize>
              <ChargeGst>true</ChargeGst>
              <Rate currency="AUD" formatted="$25.60">25.6</Rate>
            </LineItemDescription>
          </RecurringCharge>
        </RecurringCharges>
      </PlanOption>
      <PlanOption option="option2">
        <Name>Option 2</Name>
        <DisplayType>BOOLEAN</DisplayType>
        <Group key="223">testOptionGroup1</Group>
        <RecurringCharges/>
      </PlanOption>
    </PlanOptions>
    <ChargingRules>
      <ChargingRule id="1040">
        <ChargeType key="0">Online time</ChargeType>
        <LineItemDescription>
          <ItemCode>002310</ItemCode>
          <Name>This goes on the invoice</Name>
          <UnitSize>1</UnitSize>
          <ChargeGst>true</ChargeGst>
          <Rate currency="AUD" formatted="$9.50">9.5</Rate>
          <DisplayRate>$9.5 per unit</DisplayRate>
        </LineItemDescription>
        <RateSource>
          <FixedCharge>
            <Rate currency="AUD" formatted="$9.50">9.5</Rate>
            <PerUnit unitQuantity="1">second</PerUnit>
          </FixedCharge>
        </RateSource>
        <Constraints>
          <DaysOfWeek>
            <DayOfWeek>Friday</DayOfWeek>
          </DaysOfWeek>
          <FromDate>2013-05-10+10:00</FromDate>
          <ToDate>2013-05-12+10:00</ToDate>
          <FromTime>00:00:00.000+10:00</FromTime>
          <ToTime>23:59:59.000+10:00</ToTime>
          <PlanOption key="223">Option 1</PlanOption>
          <MaximumUnits>5000.000</MaximumUnits>
          <MaximumUnitsPerDayOptionMultiplier>2</MaximumUnitsPerDayOptionMultiplier>
          <MaximumUnitsPerSession>3000.000</MaximumUnitsPerSession>
          <MaximumSessionLengthSeconds>1000000</MaximumSessionLengthSeconds>
        </Constraints>
        <PrepaidRules/>
        <AppliesFeatures>
          <Feature key="224">Test Feature 224</Feature>
        </AppliesFeatures>
        <IncludedValuePoolRef key="813">Cap</IncludedValuePoolRef>
      </ChargingRule>
      <ChargingRule id="1041">
        <ChargeType key="1">Downloaded Data</ChargeType>
        <LineItemDescription>
          <ItemCode>002311</ItemCode>
          <Name>Downloaded Data</Name>
          <UnitSize>1</UnitSize>
          <ChargeGst>true</ChargeGst>
          <Rate currency="AUD" formatted="$0.00">0</Rate>
        </LineItemDescription>
        <RateSource>
          <Tariff>Rate</Tariff>
        </RateSource>
        <Constraints>
          <DaysOfWeek all="true"/>
        </Constraints>
        <PrepaidRules/>
      </ChargingRule>
    </ChargingRules>
    <IncludedValuePools>
      <IncludedValuePool id="813">
        <Name>Cap</Name>
        <ValueIncTax currency="AUD" formatted="$0.00">0.00</ValueIncTax>
      </IncludedValuePool>
    </IncludedValuePools>
  </PlanConfiguration>
  <PlanScheduleItemOverrides>
    <RecurringCharges>
      <RecurringCharge id="223">
        <Rate currency="AUD" formatted="$34.00">34</Rate>
        <Comment>This is override invoice comment</Comment>
        <ChargeQuantity>19</ChargeQuantity>
        <Description>overrides description</Description>
        <Frequency type="Rating Periods">1</Frequency>
        <WhenToCharge>In Advance</WhenToCharge>
        <AdvancePeriods>2</AdvancePeriods>
      </RecurringCharge>
    </RecurringCharges>
    <ChargingRules/>
  </PlanScheduleItemOverrides>
</PlanChargeDescription>

Faults

NoSuchItemException

This fault is returned when the specified USN does not match an account or subscription, or the specified plan schedule item does not exist

InvalidRequestException

This fault is returned when the specified plan schedule item does not match the specified account or subscription.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription associated with the plans.
planScheduleItem: Purpose: Specifies a plan schedule item to also consult.

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