changeManagedPlanGroup()

void changeManagedPlanGroup(string usn, string managedPlanGroupId, string managedPlanChoiceId, ManagedPlanChangeTiming managedPlanChangeTiming, PlanOptions planOptions)

This method changes the managed plan group that a subscription belongs to.

Note that this operation does not raise any charges as the change is between two groups.

Parameters

usn: Format: string; Purpose: Specifies the USN of the subscription.
managedPlanGroupId: Format: string; Purpose: Specifies the ID of a managed plan group.
managedPlanChoiceId: Format: string; Purpose: Specifies the ID of a managed plan choice. The plan choice must correspond to the managed plan group.
managedPlanChangeTiming: Format: ManagedPlanChangeTiming XML; Purpose: Specifies the details of when the plan change is effective.
planOptions: Format: PlanOptions XML; Purpose: (Optional) Specifies plan option overrides for the plan change.
The PlanOptions XML type is ObjectType. Plan options and sub-elements can only be boolean or integer, with name as the name of the option, and the value is the value of the option.

Note: This element is optional, but as a plan can specify that certain plan options are required, billing errors may be produced if required options are not correctly configured.

Results

This method returns void.

There are no messages defined by this method.

Faults

NoSuchItemException

This fault is returned when the USN provided does not have a corresponding subscription.

PlanChangeException

This fault is returned when an internal error or configuration problem prevents the request from being processed.

InvalidRequestException

This fault is returned when the USN, managedPlanGroupId and managedPlanChoiceId are not compatible.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.ChangeManagedPlanGroup usn
 managedPlanGroupId managedPlanChoiceId managedPlanChangeTiming [filename]

usn: Purpose: Specifies the USN of the subscription.
mangedPlanGroupId: Purpose: Specifies the ID of a managed plan group.
managedPlanChoiceId: Purpose: Specifies the ID of a managed plan choice.
managedPlanChangeTiming: Purpose: Defines the filename of the ManagedPlanChangeTiming XML document.
filename: Purpose: (Optional) Defines the filename of the PlanOptions XML document.

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