REST Resource: operators.planStatuses
Stay organized with collections
Save and categorize content based on your preferences.
Resource: PlanStatus
PlanStatus contains details of all top-level mobile service package a user has purchased.
| JSON representation |
{
"name": string,
"plans": [
{
object (Plan)
}
],
"languageCode": string,
"expireTime": string,
"updateTime": string,
"title": string,
"subscriberId": string,
"accountInfo": {
object (AccountInfo)
},
"uiCompatibility": enum (UiCompatibility),
"notifications": [
enum (NotificationType)
],
"planInfoPerClient": {
object (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 (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 (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".
|
updateTime |
string (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".
|
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 (AccountInfo)
Required for prepaid users. Information about the user account balance.
|
uiCompatibility |
enum (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 (NotificationType)
The types of notifications that have been sent to the user.
|
planInfoPerClient |
object (PlanInfoPerClient)
|
Methods |
|
|
Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-10-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-03 UTC."],[[["\u003cp\u003ePlanStatus provides details of all top-level mobile service packages purchased by a user, including plan information, account balance (for prepaid users), and notification types.\u003c/p\u003e\n"],["\u003cp\u003eIt includes fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003eplans\u003c/code\u003e, \u003ccode\u003elanguageCode\u003c/code\u003e, \u003ccode\u003eexpireTime\u003c/code\u003e, \u003ccode\u003eupdateTime\u003c/code\u003e, \u003ccode\u003etitle\u003c/code\u003e, \u003ccode\u003esubscriberId\u003c/code\u003e, \u003ccode\u003eaccountInfo\u003c/code\u003e, \u003ccode\u003euiCompatibility\u003c/code\u003e, \u003ccode\u003enotifications\u003c/code\u003e, and \u003ccode\u003eplanInfoPerClient\u003c/code\u003e, providing comprehensive data about the user's mobile service package.\u003c/p\u003e\n"],["\u003cp\u003ePlanStatus resources are identified by a unique name in the format \u003ccode\u003eoperators/{asn_id}/planStatuses/{userKey}\u003c/code\u003e and have a JSON representation for data exchange.\u003c/p\u003e\n"],["\u003cp\u003eMobile operators can create new PlanStatus entries using the \u003ccode\u003ecreate\u003c/code\u003e method, allowing them to manage and update user plan information.\u003c/p\u003e\n"]]],["PlanStatus details mobile service packages purchased by a user. Key data includes the user's `name`, associated `plans`, `languageCode`, and `subscriberId`. It specifies `expireTime` and `updateTime` for the data's validity. `accountInfo` is required for prepaid users. `uiCompatibility` determines display status, and `notifications` lists sent alerts. A mobile operator can use the `create` method to add new PlanStatus entries, as identified by their unique Autonomous System Number.\n"],null,["# REST Resource: operators.planStatuses\n\n- [Resource: PlanStatus](#PlanStatus)\n - [JSON representation](#PlanStatus.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: PlanStatus\n--------------------\n\nPlanStatus contains details of all top-level mobile service package a user has purchased.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"plans\": [ { object (/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Plan) } ], \"languageCode\": string, \"expireTime\": string, \"updateTime\": string, \"title\": string, \"subscriberId\": string, \"accountInfo\": { object (/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.AccountInfo) }, \"uiCompatibility\": enum (/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.UiCompatibility), \"notifications\": [ enum (/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.NotificationType) ], \"planInfoPerClient\": { object (/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.PlanInfoPerClient) } } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `plans[]` | `object (`[Plan](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Plan)`)` List of plans owned by this user. |\n| `languageCode` | `string` Required. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see \u003chttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier\u003e. |\n| `expireTime` | `string (`[Timestamp](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\"`. \u003cbr /\u003e |\n| `updateTime` | `string (`[Timestamp](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\"`. \u003cbr /\u003e |\n| `title` | `string` Title of the contract that user has with the operator. This will be shown in the UI header. |\n| `subscriberId` | `string` Unique stable identifier in carrier system to identify the user. |\n| `accountInfo` | `object (`[AccountInfo](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.AccountInfo)`)` Required for prepaid users. Information about the user account balance. |\n| `uiCompatibility` | `enum (`[UiCompatibility](/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. |\n| `notifications[]` | `enum (`[NotificationType](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.NotificationType)`)` The types of notifications that have been sent to the user. |\n| `planInfoPerClient` | `object (`[PlanInfoPerClient](/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.PlanInfoPerClient)`)` |\n\n| Methods ------- ||\n|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| ### [create](/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. |"]]