Retrieve a single rate plan

GET

/api/managing-entity/{managingEntityIdentifier}/extranet/rate-plan/{ratePlanIdentifier}

const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/rate-plan/5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73';
const options = {
  method: 'GET',
  headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/rate-plan/5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73 \
  --header 'Authorization: Bearer <token>' \
  --header 'Wink-Version: 2.0'

Fetch the complete details of a specific rate plan by its identifier for the given property. Includes all restrictions, modifiers, and cancellation policies. Requires INVENTORY:READ on the managing entity.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

The unique identifier of the property that owns this rate plan.

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

ratePlanIdentifier

required

string

The unique identifier of the rate plan to retrieve.

Example

5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

application/json

object

Document UUID

string format: uuid

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

The property (managing entity) that owns this rate plan.

string format: uuid

"" >= 1 characters

name

required

A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.

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

The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.

string format: date

sellEndDate

The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.

string format: date

stayStartDate

The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.

string format: date

stayEndDate

The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.

string format: date

loyaltyPointsAccrue

When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.

boolean

maxAdvanceBookingOffset

Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.

integer format: int32

minAdvanceBookingOffset

Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.

integer format: int32

minTotalOccupancy

Minimum number of guests required to qualify for this rate plan.

integer format: int32

maxTotalOccupancy

Maximum number of guests allowed under this rate plan.

integer format: int32

minLOS

Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.

integer format: int32

maxLOS

Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.

integer format: int32

minAge

Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.

integer format: int32

maxAge

Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.

integer format: int32

ratePlanLevelFees

Additional fees applied to this rate plan, such as resort facilities fees, parking fees, or cleaning charges. Fees can be charged per day, per stay, per person, or combinations thereof.

Array<object>

object

descriptions

required

Localized descriptions of this fee in multiple languages. At least one entry in English is required.

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

The fixed fee amount in the property’s local currency.

object

amount

required

number

currency

required

string

>= 1 characters

type

required

How this fee is charged: per day, per stay, per person per day, or per person per stay.

string

Allowed values: PER_DAY PER_STAY PER_PERSON_PER_DAY PER_PERSON_PER_STAY

availableDaysOfWeek

Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.

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

Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.

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

Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.

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

Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.

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

A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.

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

A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.

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 that governs refunds and cancellations 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

Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.

object

list

required

List of cancellation policy exceptions

Array<object>

>= 1 items

object

cancellationPolicyIdentifier

required

Cancellation policy identifier

string format: uuid

"" >= 1 characters

cancellationPolicy

required

Cancellation policy details for this exception

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

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

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

A pricing modifier applied when a single guest books this rate plan. For example, a 10% discount for solo travelers. If null, no single occupancy adjustment applies.

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

A pricing modifier applied for each additional adult guest beyond the base occupancy. For example, a per-person surcharge for extra occupants. If null, no extra adult adjustment applies.

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

A pricing modifier applied for each additional child guest. Typically used for child discounts or family rate adjustments. If null, no extra child adjustment applies.

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

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

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Retrieve a single rate plan

Authorizations

Parameters

Path Parameters

Example

Example

Header Parameters

Responses

200

Example

400

Example generated

401

403

500

Example generated

Example ^generated

Example ^generated