---
agentTools:
  projectIndex: https://dev.hostfully.com/v3.0/llms.txt
---

# Get pricing periods

Retrieves pricing periods for a property within specified date range. Requires propertyUid, from and to date parameters

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Hostfully API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.hostfully.com/"
    },
    "version": "v3.0.1"
  },
  "externalDocs": {
    "description": "Hostfully Documentation",
    "url": "https://dev.hostfully.com/v3.0/reference"
  },
  "servers": [
    {
      "url": "https://sandbox.hostfully.com"
    }
  ],
  "security": [
    {
      "JWT-Authentication": []
    },
    {
      "Agency-API-key": []
    }
  ],
  "paths": {
    "/api/v3/pricing-periods": {
      "get": {
        "tags": [
          "Pricing Periods"
        ],
        "summary": "Get pricing periods",
        "description": "Retrieves pricing periods for a property within specified date range. Requires propertyUid, from and to date parameters",
        "operationId": "findByPropertyUid_3",
        "parameters": [
          {
            "name": "propertyUid",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "to",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/PricingPeriodsApiResponseWrapper"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Api3ResponseMetadata": {
        "type": "object",
        "properties": {
          "count": {
            "type": "integer",
            "format": "int32"
          },
          "totalCount": {
            "type": "integer",
            "format": "int32"
          }
        }
      },
      "PricingPeriodApi3Dto": {
        "type": "object",
        "properties": {
          "propertyUid": {
            "type": "string"
          },
          "date": {
            "type": "string",
            "format": "date"
          },
          "price": {
            "type": "number"
          },
          "minimumStay": {
            "type": "integer",
            "format": "int32"
          },
          "availableForCheckIn": {
            "type": "boolean"
          },
          "availableForCheckOut": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "PricingPeriodsApiResponseWrapper": {
        "type": "object",
        "properties": {
          "pricingPeriods": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PricingPeriodApi3Dto"
            }
          },
          "_metadata": {
            "$ref": "#/components/schemas/Api3ResponseMetadata"
          }
        }
      }
    },
    "securitySchemes": {
      "JWT-Authentication": {
        "type": "apiKey",
        "description": "OAuth Access Token",
        "name": "Authorization",
        "in": "header"
      },
      "Agency-API-key": {
        "type": "apiKey",
        "description": "API Key",
        "name": "X-HOSTFULLY-APIKEY",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 104,
      "1": 37,
      "2": 238,
      "3": 97,
      "4": 234,
      "5": 68,
      "6": 17,
      "7": 0,
      "8": 15,
      "9": 82,
      "10": 111,
      "11": 99
    }
  }
}
```