Offer

JSON representation

Details of data plans in the offer being extended to the user.

JSON representation

JSON representation
{ "planName": string, "planId": string, "planDescription": string, "promoMessage": string, "languageCode": string, "overusagePolicy": enum (`OverUsagePolicy`), "maxRateKbps": string, "cost": { object (`Money`) }, "duration": string, "offerContext": string, "trafficCategories": [ enum (`PlanModuleTrafficCategory`) ], "connectionType": enum (`ConnectionType`), "refreshPeriod": enum (`RefreshPeriod`), "offerType": enum (`OfferType`), // Union field `quota` can be only one of the following: "quotaBytes": string, "quotaMinutes": number // End of list of possible types for union field `quota`. }

{
  "planName": string,
  "planId": string,
  "planDescription": string,
  "promoMessage": string,
  "languageCode": string,
  "overusagePolicy": enum (OverUsagePolicy),
  "maxRateKbps": string,
  "cost": {
    object (Money)
  },
  "duration": string,
  "offerContext": string,
  "trafficCategories": [
    enum (PlanModuleTrafficCategory)
  ],
  "connectionType": enum (ConnectionType),
  "refreshPeriod": enum (RefreshPeriod),
  "offerType": enum (OfferType),

  // Union field quota can be only one of the following:
  "quotaBytes": string,
  "quotaMinutes": number
  // End of list of possible types for union field quota.
}

Fields
`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.
`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.
`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.
Union field `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`	`number` Package quota in minutes.