# Offer

- [JSON representation](https://developers.google.com/mobile-data-plan/v6_1/reference/rest/v1/Offer#SCHEMA_REPRESENTATION)

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

| JSON representation ||
|---|---|
| ``` { "planName": string, "planId": string, "planDescription": string, "promoMessage": string, "languageCode": string, "overusagePolicy": enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.OverUsagePolicy`), "maxRateKbps": string, "cost": { object (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Money`) }, "duration": string, "offerContext": string, "trafficCategories": [ enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.PlanModuleTrafficCategory`) ], "connectionType": enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/ConnectionType`), "refreshPeriod": enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.RefreshPeriod`), "offerType": enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/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 (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.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 (https://developers.google.com/discovery/v1/type-format 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 (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.Money`)`` Required. Cost of this plan. |
| `duration` | ``string (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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"`. <br /> |
| `offerContext` | `string` Offer context, used in TransactionRequest message. |
| `trafficCategories[]` | ``enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.PlanModuleTrafficCategory`)`` List of traffic categories that will be charged against this plan module. |
| `connectionType` | ``enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/ConnectionType`)`` Type of connection extended as part of this offer. |
| `refreshPeriod` | ``enum (`https://developers.google.com/mobile-data-plan/reference/rest/v1/operators.clients.users.planStatus#PlanStatus.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 (`https://developers.google.com/mobile-data-plan/reference/rest/v1/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 (https://developers.google.com/discovery/v1/type-format format)` Package quota in bytes. |
| `quotaMinutes` | `number` Package quota in minutes. |