> For the complete documentation index, see [llms.txt](https://developer.siteminder.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.siteminder.com/direct-booking-api/reference/rate-plan.md).
# Rate Plan
Returns a rate plan's details.
{% hint style="info" %}
**API:** Direct Booking · **Operation:** Rate Plan · **Direction:** SM → Property · **Method:** Pull (Property-initiated)
{% endhint %}
## Retrieve details of a specific rate plan
> Retrieve a specific rate plan's details.
```json
{"openapi":"3.1.0","info":{"title":"Direct Booking API","version":"0.0.1"},"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"x-sm-api-key","in":"header"}},"schemas":{"RatePlan":{"type":"object","additionalProperties":false,"required":["uuid","name","description","mobileOnly","maxAdvanceBooking","daysAvailable","applicableDates","advertisedDates","lengthOfStayDiscounts"],"properties":{"uuid":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[a-zA-Z0-9]+$","minLength":10}],"description":"Unique identifier for the rate plan."},"name":{"type":"string","description":"Name of the rate plan."},"description":{"type":"string","nullable":true,"description":"Description of the rate plan."},"mobileOnly":{"type":"boolean","description":"Whether the rate plan is only available to mobile bookers."},"maxAdvanceBooking":{"nullable":true,"description":"The maximum advance booking restriction, anchored to either check-in or check-out. Null when the rate plan has no maximum advance booking restriction configured.\n","type":"object","additionalProperties":false,"required":["type","numberOfDays"],"properties":{"type":{"type":"string","enum":["before-check-in","before-check-out"],"description":"Whether numberOfDays is counted back from the check-in date or the check-out date."},"numberOfDays":{"type":"integer","description":"Maximum number of days before check-in (or check-out) that the rate plan can be booked."}}},"daysAvailable":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6},"minItems":1,"maxItems":7,"description":"Days of the week the rate plan is available for stays, 0 (Sunday) to 6 (Saturday). Every night of the stay must fall on one of these days.\n"},"applicableDates":{"description":"The dates guests can stay under this rate plan. Every night of the stay must fall within these dates.","type":"object","additionalProperties":false,"required":["dateRanges","excludedDateRanges"],"properties":{"dateRanges":{"type":"array","description":"Date ranges included. Empty array means no restriction.","items":{"type":"object","additionalProperties":false,"required":["fromDate","toDate"],"properties":{"fromDate":{"type":"string","format":"date","description":"First date of the range (inclusive)."},"toDate":{"type":"string","format":"date","description":"Last date of the range (inclusive)."}}}},"excludedDateRanges":{"type":"array","description":"Date ranges excluded, even when they fall inside dateRanges.","items":{"$ref":"#/paths/~1properties~1%7BpropertyUuid%7D~1rate-plans~1%7Buuid%7D/get/responses/200/content/application~1json/schema/properties/applicableDates/properties/dateRanges/items"}}}},"advertisedDates":{"$ref":"#/components/schemas/RatePlan/properties/applicableDates","description":"The dates the rate plan can be booked on, checked against the booking date rather than the stay dates."},"lengthOfStayDiscounts":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["stay","discountPercentage"],"properties":{"stay":{"type":"integer","description":"Minimum number of nights for this discount to apply. When several tiers qualify, the one with the highest stay applies.\n"},"discountPercentage":{"type":"number","description":"Percentage discount applied when this tier applies."}}},"description":"Discount tiers based on the length of stay, in no guaranteed order."}}}},"responses":{"BadRequest":{"description":"Bad Request","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"NotFound":{"description":"The specified resource was not found","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"type":"string","description":"Character string with length 1 to 36 and with uuid format","minLength":1,"maxLength":36,"format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["message","name"],"properties":{"message":{"type":"string"},"name":{"type":"string"},"meta":{"type":"object","description":"Error metadata"}}}}}}}}},"NotAuthorised":{"description":"Not Authorised","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"AccessDenied":{"description":"Access Denied","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"RateLimited":{"description":"Rate Limited","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}},"InternalServerError":{"description":"Internal Server Error","headers":{"X-SM-TRACE-TOKEN":{"description":"SiteMinder trace token","schema":{"$ref":"#/components/responses/NotFound/headers/X-SM-TRACE-TOKEN/schema"}}},"content":{"application/json":{"schema":{"$ref":"#/components/responses/NotFound/content/application~1json/schema"}}}}},"parameters":{"apiKey":{"name":"x-sm-api-key","in":"header","schema":{"type":"string"},"required":true,"description":"API key used to authenticate the request."},"propertyUuid":{"in":"path","name":"propertyUuid","required":true,"schema":{"type":"string"},"description":"UUID for a property."},"ratePlanUuid":{"in":"path","name":"uuid","description":"UUID for a rate plan.","required":true,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string","pattern":"^[a-zA-Z0-9]+$","minLength":10}]}}}},"paths":{"/properties/{propertyUuid}/rate-plans/{uuid}":{"get":{"tags":["rate-plans:read"],"operationId":"getRatePlan","summary":"Retrieve details of a specific rate plan","description":"Retrieve a specific rate plan's details.\n","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatePlan"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/NotAuthorised"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"500":{"$ref":"#/components/responses/InternalServerError"}},"parameters":[{"$ref":"#/components/parameters/apiKey"},{"$ref":"#/components/parameters/propertyUuid"},{"$ref":"#/components/parameters/ratePlanUuid"}]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://developer.siteminder.com/direct-booking-api/reference/rate-plan.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.