Retrieve Availability & Booking Rules
This endpoint retrieves the availability and booking rules for a specific property unit, including pricing, discounts, taxes, fees, refundable deposits, and payment schedules.
Endpoint
POST
https://connect-sandbox.su-api.com/SUAPI/jservice/vrbo/availabilitybookingrules/retrieveHeader
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.
Request
{
"hotel_id": "AWSTEST",
"advert_id": "100003",
"room_id": "100020",
"rate_id": "12345"
}Response
Success Response
{
"Status": "Success",
"Message": "Availability and booking rules are retrieve successfully.",
"Data": [
{
"unit_id": "S-1063515647781",
"language": "en",
"availableUnitCountDefault": "0",
"minStayDefault": "1",
"maxStayDefault": "28",
"minPriorNotifyDefault": "1",
"stayIncrementDefault": "D",
"availabilityDefault": "N",
"changeOverDefault": "X",
"currency": "AUD",
"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"
}
]
}
},
"externalId": "500475-S-SM2BEDSUN-BAR-DF-W"
},
{
"type": "monthly",
"name": "Flat Discount Monthly",
"amount": "266",
"appliesPerStay": {
"forStaysOfNights": {
"range": [
{
"min": "28",
"max": "365"
}
]
}
},
"externalId": "500475-S-SM2BEDSUN-BAR-DF-M"
}
]
}
]
},
{
"percentOfRentDiscounts": [
{
"discount": [
{
"type": "weekly",
"name": "Percentage Discount Weekly",
"percent": "10",
"appliesPerNight": {
"forStaysOfNights": {
"range": [
{
"min": "7",
"max": "27"
}
]
}
},
"externalId": "500475-S-SM2BEDSUN-BAR-DP-W"
},
{
"type": "monthly",
"name": "Percentage Discount Monthly",
"percent": "20",
"appliesPerNight": {
"forStaysOfNights": {
"range": [
{
"min": "28",
"max": "365"
}
]
}
},
"externalId": "500475-S-SM2BEDSUN-BAR-DP-M"
}
]
}
]
}
],
"taxRules": {
"percentOfRentTaxRules": [
{
"rule": [
{
"externalId": "600200011-M-118007-T-P",
"name": "Percent Tax",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesPerStay": []
}
]
}
],
"percentOfFeesTaxRules": [
{
"rule": [
{
"externalId": "600200011-M-118007-T-PC",
"name": "Cleaning Tax",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesToFeesPerStay": []
},
{
"externalId": "600200011-M-118007-T-PC1",
"name": "Property",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesToFeesPerStay": []
},
{
"externalId": "600200011-M-118007-T-PC2",
"name": "Linen Fee",
"percent": "12",
"activeLocalDateRange": [
{
"min": "2025-01-01",
"max": "2026-01-01"
}
],
"appliesToFeesPerStay": []
}
]
}
]
},
"fees": [
{
"guestFees": [
{
"fee": [
{
"externalId": "600200011-M-118007-F-G",
"amount": "12",
"appliesPerGuestPerNight": {
"forGuestNumber": {
"range": [
{
"min": "3",
"max": "30"
}
]
}
}
}
]
}
],
"cleaningFees": [
{
"fee": [
{
"externalId": "600200011-M-118007-F-C",
"amount": "100",
"appliesPerNight": []
}
]
}
],
"petFees": [
{
"fee": [
{
"externalId": "600200011-M-118007-F-P",
"amount": "250",
"appliesPerPetPerNight": []
}
]
}
],
"otherFees": [
{
"fee": [
{
"externalId": "600200011-M-118007-F1",
"name": "Property",
"amount": "100",
"productCode": "RENT",
"appliesPerNight": []
}
]
}
],
"percentOfRentFees": [
{
"fee": [
{
"externalId": "600200011-M-118007-F2",
"name": "Linen Fee",
"percent": "12",
"productCode": "LINENS",
"appliesPerNight": []
}
]
}
],
"flatRefundableDamageDepositFees": [
{
"fee": [
{
"externalId": "600200011-M-118007-F-FR",
"amount": "150",
"appliesPerStay": []
}
]
}
]
}
],
"lodgingStayCollectedFeeSchedule": {
"externalId": "600200011-M-118007-L",
"currency": "NZD",
"language": "en",
"supportedPaymentMethods": {
"method": [
"AMEX",
"BANKTRANSFER"
]
},
"refundableDamageDepositFlat": [
{
"fee": [
{
"externalId": "600200011-M-118007-L-R",
"due": "AT_CHECKIN",
"levied": "ALWAYS",
"name": "Refundable Damage Deposite",
"productCode": "DEPOSIT_DAMAGE",
"amount": "1500",
"currency": "GBP",
"appliesPerStay": []
}
]
}
]
},
"paymentSchedule": [
{
"payments": [
{
"payment": [
{
"externalId": "600200011-M-118007-P-1",
"dueType": "AT_BOOKING",
"requiresPercentOfTotalBooking": {
"percent": "25"
}
},
{
"externalId": "600200011-M-118007-P-2",
"dueType": "BEFORE_CHECKIN",
"days": "20",
"requiresPercentOfTotalBooking": {
"percent": "50"
}
},
{
"externalId": "600200011-M-118007-P-3",
"dueType": "BEFORE_CHECKIN",
"days": "6",
"requiresPercentOfTotalBooking": {
"percent": "25"
}
}
]
}
]
}
]
}
],
"Trace-ID": ""
}{
"Status": "Success",
"Message": "No existing availability and booking rules are found.",
“Data”: [],
"Trace-ID": ""
}Success Response - Body Elements
Status string
Indicates the result of the API call.
Message string
The message in the response.
Data array
The response data, the root element.
unit_id string
The unique identifier of the property unit.
language string
The language code used for this unit configuration (e.g., "en" for English).
availableUnitCountDefault string
Default number of available units for booking.
minStayDefault string
Minimum nights required per stay.
maxStayDefault string
Maximum allowed stay duration.
minPriorNotifyDefault string
Minimum days’ notice required before check-in.
stayIncrementDefault string
Defines the increment type for stays (e.g., "D" for daily).
availabilityDefault string
Indicates default availability status (“Y” or “N”).
changeOverDefault string
Defines the changeover rule for check-ins/outs (“X” means no changeover restrictions).
currency string
Currency code used for all monetary values.
week string
Specifies the price per night for Sunday.
mon string
Specifies the price per night for Monday.
tue string
Specifies the price per night for Tuesday.
wed string
Specifies the price per night for Wednesday.
thu string
Specifies the price per night for Thursday.
fri string
Specifies the price per night for Friday.
sat string
Specifies the price per night for Saturday.
sun string
Specifies the price per night for Sunday.
discounts array
Contains both flat amount and percentage-based discounts applied to the property.
flatAmountDiscounts array
List of flat-value discounts applied per stay.
type string
Type of discount (e.g., weekly, monthly).
name string
Discount name.
amount string
Discount value in the property’s currency.
externalId string
Unique external identifier for tracking the discount.
appliesPerStay object
Contains range of nights for which the discount applies.
range array
Each range defines the applicable night limits for the discount.
min string
Minimum number of nights required for the discount to apply.
max string
Maximum number of nights for which the discount is valid.
percentOfRentDiscounts array
Discounts applied as a percentage of rent per night.
type string
Discount type (e.g., weekly, monthly).
name string
Discount name.
percent string
Discount percentage value.
externalId string
Unique external ID for tracking the discount.
appliesPerNight object
Defines the range for applicable stays per night.
taxRules object
Contains tax configurations applied on rent and fees.
percentOfRentTaxRules array
Defines the list of taxes applied as a percentage of rent.
externalId string
Unique identifier of the rent tax rule.
name string
Name of the tax applied on rent.
percent string
Tax percentage applied on rent.
activeLocalDateRange array
Specifies the date range during which the tax is active.
min string
Start date for the tax applicability period.
max string
End date for the tax applicability period.
appliesPerStay array
Defines the applicability of the rent tax per stay (optional).
percentOfFeesTaxRules array
Specifies taxes applied as a percentage of fees such as cleaning or linen fees.
externalId string
Unique identifier of the fee tax rule.
name string
Name of the tax applied on specific fees.
percent string
Tax percentage applied on the fee amount.
activeLocalDateRange array
Specifies the date range during which the tax rule applies.
min string
Start date for the tax applicability period.
max string
End date for the tax applicability period.
appliesToFeesPerStay array
Defines the applicability of the tax on fees per stay (optional).
fees array
Defines all additional fees associated with the property.
guestFees array
Fees charged per guest per night.
cleaningFees array
Cleaning charges applied per night.
petFees array
Fees charged per pet per night.
otherFees array
Miscellaneous property-related fees applied per stay or per night.
percentOfRentFees array
Fees calculated as a percentage of rent.
flatRefundableDamageDepositFees array
Refundable deposits collected per stay.
Each fee object includes the following attributes:
externalId string
Unique identifier for the fee.
name string
Name of the fee.
amount string
Fixed amount charged for the fee.
percent string
Percentage of rent or applicable amount charged as a fee.
productCode string
Category or product code of the fee (e.g., "RENT", "LINENS").
appliesPerNight array
Indicates that the fee applies per night.
appliesPerStay array
Indicates that the fee applies per stay.
lodgingStayCollectedFeeSchedule object
Contains payment methods, refundable deposit, and fee schedule details.
externalId string
Unique identifier of the lodging stay collected fee schedule.
currency string
Specifies the currency used for the fee schedule.
language string
Language code used for the schedule (e.g., "en" for English).
supportedPaymentMethods.method array
List of accepted payment methods (e.g., AMEX, BANKTRANSFER).
refundableDamageDepositFlat array
Contains a list of refundable deposit fees collected per stay.
externalId string
Unique identifier for the refundable damage deposit fee.
due string
Indicates when the deposit is collected (e.g., AT_CHECKIN).
levied string
Specifies the levy condition (e.g., ALWAYS).
name string
Name or label of the refundable deposit fee.
productCode string
Product code associated with the deposit (e.g., DEPOSIT_DAMAGE).
amount string
Amount of the refundable damage deposit.
currency string
Currency code of the refundable deposit amount.
appliesPerStay array
Defines applicability rules per stay.
paymentSchedule array
Defines the schedule of payments for a booking.
externalId string
Unique payment ID for identifying each payment stage.
dueType string
Specifies when the payment is due (e.g., AT_BOOKING, BEFORE_CHECKIN).
days string
Number of days before check-in when the payment is required (applicable only for BEFORE_CHECKIN type).
percent string
Percentage of the total booking amount that must be paid at this payment stage.
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?