OnSeasonChannel API

Price component object

The amount-and-breakdown shape used for base price, fees, taxes, and discounts.

Quotes and reservations split prices into components: basePrice, fees, taxes, discounts, and, on reservations, an optional commission. Each component has the same shape.

{
  "amount": 100,
  "breakdown": [
    {
      "name": "Nightly rate",
      "description": "2026-12-05",
      "price": 100,
      "id": "optional-provider-price-id",
      "type": "nightly"
    }
  ]
}

Fields

FieldTypeDescription
amountnumberTotal of the component.
breakdownarrayThe lines behind amount. Can be empty.
breakdown[].namestringLine name from the PMS.
breakdown[].descriptionstringLine detail, such as the night it covers.
breakdown[].pricenumberLine amount. Discount lines can be negative.
breakdown[].idstringThe PMS's ID for the line, when it has one.
breakdown[].typestringLine type, such as nightly, fee, or tax.

Names and types vary by PMS. Treat values you don't recognize as valid price lines. Amounts are in the currency of the response that contains them.

On this page