API Reference

Create additional fee on listing level

post
https://open-api.guesty.com/v1/additional-fees/listing/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

request payload

string
required

Define an internal name for your additional fee

string
enum
required

Additional fee type. !!! Not all additional fee types can be synced with channels. If you select the additional fee type which cannot be synced with channels, and 'isSyncToSupportedChannelsEnabled' is [true] you will receive a validation error. GUESTY_BASIC_TRAVEL_COVERAGE and GUESTY_EXTENDED_TRAVEL_COVERAGE can't be synced with channels. This fee types are relevant only to users who purchased Guesty’s Travel Insurance Product and can only be defined as an upsell for guests to purchase.

integer
required
  1. Must be bigger than 0,
  2. When 'isPercentage' is 'true' then must be smaller or equal to 100
boolean
required

Sets wether 'value' should be a fixed amount or percentage

string
enum
  1. The fee to use for the additional fee amount calculation when 'isPercentage' is 'true',
  2. required when 'isPercentage' is 'true'
Allowed:
string
enum
  1. Specifies the factor by which the 'value' will be multiplied in the additional fee amount calculation when 'isPercentage' is 'false'.
  2. This is required when 'isPercentage' is 'false'.
Allowed:
boolean
  1. Sync fee to account or listing settings and all future reservations for supported booking channels. !!! Not all additional fee types can be synced with channels. If you select the additional fee type which cannot be synced with channels, and 'isSyncToSupportedChannelsEnabled' is [true] you will receive a validation error
boolean
  1. Indicates if there are booking channels in which the additional fee should be added automatically to reservations once the reservation arrives in Guesty,
  2. if set to 'true', you must configure at least one of 'allSources', 'automationSources', 'allPlatforms', 'automationPlatforms', 'allRUSources', 'RUSources'
boolean
  1. If 'true' then the additional fee will be added to all future reservations in Guesty for all booking channels,
  2. can not be 'true' when 'isAutomated' is 'false',
  3. can not be 'true' when 'automationPlatforms' is not empty
automationPlatforms
array of strings
  1. Additional fee will be added to future reservations in Guesty for specified booking channels,
  2. can not contain values when 'isAutomated' is 'false',
  3. can not contain values when 'allPlatforms' is 'true'
automationPlatforms
boolean
  1. if 'true' then the additional fee will be added to all future reservations for all manual sources,
  2. can not be 'true' when 'isAutomated' is 'false',
  3. can not be 'true' when 'automationSources' is not empty
automationSources
array of strings
  1. additional fee will be added to future reservations in Guesty for specified manual sources,
  2. can not contain values when 'isAutomated' is 'false',
  3. can not contain values when 'allSources' is 'true'
automationSources
boolean
  1. If 'true' then the additional fee will be added to all future rentals united reservations in Guesty for all rentals united booking channels,
  2. can not be 'true' when 'isAutomated' is 'false'
  3. can not be 'true' when 'RUSources' is not empty,
  4. when 'true' then 'rentalsUnited' must be included in 'automationPlatforms' or 'allPlatforms' must be 'true'
RUSources
array of strings
  1. Additional fee will be added to future rentals united reservations in Guesty for specified rentals united booking channels,
  2. can not contain values when 'isAutomated' is 'false',
  3. can not contain values when 'allRUSources' is 'true',
  4. when not empty then 'rentalsUnited' must be included in 'automationPlatforms' or 'allPlatforms' must be 'true'
RUSources
boolean

[Beta] isDeducted must be [false] without isBundled being [true] when either isSyncToSupportedChannelsEnabled, isAutomated are [true].

boolean

[Beta] Bundle as part of accommodation fare

deductedConfiguration
object

[Beta] Deduct the fee amount from accommodation fare once the reservation is confirmed per manual source/channel configuration

channelConfigurations
array of objects

[Beta] Settings overrides per channel

channelConfigurations
sourcesConfigurations
array of objects

[Beta] Settings overrides per groups of manual sources

sourcesConfigurations
boolean

[Beta] Upsell fee on the booking website

upsell
object

[Beta] Upsell fee on the booking website settings.

conditions
array

[Beta] Conditions

conditions
Responses

400

Invalid input

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8

Updated 3 months ago