---
displayed_sidebar: homepage
---

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

# AdminPostDiscountsDiscountReq

## Properties

<ParameterTypes parameters={[
  {
    "name": "code",
    "type": "`string`",
    "description": "A unique code that will be used to redeem the discount",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "ends_at",
    "type": "`null` \\| `Date`",
    "description": "The date and time at which the discount should no longer be available.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "is_disabled",
    "type": "`boolean`",
    "description": "Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "metadata",
    "type": "`Record<string, unknown>`",
    "description": "An object containing metadata of the discount",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "regions",
    "type": "`string`[]",
    "description": "A list of region IDs representing the Regions in which the Discount can be used.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "rule",
    "type": "[AdminUpdateDiscountRule](medusa.AdminUpdateDiscountRule.mdx)",
    "description": "The discount rule that defines how discounts are calculated",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "allocation",
        "type": "[AllocationType](../../entities/enums/entities.AllocationType.mdx)",
        "description": "The discount rule's allocation.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "conditions",
        "type": "[AdminUpsertCondition](medusa.AdminUpsertCondition.mdx)[]",
        "description": "The discount rule's discount conditions.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "description",
        "type": "`string`",
        "description": "The discount rule's description.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The discount rule's ID.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "value",
        "type": "`number`",
        "description": "The discount rule's value.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "starts_at",
    "type": "`Date`",
    "description": "The date and time at which the discount should be available.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "usage_limit",
    "type": "`null` \\| `number`",
    "description": "Maximum number of times the discount can be used",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "valid_duration",
    "type": "`null` \\| `string`",
    "description": "The duration the discount runs between",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
