GetRatePeriod
const url = 'https://example.com/wink.partner.v1.Inventory/GetRatePeriod';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"propertyId":"example","startDate":"example","periodInDays":1,"adults":1,"languageCode":"example","currencyCode":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/wink.partner.v1.Inventory/GetRatePeriod \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "propertyId": "example", "startDate": "example", "periodInDays": 1, "adults": 1, "languageCode": "example", "currencyCode": "example" }'Rate calendar
The best available rate for every check-in/check-out combination across a date range — what you need to render a “cheapest night to stay” calendar without one call per date.
Billed as period_in_days hotel-day units.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Request for GetRatePeriod.
object
Stable property identifier. Required.
First check-in date to price, ISO-8601 “YYYY-MM-DD”. Required.
How many days forward to price from start_date. Between 2 and 30. Required.
This is also the billed unit count: a 30-day calendar costs 30 hotel-day units.
Adults per room, between 1 and 10. Omit it to take the default of 2.
ISO 639-1 language for the room names, e.g. “en”. Required: room names are translated against it, and with no language supplied every name falls back to its untranslated form.
ISO 4217 currency for the returned prices. Exactly three characters.
Examplegenerated
{ "propertyId": "example", "startDate": "example", "periodInDays": 1, "adults": 1, "languageCode": "example", "currencyCode": "example"}Responses
Section titled “Responses”The RPC completed with gRPC status OK.
Response for GetRatePeriod.
object
The rate calendar.
object
Stable property identifier.
The property’s name, in the requested language.
Adults every rate in this calendar is priced for — the occupancy you asked for, so it is the same for every entry and is stated once here rather than repeated on each.
True if internet is included across the priced rates.
True if parking is included across the priced rates.
One entry per check-in/check-out combination in the range.
The best available rate for one check-in/check-out combination.
object
Identifier of the room type this rate is for. Join to Content for its description, images and amenities.
The room type’s name, in the requested language.
Check-in date, ISO-8601 “YYYY-MM-DD”.
Check-out date, ISO-8601 “YYYY-MM-DD”.
Nights covered.
True if this combination is bookable.
True if it can be cancelled without charge before the policy’s deadline.
Days from TODAY until free cancellation closes; -1 when not refundable, 0 when it closes today. Same
calculation as RoomRate.refundable_until_days.
True if breakfast is included.
What the guest pays for this combination, in minor units of currency_code.
Only meaningful when available is true. An unavailable combination reports 0, which means “no price”
rather than “free” — do not render it as a price.
ISO 4217 currency EVERY amount in this response is denominated in.
How many decimal places currency_code has — amounts are amount / 10^currency_exponent.
ISO 639-1 language the names in this response are in.
Examplegenerated
{ "period": { "propertyId": "example", "name": "example", "adults": 1, "internetIncluded": true, "parkingIncluded": true, "entries": [ { "roomTypeId": "example", "name": "example", "startDate": "example", "endDate": "example", "roomNights": 1, "available": true, "refundable": true, "refundableUntilDays": 1, "breakfastIncluded": true, "total": "example" } ] }, "currencyCode": "example", "currencyExponent": 1, "languageCode": "example"}