---
title: "List Discounts"
method: GET
path: "/v1/discounts/"
tags: ["discounts", "public"]
---

# List Discounts

`GET /v1/discounts/`

List discounts.

**Scopes**: `discounts:read` `discounts:write`

## Query parameters

- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `query` string, nullable — Filter by name.
- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `sorting` DiscountSortProperty[], nullable — Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

## Response `200`

Successful Response

- ListResourceDiscount
  - `items` Discount[], required
    - union
      - DiscountFixedOnceForeverDuration — Schema for a fixed amount discount that is applied once or forever.
        - `duration` 'once' | 'forever' | 'repeating', required
        - `type` 'fixed' | 'percentage', required
        - `amount` integer, required
        - `currency` string, required
        - `amounts` object, required — Map of currency to fixed amount to discount from the total.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `name` string, required — Name of the discount. Will be displayed to the customer when the discount is applied.
        - `code` string, nullable, required — Code customers can use to apply the discount during checkout.
        - `starts_at` string, date-time, nullable, required — Timestamp after which the discount is redeemable.
        - `ends_at` string, date-time, nullable, required — Timestamp after which the discount is no longer redeemable.
        - `max_redemptions` integer, nullable, required — Maximum number of times the discount can be redeemed.
        - `max_redemptions_per_customer` integer, nullable, required — Maximum number of times the discount can be redeemed by a single customer.
        - `redemptions_count` integer, required — Number of times the discount has been redeemed.
        - `organization_id` string, uuid4, required — The organization ID.
        - `products` DiscountProduct[], required
          - `metadata` MetadataOutputType, required
          - `id` string, uuid4, required — The ID of the object.
          - `created_at` string, date-time, required — Creation timestamp of the object.
          - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
          - `trial_interval` 'day' | 'week' | 'month' | 'year', required
          - `trial_interval_count` integer, nullable, required — The number of interval units for the trial period.
          - `name` string, required — The name of the product.
          - `description` string, nullable, required — The description of the product.
          - `visibility` 'draft' | 'private' | 'public', required
          - `recurring_interval` 'day' | 'week' | 'month' | 'year', required
          - `recurring_interval_count` integer, nullable, required — Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
          - `meter_interval` 'day' | 'week' | 'month' | 'year', required
          - `meter_interval_count` integer, nullable, required — Number of meter interval units. None when no meter cycle is set.
          - `is_recurring` boolean, required — Whether the product is a subscription.
          - `is_archived` boolean, required — Whether the product is archived and no longer available.
          - `organization_id` string, uuid4, required — The ID of the organization owning the product.
      - DiscountFixedRepeatDuration — Schema for a fixed amount discount that is applied on every invoice for a certain number of months.
        - `duration` 'once' | 'forever' | 'repeating', required
        - `duration_in_months` integer, required
        - `type` 'fixed' | 'percentage', required
        - `amount` integer, required
        - `currency` string, required
        - `amounts` object, required — Map of currency to fixed amount to discount from the total.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `name` string, required — Name of the discount. Will be displayed to the customer when the discount is applied.
        - `code` string, nullable, required — Code customers can use to apply the discount during checkout.
        - `starts_at` string, date-time, nullable, required — Timestamp after which the discount is redeemable.
        - `ends_at` string, date-time, nullable, required — Timestamp after which the discount is no longer redeemable.
        - `max_redemptions` integer, nullable, required — Maximum number of times the discount can be redeemed.
        - `max_redemptions_per_customer` integer, nullable, required — Maximum number of times the discount can be redeemed by a single customer.
        - `redemptions_count` integer, required — Number of times the discount has been redeemed.
        - `organization_id` string, uuid4, required — The organization ID.
        - `products` DiscountProduct[], required
          - `metadata` MetadataOutputType, required
          - `id` string, uuid4, required — The ID of the object.
          - `created_at` string, date-time, required — Creation timestamp of the object.
          - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
          - `trial_interval` 'day' | 'week' | 'month' | 'year', required
          - `trial_interval_count` integer, nullable, required — The number of interval units for the trial period.
          - `name` string, required — The name of the product.
          - `description` string, nullable, required — The description of the product.
          - `visibility` 'draft' | 'private' | 'public', required
          - `recurring_interval` 'day' | 'week' | 'month' | 'year', required
          - `recurring_interval_count` integer, nullable, required — Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
          - `meter_interval` 'day' | 'week' | 'month' | 'year', required
          - `meter_interval_count` integer, nullable, required — Number of meter interval units. None when no meter cycle is set.
          - `is_recurring` boolean, required — Whether the product is a subscription.
          - `is_archived` boolean, required — Whether the product is archived and no longer available.
          - `organization_id` string, uuid4, required — The ID of the organization owning the product.
      - DiscountPercentageOnceForeverDuration — Schema for a percentage discount that is applied once or forever.
        - `duration` 'once' | 'forever' | 'repeating', required
        - `type` 'fixed' | 'percentage', required
        - `basis_points` integer, required — Discount percentage in basis points. A basis point is 1/100th of a percent. For example, 1000 basis points equals a 10% discount.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `name` string, required — Name of the discount. Will be displayed to the customer when the discount is applied.
        - `code` string, nullable, required — Code customers can use to apply the discount during checkout.
        - `starts_at` string, date-time, nullable, required — Timestamp after which the discount is redeemable.
        - `ends_at` string, date-time, nullable, required — Timestamp after which the discount is no longer redeemable.
        - `max_redemptions` integer, nullable, required — Maximum number of times the discount can be redeemed.
        - `max_redemptions_per_customer` integer, nullable, required — Maximum number of times the discount can be redeemed by a single customer.
        - `redemptions_count` integer, required — Number of times the discount has been redeemed.
        - `organization_id` string, uuid4, required — The organization ID.
        - `products` DiscountProduct[], required
          - `metadata` MetadataOutputType, required
          - `id` string, uuid4, required — The ID of the object.
          - `created_at` string, date-time, required — Creation timestamp of the object.
          - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
          - `trial_interval` 'day' | 'week' | 'month' | 'year', required
          - `trial_interval_count` integer, nullable, required — The number of interval units for the trial period.
          - `name` string, required — The name of the product.
          - `description` string, nullable, required — The description of the product.
          - `visibility` 'draft' | 'private' | 'public', required
          - `recurring_interval` 'day' | 'week' | 'month' | 'year', required
          - `recurring_interval_count` integer, nullable, required — Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
          - `meter_interval` 'day' | 'week' | 'month' | 'year', required
          - `meter_interval_count` integer, nullable, required — Number of meter interval units. None when no meter cycle is set.
          - `is_recurring` boolean, required — Whether the product is a subscription.
          - `is_archived` boolean, required — Whether the product is archived and no longer available.
          - `organization_id` string, uuid4, required — The ID of the organization owning the product.
      - DiscountPercentageRepeatDuration — Schema for a percentage discount that is applied on every invoice for a certain number of months.
        - `duration` 'once' | 'forever' | 'repeating', required
        - `duration_in_months` integer, required
        - `type` 'fixed' | 'percentage', required
        - `basis_points` integer, required — Discount percentage in basis points. A basis point is 1/100th of a percent. For example, 1000 basis points equals a 10% discount.
        - `created_at` string, date-time, required — Creation timestamp of the object.
        - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
        - `id` string, uuid4, required — The ID of the object.
        - `metadata` MetadataOutputType, required
        - `name` string, required — Name of the discount. Will be displayed to the customer when the discount is applied.
        - `code` string, nullable, required — Code customers can use to apply the discount during checkout.
        - `starts_at` string, date-time, nullable, required — Timestamp after which the discount is redeemable.
        - `ends_at` string, date-time, nullable, required — Timestamp after which the discount is no longer redeemable.
        - `max_redemptions` integer, nullable, required — Maximum number of times the discount can be redeemed.
        - `max_redemptions_per_customer` integer, nullable, required — Maximum number of times the discount can be redeemed by a single customer.
        - `redemptions_count` integer, required — Number of times the discount has been redeemed.
        - `organization_id` string, uuid4, required — The organization ID.
        - `products` DiscountProduct[], required
          - `metadata` MetadataOutputType, required
          - `id` string, uuid4, required — The ID of the object.
          - `created_at` string, date-time, required — Creation timestamp of the object.
          - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
          - `trial_interval` 'day' | 'week' | 'month' | 'year', required
          - `trial_interval_count` integer, nullable, required — The number of interval units for the trial period.
          - `name` string, required — The name of the product.
          - `description` string, nullable, required — The description of the product.
          - `visibility` 'draft' | 'private' | 'public', required
          - `recurring_interval` 'day' | 'week' | 'month' | 'year', required
          - `recurring_interval_count` integer, nullable, required — Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products.
          - `meter_interval` 'day' | 'week' | 'month' | 'year', required
          - `meter_interval_count` integer, nullable, required — Number of meter interval units. None when no meter cycle is set.
          - `is_recurring` boolean, required — Whether the product is a subscription.
          - `is_archived` boolean, required — Whether the product is archived and no longer available.
          - `organization_id` string, uuid4, required — The ID of the organization owning the product.
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/polar/apis/polar-api.md) · [All operations](https://skmtc.net/polar/apis/polar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polar/polar-api/revisions/ff24109feac4/schema)