---
title: "POST /v1/partners/{partnersId}/promotions:findEligible"
method: POST
path: "/v1/partners/{partnersId}/promotions:findEligible"
tags: ["partners"]
---

# POST /v1/partners/{partnersId}/promotions:findEligible

`POST /v1/partners/{partnersId}/promotions:findEligible`

## Request

- Base URL: `https://paymentsresellersubscription.googleapis.com`
- URL: `https://paymentsresellersubscription.googleapis.com/v1/partners/{partnersId}/promotions:findEligible`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/sdm.service`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/sdm.service`

Currently, it is only enabled for **YouTube**. Finds eligible promotions for the current user. The API requires user authorization via OAuth. The bare minimum oauth scope `openid` is sufficient, which will skip the consent screen.

## Path parameters

- `partnersId` string, required

## Request body

- FindEligiblePromotionsRequest: Request to find eligible promotions for the current user.
  - `filter` string: Optional. Specifies the filters for the promotion results. The syntax is defined in https://google.aip.dev/160 with the following caveats: 1. Only the following features are supported: - Logical operator `AND` - Comparison operator `=` (no wildcards `*`) - Traversal operator `.` - Has operator `:` (no wildcards `*`) 2. Only the following fields are supported: - `applicableProducts` - `regionCodes` - `youtubePayload.partnerEligibilityId` - `youtubePayload.postalCode` 3. Unless explicitly mentioned above, other features are not supported. Example: `applicableProducts:partners/partner1/products/product1 AND regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id`
  - `pageSize` integer: Optional. The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 promotions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
  - `pageToken` string: Optional. A page token, received from a previous `FindEligiblePromotions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FindEligiblePromotions` must match the call that provided the page token.

## Response `200`

Successful response

- FindEligiblePromotionsResponse: Response containing the found promotions for the current user.
  - `nextPageToken` string: A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
  - `promotions` Promotion[]: The promotions for the current user.
    - `applicableProducts` string[]: Output only. The product ids this promotion can be applied to.
    - `endTime` string, google-datetime: Optional. Specifies the end time (exclusive) of the period that the promotion is available in. If unset, the promotion is available indefinitely.
    - `freeTrialDuration` Duration: Describes the length of a period of a time.
      - `count` integer: number of duration units to be included.
      - `unit` 'UNIT_UNSPECIFIED' | 'MONTH' | 'DAY' | 'HOUR': The unit used for the duration
    - `introductoryPricingDetails` PromotionIntroductoryPricingDetails: The details of a introductory pricing promotion.
      - `introductoryPricingSpecs` PromotionIntroductoryPricingDetailsIntroductoryPricingSpec[]: Output only. Specifies the introductory pricing periods.
        - `discountAmount` Amount: Describes the amount unit including the currency code.
          - `amountMicros` string, int64: Required. Amount in micros (1_000_000 micros = 1 currency unit)
          - `currencyCode` string: Required. Currency codes in accordance with [ISO-4217 Currency Codes] (https://en.wikipedia.org/wiki/ISO_4217). For example, USD.
        - `discountRatioMicros` string, int64: Output only. The discount percentage in micros. For example, 50,000 represents 5%.
        - `recurrenceCount` integer: Output only. The duration of an introductory offer in billing cycles.
        - `regionCode` string: Output only. 2-letter ISO region code where the product is available in. Ex. "US".
    - `name` string: Identifier. Response only. Resource name of the subscription promotion. It will have the format of "partners/{partner_id}/promotion/{promotion_id}"
    - `promotionType` 'PROMOTION_TYPE_UNSPECIFIED' | 'PROMOTION_TYPE_FREE_TRIAL' | 'PROMOTION_TYPE_INTRODUCTORY_PRICING': Output only. Specifies the type of the promotion.
    - `regionCodes` string[]: Output only. 2-letter ISO region code where the promotion is available in. Ex. "US" Please refer to: https://en.wikipedia.org/wiki/ISO_3166-1
    - `startTime` string, google-datetime: Optional. Specifies the start time (inclusive) of the period that the promotion is available in.
    - `titles` GoogleTypeLocalizedText[]: Output only. Localized human readable name of the promotion.
      - `languageCode` string: The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
      - `text` string: Localized string in the language corresponding to language_code below.

---

[API](https://skmtc.dev/google/apis/paymentsresellersubscription.md) - [All operations](https://skmtc.dev/google/apis/paymentsresellersubscription/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/paymentsresellersubscription/revisions/88dd477f884b?raw)