GUguesty
Listings

Get a listing's financial settings

Changed on

Retrieve a listing's pricing and fee setup, covering its base price, extra-person and cleaning fees, security deposit and channel commission. Where a connected channel overrides one of these values, the override is returned alongside the default under that channel's name.

get/financials/listing/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/financials/listing/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

Listing id

Response

Financials object

guestsIncludedInRegularFeenumber

The maximum number of guests accommodated before the extraPersonFee applies.

extraPersonFeenumber float

The amount of fee which is added for each extra person, above guestsIncludedInRegularFee, in the reservation

basePricenumber float

The cost per night for the listing

basePriceUSDnumber float

The default rate per night. This will apply to the weekend if no weekend price is defined.

monthlyPriceFactornumber float

The monthly length of stay discount. It is written as a decimal and represented as 100% less the discount. E.g.,0.8 grants a 20% discount.

weeklyPriceFactornumber float

The weekly length of stay discount. It is written as a decimal and represented as 100% less the discount. E.g. 0.95 grants a 5% discount.

weekendBasePricenumber float

The default weekend rate per night.

securityDepositFeenumber float

The security deposit fee charged for reservations at this listing.

currencystring

The currency to be used for bookings at the property. Choose from this list of ISO 4217 alphabetic codes. E.g., USD.

Example response

{
  "basePrice": 100,
  "basePriceUSD": 150,
  "monthlyPriceFactor": 0.8,
  "weeklyPriceFactor": 0.95,
  "weekendBasePrice": 150,
  "securityDepositFee": 100,
  "cleaningFee": {
    "value": {
      "formula": 50
    },
    "lastUpdatedAt": "2020-12-01T12:00:00Z",
    "airbnb": {
      "value": {
        "formula": 50
      }
    },
    "rentalsUnited": {
      "value": {
        "formula": 50
      }
    },
    "homeAway": {
      "value": {
        "formula": 50
      }
    },
    "expedia": {
      "value": {
        "formula": 50
      }
    },
    "despegar": {
      "value": {
        "formula": 50
      }
    },
    "bookingCom": {
      "value": {
        "formula": 50
      }
    }
  }
}

Changes

  • 3122b8618183Revision changes
    • breaking

      the / response's property format changed from date to date-time for status

    • info

      api operation id propertiesFinancialsGet was added