---
displayed_sidebar: entitiesSidebar
slug: /references/entities/classes/PriceList
---

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

# PriceList

A Price List represents a set of prices that override the default price for one or more product variants.

## Properties

<ParameterTypes parameters={[
  {
    "name": "created_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was created.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "customer_groups",
    "type": "[CustomerGroup](entities.CustomerGroup.mdx)[]",
    "description": "The details of the customer groups that the Price List can apply to.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "created_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "customers",
        "type": "[Customer](entities.Customer.mdx)[]",
        "description": "The details of the customers that belong to the customer group.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "deleted_at",
        "type": "`null` \\| `Date`",
        "description": "The date with timezone at which the resource was deleted.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The customer group's ID",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`Record<string, unknown>`",
        "description": "An optional key-value map with additional details",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "name",
        "type": "`string`",
        "description": "The name of the customer group",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price_lists",
        "type": "[PriceList](entities.PriceList.mdx)[]",
        "description": "The price lists that are associated with the customer group.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "deleted_at",
    "type": "`null` \\| `Date`",
    "description": "The date with timezone at which the resource was deleted.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "description",
    "type": "`string`",
    "description": "The price list's description",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "ends_at",
    "type": "`null` \\| `Date`",
    "description": "The date with timezone that the Price List stops being valid.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`",
    "description": "The price list's ID",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "includes_tax",
    "type": "`boolean`",
    "description": "Whether the price list prices include tax",
    "optional": false,
    "defaultValue": "false",
    "expandable": false,
    "featureFlag": "tax_inclusive_pricing",
    "children": []
  },
  {
    "name": "name",
    "type": "`string`",
    "description": "The price list's name",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "prices",
    "type": "[MoneyAmount](entities.MoneyAmount.mdx)[]",
    "description": "The prices that belong to the price list, represented as a Money Amount.",
    "optional": false,
    "defaultValue": "",
    "expandable": true,
    "children": [
      {
        "name": "amount",
        "type": "`number`",
        "description": "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "currency",
        "type": "[Currency](entities.Currency.mdx)",
        "description": "The details of the currency that the money amount may belong to.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "currency_code",
        "type": "`string`",
        "description": "The 3 character currency code that the money amount may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "deleted_at",
        "type": "`null` \\| `Date`",
        "description": "The date with timezone at which the resource was deleted.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The money amount's ID",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "max_quantity",
        "type": "`null` \\| `number`",
        "description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "min_quantity",
        "type": "`null` \\| `number`",
        "description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price_list",
        "type": "`null` \\| [PriceList](entities.PriceList.mdx)",
        "description": "The details of the price list that the money amount may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "price_list_id",
        "type": "`null` \\| `string`",
        "description": "The ID of the price list that the money amount may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "region",
        "type": "[Region](entities.Region.mdx)",
        "description": "The details of the region that the money amount may belong to.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "region_id",
        "type": "`null` \\| `string`",
        "description": "The region's ID",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "variant",
        "type": "[ProductVariant](entities.ProductVariant.mdx)",
        "description": "The details of the product variant that the money amount may belong to.",
        "optional": false,
        "defaultValue": "",
        "expandable": true,
        "children": []
      },
      {
        "name": "variant_id",
        "type": "`string`",
        "description": "The ID of the Product Variant contained in the Line Item.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "variants",
        "type": "[ProductVariant](entities.ProductVariant.mdx)[]",
        "description": "",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "starts_at",
    "type": "`null` \\| `Date`",
    "description": "The date with timezone that the Price List starts being valid.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)",
    "description": "The status of the Price List",
    "optional": false,
    "defaultValue": "draft",
    "expandable": false,
    "children": [
      {
        "name": "ACTIVE",
        "type": "`\"active\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "DRAFT",
        "type": "`\"draft\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "type",
    "type": "[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)",
    "description": "The type of Price List. This can be one of either `sale` or `override`.",
    "optional": false,
    "defaultValue": "sale",
    "expandable": false,
    "children": [
      {
        "name": "OVERRIDE",
        "type": "`\"override\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "SALE",
        "type": "`\"sale\"`",
        "description": "",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "updated_at",
    "type": "`Date`",
    "description": "The date with timezone at which the resource was updated.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": []
  }
]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/>
