---
displayed_sidebar: pricingReference
---

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

# PriceSetDTO

A price set's data.

## Properties

<ParameterTypes parameters={[
  {
    "name": "id",
    "type": "`string`",
    "description": "The ID of the price set.",
    "optional": false,
    "defaultValue": "",
    "children": []
  },
  {
    "name": "money_amounts",
    "type": "[`MoneyAmountDTO`](MoneyAmountDTO.mdx)[]",
    "description": "The prices that belong to this price set.",
    "optional": true,
    "defaultValue": "",
    "children": [
      {
        "name": "amount",
        "type": "`number`",
        "description": "The price of this money amount.",
        "optional": true,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "currency",
        "type": "[`CurrencyDTO`](CurrencyDTO.mdx)",
        "description": "The money amount's currency. Since this is a relation, it will only be retrieved if it's passed to the `relations` array of the find-configuration options.",
        "optional": true,
        "defaultValue": "",
        "children": [
          {
            "name": "code",
            "type": "`string`",
            "description": "The code of the currency.",
            "optional": false,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The name of the currency.",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "symbol",
            "type": "`string`",
            "description": "The symbol of the currency.",
            "optional": true,
            "defaultValue": "",
            "children": []
          },
          {
            "name": "symbol_native",
            "type": "`string`",
            "description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
            "optional": true,
            "defaultValue": "",
            "children": []
          }
        ]
      },
      {
        "name": "currency_code",
        "type": "`string`",
        "description": "The currency code of this money amount.",
        "optional": true,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the money amount.",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "max_quantity",
        "type": "`number`",
        "description": "The maximum quantity required to be purchased for this price to be applied.",
        "optional": true,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "min_quantity",
        "type": "`number`",
        "description": "The minimum quantity required to be purchased for this price to be applied.",
        "optional": true,
        "defaultValue": "",
        "children": []
      }
    ]
  },
  {
    "name": "rule_types",
    "type": "[`RuleTypeDTO`](RuleTypeDTO.mdx)[]",
    "description": "The rule types applied on this price set.",
    "optional": true,
    "defaultValue": "",
    "children": [
      {
        "name": "default_priority",
        "type": "`number`",
        "description": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type.",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the rule type.",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "name",
        "type": "`string`",
        "description": "The display name of the rule type.",
        "optional": false,
        "defaultValue": "",
        "children": []
      },
      {
        "name": "rule_attribute",
        "type": "`string`",
        "description": "The unique name used to later identify the rule_attribute. For example, it can be used in the `context` parameter of the `calculatePrices` method to specify a rule for calculating the price.",
        "optional": false,
        "defaultValue": "",
        "children": []
      }
    ]
  }
]} />
