REST Resource: partners.promotions
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-12 UTC.
[null,null,["Last updated 2025-03-12 UTC."],[[["\u003cp\u003eThe Promotion resource defines a promotion for a subscription that can be resold.\u003c/p\u003e\n"],["\u003cp\u003eIt includes details such as name, free trial duration, applicable regions and products, validity period, pricing details, and promotion type.\u003c/p\u003e\n"],["\u003cp\u003ePartners can find eligible promotions and retrieve a list of available promotions, including free trials, using the provided methods.\u003c/p\u003e\n"]]],["Promotions for resold subscriptions are defined by attributes like `name`, `titles`, `freeTrialDuration`, and `regionCodes`. They specify the `startTime`, `endTime`, applicable `products`, and `promotionType`. Introductory pricing is detailed in `introductoryPricingDetails`. Methods include `findEligible` to identify promotions for a user, and `list` to retrieve available promotions, such as free trial. The `JSON` representation format is provided."],null,["# REST Resource: partners.promotions\n\n- [Resource: Promotion](#Promotion)\n - [JSON representation](#Promotion.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Promotion\n-------------------\n\nA Promotion resource that defines a promotion for a subscription that can be resold.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"titles\": [ { object (/payments/reseller/subscription/reference/rest/v1/LocalizedText) } ], \"freeTrialDuration\": { object (/payments/reseller/subscription/reference/rest/v1/Duration) }, \"regionCodes\": [ string ], \"applicableProducts\": [ string ], \"startTime\": string, \"endTime\": string, \"introductoryPricingDetails\": { object (/payments/reseller/subscription/reference/rest/v1/IntroductoryPricingDetails) }, \"promotionType\": enum (/payments/reseller/subscription/reference/rest/v1/PromotionType) } ``` |\n\n| Fields ||\n|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. Response only. Resource name of the subscription promotion. It will have the format of \"partners/{partner_id}/promotion/{promotion_id}\" |\n| `titles[]` | `object (`[LocalizedText](/payments/reseller/subscription/reference/rest/v1/LocalizedText)`)` Output only. Localized human readable name of the promotion. |\n| `freeTrialDuration` | `object (`[Duration](/payments/reseller/subscription/reference/rest/v1/Duration)`)` Optional. Specifies the duration of the free trial of the subscription when promotionType is PROMOTION_TYPE_FREE_TRIAL |\n| `regionCodes[]` | `string` Output only. 2-letter ISO region code where the promotion is available in. Ex. \"US\" Please refers to: \u003chttps://en.wikipedia.org/wiki/ISO_3166-1\u003e |\n| `applicableProducts[]` | `string` Output only. The product ids this promotion can be applied to. |\n| `startTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Optional. Specifies the start time (inclusive) of the period that the promotion is available in. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `endTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `introductoryPricingDetails` | `object (`[IntroductoryPricingDetails](/payments/reseller/subscription/reference/rest/v1/IntroductoryPricingDetails)`)` Optional. Specifies the introductory pricing details when the promotionType is PROMOTION_TYPE_INTRODUCTORY_PRICING. |\n| `promotionType` | `enum (`[PromotionType](/payments/reseller/subscription/reference/rest/v1/PromotionType)`)` Output only. Specifies the type of the promotion. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------------------|-------------------------------------------------------|\n| ### [findEligible](/payments/reseller/subscription/reference/rest/v1/partners.promotions/findEligible) | Currently, it is only enabeld for **YouTube**. |\n| ### [list](/payments/reseller/subscription/reference/rest/v1/partners.promotions/list) | Currently, it doesn't support **YouTube** promotions. |"]]