Usage (Plans schema)

Article
05/13/2021

Defines the state of a subscriber's data usage on a connection to a Mobile Network Operator (MNO). UWP apps can retrieve this information using the DataPlanStatus class.

Element hierarchy

<Plan>: <Usage>

Syntax

<Usage OverLimit?     = boolean
       Congested?     = boolean
       CurrentUsage   = nonNegativeInteger
       UsageTimestamp = dateTime />

Key

? optional (zero or one)

Attributes and Elements

Attributes

Attribute	Description	Data type	Required
Congested	If true, the network is experiencing unusually heavy load and requesting clients to defer transfers. Otherwise, false.	boolean	No
CurrentUsage	Defines a value representing the data used to-date within the current billing cycle in MB. Must be a value from 0 to 2^32nd.	nonNegativeInteger	Yes
OverLimit	If true, the user has passed their allotted usage (if PlanType is Fixed). Otherwise, false.	boolean	No
UsageTimestamp	A value representing the date and time in UTC the data usage profile data was last updated by the MNO.	dateTime	Yes

Child Elements

None.

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`

Share via