---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminGetDiscountsParams

Parameters used to filter and configure the pagination of the retrieved discounts.

## Properties

<ParameterTypes parameters={[
  {
    "name": "expand",
    "type": "`string`",
    "description": "Comma-separated relations that should be expanded in the returned data.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "fields",
    "type": "`string`",
    "description": "Comma-separated fields that should be included in the returned data.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "is_disabled",
    "type": "`boolean`",
    "description": "Filter discounts by whether they're disabled.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "is_dynamic",
    "type": "`boolean`",
    "description": "Filter discounts by whether they're dynamic.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "limit",
    "type": "`number`",
    "description": "Limit the number of items returned in the list.",
    "optional": true,
    "defaultValue": "20",
    "expandable": false,
    "children": []
  },
  {
    "name": "offset",
    "type": "`number`",
    "description": "The number of items to skip when retrieving a list.",
    "optional": true,
    "defaultValue": "0",
    "expandable": false,
    "children": []
  },
  {
    "name": "q",
    "type": "`string`",
    "description": "Search terms to search discounts' code fields.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "rule",
    "type": "[AdminGetDiscountsDiscountRuleParams](medusa.AdminGetDiscountsDiscountRuleParams.mdx)",
    "description": "Filter discounts by their associated rule.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "allocation",
        "type": "[AllocationType](../../entities/enums/entities.AllocationType.mdx)",
        "description": "Allocation to filter discount rules by.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "type",
        "type": "[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)",
        "description": "Type to filter discount rules by.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
