PriceList

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

Properties

created_atDateRequired

The date with timezone at which the resource was created.

customer_groupsCustomerGroup[]Required

The details of the customer groups that the Price List can apply to.

deleted_atnull | DateRequired

The date with timezone at which the resource was deleted.

descriptionstringRequired

The price list's description

ends_atnull | DateRequired

The date with timezone that the Price List stops being valid.

idstringRequired

The price list's ID

includes_taxbooleanRequired

Whether the price list prices include tax

Default: false

namestringRequired

The price list's name

pricesMoneyAmount[]Required

The prices that belong to the price list, represented as a Money Amount.

starts_atnull | DateRequired

The date with timezone that the Price List starts being valid.

statusPriceListStatusRequired

The status of the Price List

Default: draft

typePriceListTypeRequired

The type of Price List. This can be one of either sale or override.

Default: sale

updated_atDateRequired

The date with timezone at which the resource was updated.