Use the switch-subscription operation to associate a subscription with a different service plan.
Request Packet Structure
A request XML packet that switches a subscription to a different service plan includes the switch-subscription operation node:
The switch-subscription node (
domain_input.xsd) has the following graphical representation:
- The filter node is required. It specifies a filtering rule. For info on filters, refer to the Available Filters section. Data type: domainFilterType (
- The plan-guid node is required. It specifies the GUID of a plan. Data type: string.
- The plan-external-id node is required. It specifies the ID of a service plan in the Panel components (for example, Business Manager). Data type: string.
- The no-plan node is required. Use this node if want a subscription that is not associated with any of the service plans. Data type: none.
Response Packet Structure
The switch-subscription node of the output XML packet is structured as follows:
- The result node is required. It wraps the response retrieved from the server. Data type: ResultFilterType (
- The status node is required. It specifies the execution status of the operation. Data type: string. Allowed values: ok | error.
- The errcode node is optional. It is used to return the error code when the operation fails. Data type: unsignedInt.
- The errtext node is optional. Can be used to return the error message if the operation fails. Data type: string.
- The filter-id node is optional. It is required if the operation succeeds. Returns a filtering rule. For info on filters, refer to the Available Filters section. Data type: anySimple.
- The id node is optional. It is required if the operation succeeds. Returns the unique identifier of the subscription. Data type: integer.
- The problems node is optional. It outputs conflicts that occur on performing the operation. Data type: string.
Note: The problems node outputs a table with these columns: Description, Current, Requested, Allowed. The Description column holds the subscription option name (limit, permission, hosting setting). The Current column contains the current value of the option. The Requested column contains the requested value for the option. The Allowed column contains the changed values. The other values remain in the Current state after the operation is performed.
The request packet that switches the subscription with ID 5 to the plan with GUID cc982f71-48c3-479d-bc7b-59b97547e092 looks as follows: