getSimpleRecurringCharge()

SimpleRecurringCharge getSimpleRecurringCharge(string userAutoChargeId)

This method returns a recurring charge with the specified recurring charge ID.

Parameters

userAutoChargeId: Format: string; Purpose: Specifies the ID of the recurring charge to be returned.

Results

This method returns a recurring charge with the specified recurring charge ID.

There are no messages defined by this method.

Example: A returned SimpleRecurringCharge XML document

This example shows a SimpleRecurringCharge XML document containing a recurring charge that has UserAutoCharge ID ‘476’ when it is given as a parameter.

<SimpleRecurringCharge xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <USN>2142420989</USN>
  <SimpleRecurringCharge>
    <RecurringCharge id="476">
      <ChargeQuantity>1</ChargeQuantity>
      <Frequency type="Rating Periods">1</Frequency>
      <WhenToCharge>In Advance</WhenToCharge>
      <AdvancePeriods>1</AdvancePeriods>
      <ProRataAction>Pro-Rata</ProRataAction>
      <MinProRataDays>0</MinProRataDays>
      <LineItemDescription>
        <ItemCode>hfp</ItemCode>
        <Name>Handsfree wireless telephone handset</Name> 
        <UnitSize>1</UnitSize>
        <ChargeGst>true</ChargeGst>
        <Rate formatted="$75.00" currency="AUD">75.00000</Rate>
        <DisplayRate>$82.50</DisplayRate>
      </LineItemDescription>
      <ValidFrom>2014-09-10+10:00</ValidFrom>
   </RecurringCharge>
   <Rate formatted="$75.00" currency="AUD">75.00000</Rate>
   <DisplayRate>$82.50</DisplayRate>
  </SimpleRecurringCharge>
</SimpleRecurringCharge>

Faults

NoSuchItemException

This fault is returned when the <userAutoChargeId> element does not match a recurring charge, or the specified <LineItemDescription> element in a recurring charge does not match an item description.

Java client syntax

java -cp build/smilewsv2-client.jar [options]
 com.inomial.smile.client.v2.examples.GetSimpleRecurringCharge
 userAutoChargeId

userAutoChargeId: Purpose: Specifies the ID of the recurring charge to be returned.

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