Pricing

How a product is charged, by area, by length or per spot. A new price needs its unit and currency; on an update, a price sent without them keeps the product's own.

Fields

unitstring
An area unit for pricing (see AreaUnit), a length unit for distancePricing (see DistanceUnit), each for itemPricing.
currencystring
ISO 4217 code, in lower case.
pattern ^[a-z]{3}$
typestring
fixed: one price per unit. range: a price per band of quantity. When left out, range if prices are sent, otherwise fixed. Per-spot prices are always fixed.
One offixedrange
pricenumber
The price per unit, for fixed.
≥ 0
pricesarray of PriceTier
The bands, for range.
at most 50 items

Example

{
  "unit": "m²",
  "currency": "gbp",
  "type": "range",
  "price": 32,
  "prices": [
    {
      "min": 0,
      "max": 100,
      "price": 32
    },
    {
      "min": 100,
      "max": -1,
      "price": 28
    }
  ]
}

Used by

GET List products
POST Create a product
GET Get a product
PUT Update a product
DELETE Archive a product