updateSubscriptionContract()

void updateSubscriptionContract(string usn, SubscriptionContract subscriptionContract)

This method updates the given subscription contract with new values.

Note that many values of contracts are immutable. You can only update the following parameters:

comments
contract value
early termination charge
start date
end date
maximum termination charge
minimum termination charge

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription to update.
subscriptionContract: Format: SubscriptionContract XML; Purpose: Defines a SubscriptionContract XML document that specifies the contract values to update.

Example: Update a subscription contract

This example shows a request to update subscription contract 476 for subscription 2142422589.

<SubscriptionContract xmlns="http://xml.inomial.com/smile/2.xsd" xmlns="http://ws.inomial.com/smile.2">
  <SubscriptionContractId>476</SubscriptionContractId>
  <Contract key="399">12 Month</Contract>
  <USN>2142422589</USN>
  <EarlyTerminationCharge currency="AUD" formatted="$0.00">0</EarlyTerminationCharge>
  <StartDate>2014-08-28+10:00</StartDate>
  <EndDate>2015-08-27+10:00</EndDate>
  <ContractValue currency="AUD" formatted="$360.00">360.000000</ContractValue>
  <MinimumTerminationCharge currency="AUD" formatted="$0.00">0</MinimumTerminationCharge>
  <MaximumTerminationCharge currency="AUD" formatted="$0.00">0</MaximumTerminationCharge>
</SubscriptionContract>

Results

This method does not return any output.

Smile emits the RatingConfigurationUpdated message when the subscription contract is updated.

Faults

ContractOverlapException

This fault is returned when changing the start or end date causes the contract to overlap with another contract.

NoSuchItemException

This fault is returned when the contract or subscription does not exist.

InvalidContractException

This fault is returned when an attempt is made to modify an immutable property of a contract, or if the contract ID or USN elements is missing.

InvalidRequestException

This fault is returned when the request is invalid.

Java client syntax

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

usn: Purpose: Specifies the USN of the subscription to update.
filename: Purpose: Defines the filename of the SubscriptionContract XML document.

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