Skip to main content
Skip to main content

PriceList

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

Properties

idstringRequired
The price list's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
namestringRequired
The price list's name
descriptionstringRequired
The price list's description
typePriceListTypeRequired
The type of Price List. This can be one of either sale or override.

Default: sale

statusPriceListStatusRequired
The status of the Price List

Default: draft

starts_atnull | DateRequired
The date with timezone that the Price List starts being valid.
ends_atnull | DateRequired
The date with timezone that the Price List stops being valid.
customer_groupsCustomerGroup[]Required
The details of the customer groups that the Price List can apply to.
pricesMoneyAmount[]Required
The prices that belong to the price list, represented as a Money Amount.
includes_taxbooleanRequired
Whether the price list prices include tax

Default: false

Was this section helpful?