Description (Plans schema)

Article
05/13/2021

Defines plan information that specifies the subscriber's Mobile Network Operator (MNO) connection type.

Element hierarchy

<Plan>: <Description>

Syntax

<Description PlanType = "Unrestricted" | "Fixed" | "Variable" >

  <!-- Child elements -->
  BillingCycle?,
  DataLimitInMegabytes?,
  InboundBandwidthInKbps?,
  OutboundBandwidthInKbps?,
  MaxTransferSizeInMegabytes?,
  SecurityUpdatesExempt?,
  DataUsageInMobileOperatorNotificationEnabled?,
  UserSMSEnabled?

</Description>

Key

? optional (zero or one)

Attributes and Elements

Attributes

Attribute	Description	Data type	Required	Default value
PlanType	Defines the data usage of the subscriber's connection: Unrestricted - the connection is unlimited and is considered to be unrestricted of usage charges and capacity constraints. Fixed - the use of this connection is unrestricted up to a certain cap. Variable - this connection is costed on a per byte basis.	This attribute can have one of the following values: Unrestricted Fixed Variable	Yes

PlanType

Defines the data usage of the subscriber's connection:

Unrestricted - the connection is unlimited and is considered to be unrestricted of usage charges and capacity constraints. Fixed - the use of this connection is unrestricted up to a certain cap. Variable - this connection is costed on a per byte basis.

This attribute can have one of the following values:

Unrestricted
Fixed
Variable

Yes

Child Elements

Child Element	Description
BillingCycle	Defines the plan's starting date and time, its duration, and what happens at the end of the billing cycle. UWP apps can retrieve this information using the DataPlanStatus class.
DataLimitInMegabytes	Defines a value representing the data limit in MB for a capped plan. Must be a value from 0 to 2^32nd. UWP apps can retrieve this information using the DataPlanStatus class.
DataUsageInMobileOperatorNotificationEnabled	Indicates whether the NetworkOperatorNotificationTrigger should include data usage notifications. If true, Windows raises this trigger when the data usage threshold is met.
InboundBandwidthInKbps	Defines a value representing the effective link speed of the subscriber’s inbound connection specified in Kbps. Must be a value from 0 to 2^32nd. UWP apps can retrieve this information using the DataPlanStatus class.
MaxTransferSizeInMegabytes	Defines the size of an individual download in MB which a compliant application should permit over a metered connection without explicit user approval of the connection being used. Must be a value from 0 to 2^32nd. UWP apps can retrieve this information using the DataPlanStatus class.
OutboundBandwidthInKbps	Defines a value representing the effective link speed of the subscriber’s outbound connection specified in Kbps. Must be a value from 0 to 2^32nd. UWP apps can retrieve this information using the DataPlanStatus class.
SecurityUpdatesExempt	If true, the MNO advises Windows Update (WU) that security updates are exempt from being counted as data usage against the subscriber’s plan and WU will download all security patches when on a metered network. Otherwise, WU will only download zero-day patches and not all security updates when false.
UserSMSEnabled	Indicates whether the subscriber's service includes user-to-user SMS which must be delivered in near real-time. If true, Windows will employ less aggressive power management on the Mobile Broadband interface to allow SMS messages to arrive more quickly. If false, the mobile broadband radio may be turned off during periods of inactivity. SMS messages will arrive when the PC is next active.

Parent Elements

Parent Element	Description
Plan	Defines a set of plan information that specifies the data usage options and state of a subscriber's connection to a Mobile Network Operator (MNO). Plan is the unique root element for plan information

Requirements

	Value
Namespace	`http://www.microsoft.com/networking/CarrierControl/Plans/v1`