---
title: "PropertyAvailabilityResponse"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/schemas/PropertyAvailabilityResponse"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# PropertyAvailabilityResponse

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
components:
  schemas:
    Offer:
      type: object
      properties:
        rate_plan:
          type: object
          properties:
            code:
              type: string
            name:
              type: string
            meal_plan:
              $ref: "#/components/schemas/MealPlan"
            requires_membership:
              type: boolean
            allows_modification:
              type: boolean
        pricing:
          $ref: "#/components/schemas/Pricing"
        cancellation:
          $ref: "#/components/schemas/CancellationTerms"
    MealPlan:
      type: string
      enum:
        - room_only
        - breakfast
        - half_board
        - all_inclusive
    Pricing:
      type: object
      description: >
        `room_subtotal` = Σ `nightly_rates` × `rooms`. Percentage taxes apply to

        (`room_subtotal` − `discount_total` + `add_ons_total`); fixed taxes per
        room, per adult or per stay.

        `total` = `room_subtotal` − `discount_total` + `add_ons_total` +
        `tax_total`.
      properties:
        currency:
          type: string
          examples:
            - USD
        nights:
          type: integer
        rooms:
          type: integer
        nightly_rates:
          type: array
          description: Per-room rate for each night after the rate plan's adjustment.
          items:
            type: object
            properties:
              date:
                type: string
                format: date
              amount:
                $ref: "#/components/schemas/Money"
        average_nightly_rate:
          $ref: "#/components/schemas/Money"
        room_subtotal:
          $ref: "#/components/schemas/Money"
        discounts:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              name:
                type: string
              amount:
                $ref: "#/components/schemas/Money"
        discount_total:
          $ref: "#/components/schemas/Money"
        add_ons:
          type: array
          items:
            $ref: "#/components/schemas/AddOnLine"
        add_ons_total:
          $ref: "#/components/schemas/Money"
        taxes:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              name:
                type: string
              type:
                type: string
                enum:
                  - percent
                  - per_room_per_night
                  - per_person_per_night
                  - per_stay
              rate:
                type: string
                description: Percentage
                or the unit amount for fixed taxes.: null
              amount:
                $ref: "#/components/schemas/Money"
        tax_total:
          $ref: "#/components/schemas/Money"
        total:
          $ref: "#/components/schemas/Money"
      examples:
        - currency: USD
          nights: 3
          rooms: 1
          nightly_rates:
            - date: 2026-12-04
              amount: "427.00"
            - date: 2026-12-05
              amount: "449.00"
            - date: 2026-12-06
              amount: "388.00"
          average_nightly_rate: "421.33"
          room_subtotal: "1264.00"
          discounts:
            - code: KONGWEEKEND
              name: King of the Weekend
              amount: "151.68"
          discount_total: "151.68"
          add_ons:
            - code: BRKFST
              name: Breakfast
              pricing_unit: per_guest_per_night
              unit_price: "34.00"
              quantity: 1
              amount: "204.00"
          add_ons_total: "204.00"
          taxes:
            - code: NYC_OCC
              name: NY state & city occupancy tax
              type: percent
              rate: "14.75"
              amount: "194.16"
            - code: NYC_UNIT
              name: NYC hotel unit fee
              type: per_room_per_night
              rate: "2.00"
              amount: "6.00"
            - code: NYC_JAVITS
              name: Javits Center fee
              type: per_room_per_night
              rate: "1.50"
              amount: "4.50"
          tax_total: "204.66"
          total: "1520.98"
    CancellationTerms:
      type: object
      description: The policy applied to a specific stay, with a concrete deadline and
        penalty amount.
      properties:
        code:
          type: string
        name:
          type: string
        is_refundable:
          type: boolean
        free_cancellation_until:
          type:
            - string
            - "null"
          format: date-time
          examples:
            - 2026-12-03T16:00:00-05:00
        penalty_after_deadline:
          $ref: "#/components/schemas/Money"
        currency:
          type: string
        summary:
          type: string
          examples:
            - Free cancellation until Thu 3 Dec 2026, 16:00 EST. After that, 1
              night(s) of room charges (427.00 USD) apply.
    Money:
      type: string
      pattern: ^-?\d+\.\d{2}$
      description: Decimal amount in the property currency.
      examples:
        - "389.00"
    AddOnLine:
      type: object
      properties:
        code:
          type: string
        name:
          type: string
        pricing_unit:
          type: string
          enum:
            - per_stay
            - per_night
            - per_guest_per_night
        unit_price:
          $ref: "#/components/schemas/Money"
        quantity:
          type: integer
        amount:
          $ref: "#/components/schemas/Money"
          description: unit_price × quantity × (1 | nights | guests × nights)
    PropertyAvailabilityResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            property_code:
              type: string
            currency:
              type: string
            check_in:
              type: string
              format: date
            check_out:
              type: string
              format: date
            nights:
              type: integer
            occupancy:
              type: object
              properties:
                adults:
                  type: integer
                children:
                  type: integer
                rooms:
                  type: integer
            promotion:
              type:
                - object
                - "null"
              properties:
                code:
                  type: string
                applied:
                  type: boolean
                reasons:
                  type: array
                  items:
                    type: string
            room_types:
              type: array
              items:
                type: object
                properties:
                  room_type:
                    type: object
                    properties:
                      code:
                        type: string
                      name:
                        type: string
                      max_occupancy:
                        type: integer
                      bed_configuration:
                        type: string
                      size_sqm:
                        type: integer
                      view:
                        type:
                          - string
                          - "null"
                      is_accessible:
                        type: boolean
                  available_units:
                    type: integer
                    description: Rooms left for the whole stay.
                  is_available:
                    type: boolean
                  restrictions:
                    type: array
                    description: Why the room can't be sold.
                    items:
                      type: string
                      enum:
                        - no_inventory
                        - stop_sell
                        - closed_to_arrival
                        - closed_to_departure
                        - min_length_of_stay
                        - occupancy_exceeded
                  offers:
                    type: array
                    items:
                      $ref: "#/components/schemas/Offer"
        meta:
          type: object
          properties:
            generated_at:
              type: string
              format: date-time
```
