# REST Resource: operators.planStatuses

- [Resource: PlanStatus](https://developers.google.com/mobile-data-plan/v6_1/reference/rest/v1/operators.planStatuses#PlanStatus)
  - [JSON representation](https://developers.google.com/mobile-data-plan/v6_1/reference/rest/v1/operators.planStatuses#PlanStatus.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/mobile-data-plan/v6_1/reference/rest/v1/operators.planStatuses#METHODS_SUMMARY)

## Resource: PlanStatus

PlanStatus contains details of all top-level mobile service package a user has purchased.

| JSON representation ||
|---|---|
| ``` { "name": string, "plans": [ { object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Plan`) } ], "languageCode": string, "expireTime": string, "updateTime": string, "title": string, "subscriberId": string, "accountInfo": { object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.AccountInfo`) }, "uiCompatibility": enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.UiCompatibility`), "notifications": [ enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.NotificationType`) ], "planInfoPerClient": { object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.PlanInfoPerClient`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` The resource name of the PlanStatus in the following format: `operators/{asn_id}/planStatuses/{userKey}`. The name is ignored when creating a PlanStatus entry. |
| `plans[]` | ``object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Plan`)`` List of plans owned by this user. |
| `languageCode` | `string` Required. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see <http://www.unicode.org/reports/tr35/#Unicode_locale_identifier>. |
| `expireTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Required. Time when the shared plan group information becomes outdated. PlanStatus will not be served to applications after this time. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. <br /> |
| `updateTime` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp` format)`` Required. Time when the data plan agent (DPA) fetched the plan status information from backend systems. Could be used to determine how recent the plan status information is. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. <br /> |
| `title` | `string` Title of the contract that user has with the operator. This will be shown in the UI header. |
| `subscriberId` | `string` Unique stable identifier in carrier system to identify the user. |
| `accountInfo` | ``object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.AccountInfo`)`` Required for prepaid users. Information about the user account balance. |
| `uiCompatibility` | ``enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.UiCompatibility`)`` Determines if the PlanStatus can be shown to the user in a user interface. When set to UI_INCOMPATIBLE, the PlanStatus can be used for sending notifications to the user but will not be used for showing the plan information to user. |
| `notifications[]` | ``enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.NotificationType`)`` The types of notifications that have been sent to the user. |
| `planInfoPerClient` | ``object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.PlanInfoPerClient`)`` |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.planStatuses/create` | Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry. |