REST Resource: operators.planStatuses

    • PlanStatus provides details of all top-level mobile service packages purchased by a user, including plan information, account balance (for prepaid users), and notification types.

    • It includes fields like name , plans , languageCode , expireTime , updateTime , title , subscriberId , accountInfo , uiCompatibility , notifications , and planInfoPerClient , providing comprehensive data about the user's mobile service package.

    • PlanStatus resources are identified by a unique name in the format operators/{asn_id}/planStatuses/{userKey} and have a JSON representation for data exchange.

    • Mobile operators can create new PlanStatus entries using the create method, allowing them to manage and update user plan information.

    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

    create

    		Allows a mobile operator (identified by its unique Autonomous System Number (ASN)) to add new PlanStatus entry.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: