---
displayed_sidebar: pricingReference
---

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

# CreatePriceListDTO

The price list to create.

<ParameterTypes parameters={[
  {
    "name": "description",
    "type": "`string`",
    "description": "The price list's description.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "ends_at",
    "type": "`string`",
    "description": "The price list expires after this date.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "number_rules",
    "type": "`number`",
    "description": "The number of rules associated with the price list.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "prices",
    "type": "[PriceListPriceDTO](pricing.PriceListPriceDTO.mdx)[]",
    "description": "The prices associated with the price list.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "amount",
        "type": "`number`",
        "description": "The amount of this money amount.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "currency",
        "type": "[CreateCurrencyDTO](pricing.CreateCurrencyDTO.mdx)",
        "description": "The currency of this money amount.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": [
          {
            "name": "code",
            "type": "`string`",
            "description": "The code of the currency.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The name of the currency.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "symbol",
            "type": "`string`",
            "description": "The symbol of the currency.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "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": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "currency_code",
        "type": "`string`",
        "description": "The currency code of this money amount.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The ID of the money amount.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "max_quantity",
        "type": "`null` \\| `number`",
        "description": "The maximum quantity required to be purchased for this money amount to be applied.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "min_quantity",
        "type": "`null` \\| `number`",
        "description": "The minimum quantity required to be purchased for this money amount to be applied.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price_set_id",
        "type": "`string`",
        "description": "The ID of the associated price set.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "rules",
    "type": "[CreatePriceListRules](pricing.CreatePriceListRules.mdx)",
    "description": "The rules to be created and associated with the price list.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "starts_at",
    "type": "`string`",
    "description": "The price list is enabled starting from this date.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "[PriceListStatus](../enums/pricing.PriceListStatus.mdx)",
    "description": "The price list's status.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "ACTIVE",
        "type": "`\"active\"`",
        "description": "The price list is enabled and its prices can be used.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "DRAFT",
        "type": "`\"draft\"`",
        "description": "The price list is disabled, meaning its prices can't be used yet.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "title",
    "type": "`string`",
    "description": "The price list's title.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "type",
    "type": "[PriceListType](../enums/pricing.PriceListType.mdx)",
    "description": "The price list's type.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "OVERRIDE",
        "type": "`\"override\"`",
        "description": "The price list's prices override original prices. This affects the calculated price of associated price sets.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "SALE",
        "type": "`\"sale\"`",
        "description": "The price list's prices are used for a sale.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
