title: Price List
description: >-
  A Price List represents a set of prices that override the default price for
  one or more product variants.
type: object
required:
  - created_at
  - deleted_at
  - description
  - ends_at
  - id
  - name
  - starts_at
  - status
  - type
  - updated_at
properties:
  id:
    description: The price list's ID
    type: string
    example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
  name:
    description: The price list's name
    type: string
    example: VIP Prices
  description:
    description: The price list's description
    type: string
    example: Prices for VIP customers
  type:
    description: The type of Price List. This can be one of either `sale` or `override`.
    type: string
    enum:
      - sale
      - override
    default: sale
  status:
    description: The status of the Price List
    type: string
    enum:
      - active
      - draft
    default: draft
  starts_at:
    description: The date with timezone that the Price List starts being valid.
    nullable: true
    type: string
    format: date-time
  ends_at:
    description: The date with timezone that the Price List stops being valid.
    nullable: true
    type: string
    format: date-time
  customer_groups:
    description: The details of the customer groups that the Price List can apply to.
    type: array
    x-expandable: customer_groups
    items:
      $ref: ./CustomerGroup.yaml
  prices:
    description: The prices that belong to the price list, represented as a Money Amount.
    type: array
    x-expandable: prices
    items:
      $ref: ./MoneyAmount.yaml
  includes_tax:
    description: Whether the price list prices include tax
    type: boolean
    x-featureFlag: tax_inclusive_pricing
    default: false
  created_at:
    description: The date with timezone at which the resource was created.
    type: string
    format: date-time
  updated_at:
    description: The date with timezone at which the resource was updated.
    type: string
    format: date-time
  deleted_at:
    description: The date with timezone at which the resource was deleted.
    nullable: true
    type: string
    format: date-time