Skip to content
HeyX API

List Discounts

Required scope: catalog:read

Returns active discounts that can be attached to a quote. Results can be limited to one catalog folder. pageSize defaults to 100 and is capped at 100. countryPrices contains the country-specific grand-total discount rows used by CreateQuote, including each row’s country-derived currency, discount types, and recurring duration modes. productDiscounts contains product-specific links and their country, currency, price type, and optional duration. Use these fields to determine whether a discount is available for a quote’s pricingCountry and selected product price type. The top-level discount fields remain the legacy/default representation.

Discount types are serialized as protobuf enum names in JSON: PUBLIC_DISCOUNT_TYPE_PERCENTAGE or PUBLIC_DISCOUNT_TYPE_FIXED.

Generated Reference
POST /public-api/publicapi.v1.Catalog/ListDiscounts

Lists active discounts available to the API key actor.

Request ListDiscountsRequest
Response ListDiscountsResponse

ListDiscountsRequest

Field Type
folder_id optional string
page_size int32

ListDiscountsResponse

Field Type
discounts repeated Discount

Related Types

Discount

Field Type
id string
folder_id optional string
name string
description string
discount_group string
discount_once optional int32
discount_once_type DiscountType
discount_monthly optional int32
discount_monthly_type DiscountType
discount_yearly optional int32
discount_yearly_type DiscountType
is_active bool
country_prices repeated DiscountCountryPrice
product_discounts repeated ProductDiscount

DiscountCountryPrice

Field Type
country_code string
currency string
discount_once optional int32
discount_once_type DiscountType
discount_monthly optional int32
discount_monthly_type DiscountType
discount_yearly optional int32
discount_yearly_type DiscountType
discount_monthly_duration_mode string
discount_yearly_duration_mode string

ProductDiscount

Field Type
id string
discount_id string
product_id string
product_name string
discount_type DiscountType
discount_amount int32
duration_months optional int32
duration_years optional int32
price_type PriceType
country_code string
currency string

Request

Section titled “Request”
{
  "folderId": "<catalog-folder-id>",
  "pageSize": 50
}

Response

Section titled “Response”
{
  "discounts": [
    {
      "id": "<discount-id>",
      "name": "Launch promotion",
      "description": "One-time promotional discount",
      "discountGroup": "promotion",
      "discountOnce": 10,
      "discountOnceType": "PUBLIC_DISCOUNT_TYPE_PERCENTAGE",
      "discountMonthlyType": "PUBLIC_DISCOUNT_TYPE_UNSPECIFIED",
      "discountYearlyType": "PUBLIC_DISCOUNT_TYPE_UNSPECIFIED",
      "countryPrices": [
        {
          "countryCode": "US",
          "currency": "USD",
          "discountMonthly": 15,
          "discountMonthlyType": "PUBLIC_DISCOUNT_TYPE_PERCENTAGE",
          "discountMonthlyDurationMode": "contract",
          "discountYearlyDurationMode": "permanent"
        }
      ],
      "productDiscounts": [
        {
          "id": "<product-discount-link-id>",
          "discountId": "<discount-id>",
          "productId": "<product-id>",
          "productName": "Battery",
          "discountType": "PUBLIC_DISCOUNT_TYPE_FIXED",
          "discountAmount": 2500,
          "durationMonths": 6,
          "priceType": "PUBLIC_PRICE_TYPE_MONTHLY",
          "countryCode": "US",
          "currency": "USD"
        }
      ],
      "isActive": true
    }
  ]
}
HeyX API