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)
  },
  "cpidState": enum (CpidState)
}
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. Expire time must be in the future.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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. Update time must be in the past but cannot be more than 30 days old.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "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)

Contains the list of types of notifications sent to the user by GTAF. GTAF ignores this field if it is populated by the caller.

planInfoPerClient

object (PlanInfoPerClient)

Data plan information relevant to a particular Google client.

cpidState

enum (CpidState)

Status of the CPID for associated with this plan status.

Methods

create

Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry.