assignedPlan resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

The assignedPlans property of both the user entity and the organization entity is a collection of assignedPlan.

Properties

Property Type Description
assignedDateTime DateTimeOffset The date and time at which the plan was assigned; for example: 2013-01-02T19:32:30Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
capabilityStatus capabilityStatus Condition of the capability assignment. The possible values are Enabled, Warning, Suspended, Deleted, LockedOut.
service String The name of the service; for example, exchange.
servicePlanId Guid A GUID that identifies the service plan. For a complete list of GUIDs and their equivalent friendly service names, see Product names and service plan identifiers for licensing.

capabilityStatus values

The following table describes the possible statuses for the capabilityStatus of a subscription. The members are listed in the order of their transition if the license isn't renewed.

Member Description
Enabled Available for normal use and assignment.
Warning Available for normal use and assignment but is in a grace period.
Suspended Unavailable for assignment but any data associated with the capability must be preserved.
LockedOut Unavailable for all administrators and users for assignment but any data associated with the capability must be preserved. This is the state after Suspended and if the license isn't renewed, it is the final state before the plan is Deleted.
Deleted Unavailable and any data associated with the capability may be deleted.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "assignedDateTime": "String (timestamp)",
  "capabilityStatus": "String",
  "service": "String",
  "servicePlanId": "Guid"
}