Skip to content
Wink

Show Rate Plans

GET
/api/managing-entity/{managingEntityIdentifier}/extranet/rate-plan/list
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/rate-plan/list \
  --header 'Wink-Version: 2.0'

Retrieve list of rate plans for property.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Show list of rate plans owned by this property identifier.

Example 
hotel-1

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
Array<object>
object
id

Document UUID

string
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
hotelIdentifier
required

Hotel Identifier

string format: uuid
"" >= 1 characters
name
required

Provides the name of the rate plan.

string
"" >= 1 characters
prepaid
required

When true, indicates if the rate is a prepaid rate.

boolean
enabled
required

Whether rate plan is active or not.

boolean
breakfast
required

When true, indicates breakfast is included.

boolean
brunch
required

When true, indicates brunch is included.

boolean
lunch
required

When true, indicates lunch is included.

boolean
dinner
required

When true, indicates dinner is included.

boolean
allInclusive
required

Everything included except alcohol

boolean
allInclusivePlusAlcohol
required

Everything included with alcohol

boolean
sellStartDate

Set a start date for when to start selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.

string format: date
""
sellEndDate

Set an end date for when to finish selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.

string format: date
""
stayStartDate

Set a start date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.

string format: date
""
stayEndDate

Set an end date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.

string format: date
""
loyaltyPointsAccrue

Property honors loyalty points with this rate plan.

boolean
maxAdvanceBookingOffset

Maximum days before the arrival date for which this rate plan may be booked.

integer format: int32
""
minAdvanceBookingOffset

Minimum days before the arrival date for which this rate plan may be booked.

integer format: int32
""
minTotalOccupancy

Defines the minimum number of total occupants required for this rate plan.

integer format: int32
""
maxTotalOccupancy

Defines the maximum number of total occupants required for this rate plan.

integer format: int32
""
minLOS

Indicates the minimum length of stay required for this rate plan.

integer format: int32
""
maxLOS

Indicates the maximum length of stay.

integer format: int32
""
minAge

The minimum age to qualify for this rate plan.

integer format: int32
""
maxAge

The maximum age to qualify for this rate plan.

integer format: int32
""
ratePlanLevelFees

This can be a one-time fee such as a cleaning fee

Array<object>
object
descriptions
required

List of localized descriptions for this fee.

Array<object>
"" >= 1 items
object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
fixedAmount
required

Rate plan level fixed fee amount in property currency

object
amount
required
number
currency
required
string
>= 1 characters
type
required

Rate plan fee type

string
""
Allowed values: PER_DAY PER_STAY PER_PERSON_PER_DAY PER_PERSON_PER_STAY
availableDaysOfWeek
object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
arrivalDaysOfWeek
object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
departureDaysOfWeek
object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
requiredDaysOfWeek
object
mon

Set to true to enable Monday.

boolean
tue

Set to true to enable Tuesday.

boolean
wed

Set to true to enable Wednesday.

boolean
thu

Set to true to enable Thursday.

boolean
fri

Set to true to enable Friday.

boolean
sat

Set to true to enable Saturday.

boolean
sun

Set to true to enable Sunday.

boolean
disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean
earlyCheckInCharge
object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
lateCheckOutCharge
object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
cancellationPolicy

The cancellation policy for this rate plan.

object
identifier
required

Unique cancellation policy identifier

string format: uuid
""
hotelIdentifier
required

Property this cancellation is associated with

string format: uuid
""
refundable
required

Whether this cancellation policy is refundable or not

boolean
advanceCancellationFreeOfCharge

When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.

string
""
Allowed values: UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL UNTIL_FOURTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL
refundableCancellationCharge

If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.

string
""
Allowed values: FIRST_NIGHT THIRTY_PERCENT FIFTY_PERCENT SIXTY_PERCENT SEVENTY_PERCENT NINENTY_PERCENT ONE_HUNDRED_PERCENT
noShowCharge

In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.

string
""
Allowed values: SAME_AS_CANCELLATION_FEE ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE
nonRefundableCancellationCharge

When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.

string
""
Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT
nonRefundableDeadline

The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.

string
""
Allowed values: ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL
nonRefundableAfterDeadlineCancellationCharge

If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.

string
""
Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT ONE_HUNDRED_PERCENT
policyCode
string
cancellationPolicyExceptions

Allows a property to dynamically use another cancellation policy for a specific date range

object
list
required

List of cancellation policy exceptions

Array<object>
>= 1 items
object
cancellationPolicyIdentifier
required

Cancellation policy

string format: uuid
"" >= 1 characters
cancellationPolicy
required

Cancellation policy

object
identifier
required

Unique cancellation policy identifier

string format: uuid
""
hotelIdentifier
required

Property this cancellation is associated with

string format: uuid
""
refundable
required

Whether this cancellation policy is refundable or not

boolean
advanceCancellationFreeOfCharge

When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.

string
""
Allowed values: UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL UNTIL_FOURTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL
refundableCancellationCharge

If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.

string
""
Allowed values: FIRST_NIGHT THIRTY_PERCENT FIFTY_PERCENT SIXTY_PERCENT SEVENTY_PERCENT NINENTY_PERCENT ONE_HUNDRED_PERCENT
noShowCharge

In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.

string
""
Allowed values: SAME_AS_CANCELLATION_FEE ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE
nonRefundableCancellationCharge

When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.

string
""
Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT
nonRefundableDeadline

The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.

string
""
Allowed values: ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL
nonRefundableAfterDeadlineCancellationCharge

If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.

string
""
Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT ONE_HUNDRED_PERCENT
policyCode
string
startDate
required

Start date for when this cancellation policy should start to override the default cancellation policy.

string format: date
""
endDate
required

End date for when this cancellation policy should end overriding the default cancellation policy.

string format: date
""
singleOccupancyRateModifier
object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
extraPaxRateModifier
object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
extraChildRateModifier
object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

object
amount
required
number
currency
required
string
>= 1 characters
Example 
[
  null
]

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}