Page Summary
-
The JSON representation defines the structure for detailing data plans offered to users, including plan details, cost, duration, and usage policies.
-
This structure includes fields for plan identification, description, promotional messages, overusage policies, and technical specifications like bandwidth and connection type.
-
It also outlines the cost, duration, and refresh periods of the plans, along with traffic categories and offer types.
-
Plan quota is represented either in bytes (
quotaBytes) or minutes (quotaMinutes), providing flexibility in defining data or voice/call plans. -
This comprehensive schema ensures clear and standardized communication of data plan details between systems and users.
Details of data plans in the offer being extended to the user.
| JSON representation | |
|---|---|
{ "planName" : string , "planId" : string , "planDescription" : string , "promoMessage" : string , "overusagePolicy" : enum ( |
|
planName
string
Required. A string which identifies the offer to the user.
planId
string
Required. A unique string that can be used to uniquely identify the offer and subsequently purchase if the user wishes.
planDescription
string
Required. A longer string which describes offer to the user.
promoMessage
string
String describing the promotion.
overusagePolicy
enum (
OverUsagePolicy
)
Determines what happens if the user ends up using more than the amount of data that is being offered. Currently supported options are: throttled, blocked, and pay-as-you-go which deducts balance from the user account.
maxRateKbps
string ( int64
format)
The maximum bandwidth that the plan offers to the user. The information could be shown to the user when the offer is presented.
cost
object (
Money
)
Required. Cost of this plan.
duration
string (
Duration
format)
Number of seconds for which the plan is valid once the plan is activated.
A duration in seconds with up to nine fractional digits, terminated by ' s
'. Example: "3.5s"
.
offerContext
string
Offer context, used in TransactionRequest message.
trafficCategories[]
enum (
PlanModuleTrafficCategory
)
List of traffic categories that will be charged against this plan module.
connectionType
enum (
ConnectionType
)
Type of connection extended as part of this offer.
refreshPeriod
enum (
RefreshPeriod
)
The refresh period of this plan offer, or REFRESH_PERIOD_NONE if the plan does not refresh its quota. Plans that refresh quota will do so once every refresh period.
offerType
enum (
OfferType
)
Identify the type of offer. Based on the type of offer, the user experience with the offer purchase can be customized by the client.
quota
. Plan quota information, should be one of the following: quota_bytes, quota_minutes. quota
can be only one of the following:quotaBytes
string ( int64
format)
Package quota in bytes.
quotaMinutes
integer
Package quota in minutes.
