Set Availability & Booking Rules
This endpoint allows partners to configure and update availability, discounts, taxes, fees, refundable deposits, and payment schedules for a specific property listing on VRBO.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/availabilitybookingrules/setHeader
app-id: App Id
Authorization: Basic Authorization
Content-Type: application/jsonapp-id
string
Yes
Your application ID. Required for authentication.
Authorization
string
Yes
Your API key for authorization. Required for authentication.
Content-Type
string
Yes
Must be set to application/json.
Attributes
hotel_id string (Required)
The unique property ID as assigned by the provider upon creation of the property.
advert_id string (Required)
The unique advertiser ID associated with the property for which availability and booking rules are being set.
room_id string (Required)
The unique identifier of the room id for which availability and booking rules are being applied.
rate_id string (Required)
The unique identifier of the rate plan for which availability and booking rules are being applied.
json_content array of objects (Required)
Array containing detailed availability, discounts, taxes, fees, refundable deposits, and payment schedules for the property.
week, mon, tue, wed, thu, fri, sat, sun string (Required)
Availability or rate for each day of the week.
discounts object (Optional)
Contains information about discounts applied to the property:
flatAmountDiscounts object (Optional)
Flat amount discounts.
Each discount includes:
type string (Required)
Discount type.
name string (Required)
Discount name.
amount string (Required)
Discount value.
appliesPerStay object (Required)
Defines the stay duration range.
forStaysOfNights object (Required)
range object (Required)
min string (Required)
Start date (YYYY-MM-DD).
max string (Required)
End date (YYYY-MM-DD).
percentOfRentDiscounts array (Required)
Percentage-based discounts.
Each discount includes:
type string (Required)
Discount type.
name string (Required)
Discount name.
percent string (Required)
Discount percentage.
appliesPerNight object (Required)
Defines the stay duration range the discount applies to per night.
forStaysOfNights object (Required)
range object (Required)
min string (Required)
Start date (YYYY-MM-DD).
max string (Required)
End date (YYYY-MM-DD).
taxRules object (Optional)
Contains all applicable tax rules:
percentOfRentTaxRules array (Optional)
Taxes applied as a percentage of rent.
rule array (Optional)
Each array contains:
name string (Required)
Tax name.
percent string (Required)
Tax percentage.
activeLocalDateRange array (Required)
Array defining the date range of tax applicability.
min string (Required)
Start date (YYYY-MM-DD).
max string (Required)
End date (YYYY-MM-DD).
appliesPerStay array (Optional)
Applicability on per-stay basis.
percentOfFeesTaxRules array (Optional)
Taxes applied as a percentage of fees.
Each rule includes:
name string (Required)
Fee name (for example, Cleaning Tax).
percent string (Required)
Tax percentage.
activeLocalDateRange array (Required)
Array of date range objects.
min string (Required)
Start date (YYYY-MM-DD).
max string (Required)
End date (YYYY-MM-DD).
appliesToFeesPerStay array (Optional)
Defines applicability to fees per stay.
fees array (Required)
Contains all additional fees.
Each fees object may contain:
guestFees array (Optional)
Fees per guest per night. Includes amount and rules for number of guests.
Each contains fee array:
amount string (Required)
Fee amount.
appliesPerGuestPerNight object (Optional)
Object specifying applicable guest range.
forGuestNumber object (Optional)
Object defining range of guests.
range array of objects (Optional)
Array of objects with min and max.
min string (Required)
Start date (YYYY-MM-DD).
max string (Required)
End date (YYYY-MM-DD).
cleaningFees array (Optional)
Cleaning fees per night.
Each contains fee array:
Flat refundable deposit fees, applicable per stay.
amount string (Required)
Fee amount.
appliesPerNight array (Optional)
Applicability per night.
petFees array (Optional)
Fees per pet per night.
Each contains fee array:
Flat refundable deposit fees, applicable per stay.
amount string (Required)
Fee amount.
appliesPerNight array (Optional)
Applicability per night.
otherFees array (Optional)
Miscellaneous fees, with name, amount, product code, and per-night applicability.
Each contains fee array:
Flat refundable deposit fees, applicable per stay.
name string (Required)
Fee name.
amount string (Required)
Fee amount.
productCode string (Optional)
Fee category code.
appliesPerNight array (Optional)
Applicability condition.
percentOfRentFees array (Optional)
Fees as a percentage of rent, for example, linen fee.
Each contains fee array:
Flat refundable deposit fees, applicable per stay.
name string (Required)
Fee name.
amount string (Required)
Fee amount.
productCode string (Optional)
Fee category code.
appliesPerNight array (Optional)
Applicability condition.
flatRefundableDamageDepositFees array (Optional)
Flat refundable deposit fees, applicable per stay.
Each contains fee array:
Flat refundable deposit fees, applicable per stay.
amount string (Required)
Deposit amount.
appliesPerStay array (Optional)
Applicability condition.
lodgingStayCollectedFeeSchedule object (Optional)
Contains refundable deposit and accepted payment methods:
supportedPaymentMethods object (Optional)
List of payment methods accepted (for example, AMEX, BANKTRANSFER).
refundableDamageDepositFlat array (Optional)
Flat refundable deposits, including: due date, levied condition, name, productCode, amount, currency, and per-stay applicability.
fee object (Required)
Each object contains:
due string (Required)
When deposit is collected.
levied string (Required)
Deposit levy condition (for example, ALWAYS)
name string (Required)
Deposit name.
productCode string (Optional)
Deposit product code
amount string (Required)
Deposit amount.
currency string (Required)
Deposit currency.
appliesPerStay array (Optional)
Applicability per stay.
paymentSchedule array (Optional)
Defines the payment collection schedule for the booking.
payments array of objects (Required)
List of payment items.
Each payment includes:
dueType string (Required)
When the payment is due (for example, AT_BOOKING, BEFORE_CHECKIN).
days string (Optional)
Number of days before check-in for dueType BEFORE_CHECKIN.
requiresPercentOfTotalBooking object (Required)
Percentage of total booking to be collected for that payment.
Request
{
"hotel_id": "AWSTEST",
"advert_id": "13",
"room_id": "SM2BEDSUN",
"rate_id": "BAR",
"json_content": [
{
"week": "1200",
"mon": "1200",
"tue": "1200",
"wed": "1200",
"thu": "1200",
"fri": "1200",
"sat": "1200",
"sun": "1200",
"discounts": [
{
"flatAmountDiscounts": [
{
"discount": [
{
"type": "weekly",
"name": "Flat Discount Weekly",
"amount": "500",
"appliesPerStay": {
"forStaysOfNights": {
"range": [
{
"min": "7",
"max": "27"
}
]
}
}
},
{
"type": "monthly",
"name": "Flat Discount Monthly",
"amount": "266",
"appliesPerStay": {
"forStaysOfNights": {
"range": [
{
"min": "28",
"max": "365"
}
]
}
}
}
]
}
]
},
{
"percentOfRentDiscounts": [
{
"discount": [
{
"type": "weekly",
"name": "Percentage Discount Weekly",
"percent": "10",
"appliesPerNight": {
"forStaysOfNights": {
"range": [
{
"min": "7",
"max": "27"
}
]
}
}
},
{
"type": "monthly",
"name": "Percentage Discount Monthly",
"percent": "20",
"appliesPerNight": {
"forStaysOfNights": {
"range": [
{
"min": "28",
"max": "365"
}
]
}
}
}
]
}
]
}
],
"taxRules": {
"percentOfRentTaxRules": [
{
"rule": [
{
"name": "Percent Tax",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesPerStay": []
}
]
}
],
"percentOfFeesTaxRules": [
{
"rule": [
{
"name": "Cleaning Tax",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesToFeesPerStay": []
},
{
"name": "Property",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesToFeesPerStay": []
},
{
"name": "Linen Fee",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesToFeesPerStay": []
}
]
}
]
},
"fees": [
{
"guestFees": [
{
"fee": [
{
"amount": "12",
"appliesPerGuestPerNight": {
"forGuestNumber": {
"range": [
{
"min": "3",
"max": "30"
}
]
}
}
}
]
}
],
"cleaningFees": [
{
"fee": [
{
"amount": "100",
"appliesPerNight": []
}
]
}
],
"petFees": [
{
"fee": [
{
"amount": "250",
"appliesPerPetPerNight": []
}
]
}
],
"otherFees": [
{
"fee": [
{
"name": "Property",
"amount": "100",
"productCode": "RENT",
"appliesPerNight": []
}
]
}
],
"percentOfRentFees": [
{
"fee": [
{
"name": "Linen Fee",
"percent": "12",
"productCode": "LINENS",
"appliesPerNight": []
}
]
}
],
"flatRefundableDamageDepositFees": [
{
"fee": [
{
"amount": "150",
"appliesPerStay": []
}
]
}
]
}
],
"lodgingStayCollectedFeeSchedule": {
"supportedPaymentMethods": {
"method": [
"AMEX",
"BANKTRANSFER"
]
},
"refundableDamageDepositFlat": [
{
"fee": [
{
"due": "AT_CHECKIN",
"levied": "ALWAYS",
"name": "Refundable Damage Deposite",
"productCode": "DEPOSIT_DAMAGE",
"amount": "1500",
"currency": "GBP",
"appliesPerStay": []
}
]
}
]
},
"paymentSchedule": [
{
"payments": [
{
"payment": [
{
"dueType": "AT_BOOKING",
"requiresPercentOfTotalBooking": {
"percent": "25"
}
},
{
"dueType": "BEFORE_CHECKIN",
"days": "20",
"requiresPercentOfTotalBooking": {
"percent": "50"
}
},
{
"dueType": "BEFORE_CHECKIN",
"days": "6",
"requiresPercentOfTotalBooking": {
"percent": "25"
}
}
]
}
]
}
]
}
]
}Response
Success Response
{
"Status": "Success",
"Message": "The data has not been posted on VRBO. Please complete all steps.",
"Data": [],
"Trace-ID": ""
}{
"Status": "Success",
"Message": "Availability and booking rules are successfully updated.",
"Data": [],
"Trace-ID": ""
}Success Response - Body Elements
Status string
Indicates the result of the API call.
Message string
The message in the response.
Data object
The response data, the root element.
Trace-ID string
Unique ID for tracing the API request.
Error Response
{
"Status": "Fail",
"Message": "Data is not valid",
"Errors": [],
"Trace-ID": ""
}{
"Status": "Fail",
"Errors": [
{
"Code": "400",
"ShortText": "hotelid: Invalid HotelCode (:hotelid)"
}
],
"Message": ""
}Error Response - Body Elements
Status string
Indicates the result of the API call.
Errors array
The response error, the root element.
Code string
Specific error code that helps identify the type of error.
ShortText string
A short description of the error.
Message string
The message in the response.
Trace-ID string
Unique ID for tracing the API request.
Last updated
Was this helpful?