Create channel commission

post

https://open-api.guesty.com/v1/channel-commissions-v2

Creates a single channel commission for a channel and source.

Omit unitTypeId for an account-level commission. Provide unitTypeId for a listing-level commission.

Listing-level commissions are saved either way, but they are used for reservations only when the listing levelEntityType is UNIT_TYPE (see GET/PUT unit-type/{unitTypeId}/level-configurations). When the level is ACCOUNT, account-level commissions are used instead.

commission, tax, and isPreDeduct are optional. Omit commission or tax to save without them; isPreDeduct defaults to false.

If commissions already exist for the account or listing, this entry is added to them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

unitTypeId

string

Listing / unit type ID. Omit for an account-level entry; provide to create or update a listing-level entry. Must be a unit type (parent listing), not a sub-unit.

commission

object

Commission percentage (value) and which charges it applies to (of). On create, omit to save the entry without a commission. On update, omit to remove the existing commission from this entry.

tax

number

0 to 100

Tax percentage on the channel commission (0–100). On create, omit to save the entry without tax. On update, omit to remove the existing tax from this entry.

channel

string

required

length ≥ 1

Booking channel name (for example bookingCom, airbnb2, homeaway2, or manual). Must form a valid pair with source: either manual (always allowed), or an active pair from the channel-commission configurations catalog. The Guesty Open API Valid Enumerations — Channel Commission Sources guide is a product overview of sources; acceptance here is the active catalog (invalid pairs return 400). The guide’s “Set Commission” column may disagree with the catalog for a given source.

source

string

required

length ≥ 1

Booking source within the channel. Often the same as channel for direct channels; can differ for channel managers (for example channel rentalsUnited with source homeAway). Must form a valid pair with channel (see channel for the catalog rule).

isPreDeduct

boolean

Defaults to false

When true, Guesty automatically deducts the channel commission from the host payout for reservations from this source (adds a negative host channel fee on the folio). This API only honors isPreDeduct for the manual channel — for any other channel the value is ignored and stored as false. The Valid Enumerations guide may list Pre-deduct for other sources (for example expedia) as a product/UI capability; that is not controlled by this field. Defaults to false when omitted.

Responses

400

The request is invalid. Common causes: missing/invalid body fields, invalid channel/source pair, or unitTypeId refers to a sub-unit (only unit types / parent listings are allowed).

409

A channel commission for the same channel/source pair already exists at this account or listing level.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created channel commission entry