---
displayed_sidebar: pricingReference
badge:
  variant: orange
  text: Beta
slug: /references/pricing/setPriceListRules
sidebar_label: setPriceListRules
---

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

# setPriceListRules - Pricing Module Reference

This documentation provides a reference to the `setPriceListRules` method. This belongs to the Pricing Module.

This method is used to set the rules of a price list.

## Example

```ts
import {
  initialize as initializePricingModule,
} from "@medusajs/pricing"

async function setPriceListRules (priceListId: string) {
  const pricingService = await initializePricingModule()

  const priceList = await pricingService.setPriceListRules({
    priceListId,
    rules: {
      region_id: "US"
    }
  })

  // do something with the price list or return it
}
```

## Parameters

<ParameterTypes parameters={[
  {
    "name": "data",
    "type": "[SetPriceListRulesDTO](../../pricing/interfaces/pricing.SetPriceListRulesDTO.mdx)",
    "description": "The rules to set for a price list.",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "priceListId",
        "type": "`string`",
        "description": "The ID of the price list to add rules to.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "rules",
        "type": "`Record<string, string \\| string[]>`",
        "description": "The rules to add to the price list. Each key of the object is a rule type's `rule_attribute`, and its value\nis the value(s) of the rule.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  },
  {
    "name": "sharedContext",
    "type": "[Context](../../pricing/interfaces/pricing.Context.mdx)",
    "description": "A context used to share resources, such as transaction manager, between the application and the module.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "enableNestedTransactions",
        "type": "`boolean`",
        "description": "A boolean value indicating whether nested transactions are enabled.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "isolationLevel",
        "type": "`string`",
        "description": "A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "manager",
        "type": "`TManager`",
        "description": "An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "transactionId",
        "type": "`string`",
        "description": "A string indicating the ID of the current transaction.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "transactionManager",
        "type": "`TManager`",
        "description": "An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />

## Returns

<ParameterTypes parameters={[
  {
    "name": "Promise",
    "type": "Promise&#60;[PriceListDTO](../../pricing/interfaces/pricing.PriceListDTO.mdx)&#62;",
    "optional": false,
    "defaultValue": "",
    "description": "The updated price lists.",
    "expandable": false,
    "children": [
      {
        "name": "ends_at",
        "type": "`null` \\| `string`",
        "description": "The price list expires after this date.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The price list's ID.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "money_amounts",
        "type": "[MoneyAmountDTO](../../pricing/interfaces/pricing.MoneyAmountDTO.mdx)[]",
        "description": "The associated money amounts.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "amount",
            "type": "`number`",
            "description": "The price of this money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "currency",
            "type": "[CurrencyDTO](../../pricing/interfaces/pricing.CurrencyDTO.mdx)",
            "description": "The money amount's currency.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "currency_code",
            "type": "`string`",
            "description": "The currency code of this money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the money amount.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "max_quantity",
            "type": "`number`",
            "description": "The maximum quantity required to be purchased for this price to be applied.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "min_quantity",
            "type": "`number`",
            "description": "The minimum quantity required to be purchased for this price to be applied.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "price_set_money_amount",
            "type": "[PriceSetMoneyAmountDTO](../../pricing/interfaces/pricing.PriceSetMoneyAmountDTO.mdx)",
            "description": "The details of the relation between the money amount and its associated price set.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "number_rules",
        "type": "`number`",
        "description": "The number of rules associated with this price list.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "price_list_rules",
        "type": "[PriceListRuleDTO](../../pricing/interfaces/pricing.PriceListRuleDTO.mdx)[]",
        "description": "The price set's rules.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "id",
            "type": "`string`",
            "description": "The price list rule's ID.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "price_list",
            "type": "[PriceListDTO](../../pricing/interfaces/pricing.PriceListDTO.mdx)",
            "description": "The associated price list.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_list_rule_values",
            "type": "[PriceListRuleValueDTO](../../pricing/interfaces/pricing.PriceListRuleValueDTO.mdx)[]",
            "description": "The associated rule values.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rule_type",
            "type": "[RuleTypeDTO](../../pricing/interfaces/pricing.RuleTypeDTO.mdx)",
            "description": "The associated rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "value",
            "type": "`string`",
            "description": "The value of the rule.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "price_set_money_amounts",
        "type": "[PriceSetMoneyAmountDTO](../../pricing/interfaces/pricing.PriceSetMoneyAmountDTO.mdx)[]",
        "description": "The associated price set money amounts.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of a price set money amount.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "money_amount",
            "type": "[MoneyAmountDTO](../../pricing/interfaces/pricing.MoneyAmountDTO.mdx)",
            "description": "The money amount associated with the price set money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_list",
            "type": "[PriceListDTO](../../pricing/interfaces/pricing.PriceListDTO.mdx)",
            "description": "The price list associated with the price set money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_rules",
            "type": "[PriceRuleDTO](../../pricing/interfaces/pricing.PriceRuleDTO.mdx)[]",
            "description": "The price rules associated with the price set money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_set",
            "type": "[PriceSetDTO](../../pricing/interfaces/pricing.PriceSetDTO.mdx)",
            "description": "The price set associated with the price set money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_set_id",
            "type": "`string`",
            "description": "The ID of the associated price set.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "title",
            "type": "`string`",
            "description": "The title of the price set money amount.",
            "optional": true,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "rule_types",
        "type": "[RuleTypeDTO](../../pricing/interfaces/pricing.RuleTypeDTO.mdx)[]",
        "description": "The associated rule types.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "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 \nthe provided context. The higher the value, the higher the priority of the rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "id",
            "type": "`string`",
            "description": "The ID of the rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "name",
            "type": "`string`",
            "description": "The display name of the rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "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 \nthe `calculatePrices` method to specify a rule for calculating the price.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "rules",
        "type": "[PriceListRuleDTO](../../pricing/interfaces/pricing.PriceListRuleDTO.mdx)[]",
        "description": "The price set's rules.",
        "optional": true,
        "defaultValue": "",
        "expandable": true,
        "children": [
          {
            "name": "id",
            "type": "`string`",
            "description": "The price list rule's ID.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          },
          {
            "name": "price_list",
            "type": "[PriceListDTO](../../pricing/interfaces/pricing.PriceListDTO.mdx)",
            "description": "The associated price list.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "price_list_rule_values",
            "type": "[PriceListRuleValueDTO](../../pricing/interfaces/pricing.PriceListRuleValueDTO.mdx)[]",
            "description": "The associated rule values.",
            "optional": true,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "rule_type",
            "type": "[RuleTypeDTO](../../pricing/interfaces/pricing.RuleTypeDTO.mdx)",
            "description": "The associated rule type.",
            "optional": false,
            "defaultValue": "",
            "expandable": true,
            "children": []
          },
          {
            "name": "value",
            "type": "`string`",
            "description": "The value of the rule.",
            "optional": false,
            "defaultValue": "",
            "expandable": false,
            "children": []
          }
        ]
      },
      {
        "name": "starts_at",
        "type": "`null` \\| `string`",
        "description": "The price list is enabled starting from this date.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "status",
        "type": "[PriceListStatus](../../pricing/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": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
