Skip to content
Wink

GetRatePlan

POST
/wink.partner.v1.Content/GetRatePlan
curl --request POST \
  --url https://example.com/wink.partner.v1.Content/GetRatePlan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ratePlanId": "example" }'

Get one rate plan by id

As above, for a rate_plan_id from RoomRate.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Request for GetRatePlan.

No language_code: a rate plan carries a single untranslated name and no descriptions, so there would be nothing for it to select. Accepting one anyway would imply a translation that never arrives.

object
ratePlanId

Rate plan to fetch, from RoomRate.rate_plan_id on a pricing result.

string
Examplegenerated
{
  "ratePlanId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The RPC completed with gRPC status OK.

Media typeapplication/json

Response for GetRatePlan.

object
ratePlan

The rate plan.

object
id

Stable rate plan identifier. Matches RoomRate.rate_plan_id on the pricing endpoints.

string
name

Rate plan name as the property wrote it, e.g. “Best Available Rate”. Untranslated.

string
prepaid

Whether the rate must be paid in full at booking rather than at the property.

boolean
breakfast

Breakfast is included in the rate.

boolean
brunch

Brunch is included in the rate.

boolean
lunch

Lunch is included in the rate.

boolean
dinner

Dinner is included in the rate.

boolean
allInclusive

Everything is included except alcohol.

boolean
allInclusivePlusAlcohol

Everything is included, alcohol as well.

boolean
cancellationPolicyId

The cancellation policy governing this rate plan, when it sets one. Join to PropertyContent.cancellation_policies or fetch it with GetCancellationPolicy.

string
Examplegenerated
{
  "ratePlan": {
    "id": "example",
    "name": "example",
    "prepaid": true,
    "breakfast": true,
    "brunch": true,
    "lunch": true,
    "dinner": true,
    "allInclusive": true,
    "allInclusivePlusAlcohol": true,
    "cancellationPolicyId": "example"
  }
}