{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pricingperiods/","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"uid","type":"string","default":"","desc":"The unique ID of the property","required":true,"in":"query","ref":"","_id":"56ec8f7204e8940e00966568"},{"name":"to","type":"yyyy-mm-dd","default":"today","desc":"Retrieve periods where date start is after this date","required":false,"in":"query","ref":"","_id":"5bf35bdb26e417002cc99587"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"uid\": \"b833b62a-eb53-4511-90b4-8e4ef6fec818\", //Property UID\n    \"from\": \"2016-11-25\",\n    \"to\": \"2016-11-29\",\n    \"amount\": 259,\n    \"minimumStay\": 2,\n    \"isCheckinAllowed\": true,\n    \"isCheckoutAllowed\": false\n  },\n  {\n    \"uid\": \"b833b62a-eb53-4511-90b4-8e4ef6fec818\", //Property UID\n    \"from\": \"2016-11-20\",\n    \"to\": \"2016-11-24\",\n    \"amount\": 150,\n    \"minimumStay\": 1,\n    \"isCheckinAllowed\": true,\n    \"isCheckoutAllowed\": false\n  }\n]","name":""},{"status":400,"language":"text","code":"Orbirental API - Bad request.","name":""},{"status":409,"language":"text","code":"Orbirental API - Agency not found."}]},"settings":""},"next":{"description":"","pages":[]},"title":"/pricingperiods/","type":"endpoint","slug":"pricingperiods","excerpt":"Retrieve pricing periods for a given property","body":"","updates":[],"order":64,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3348","githubsync":"","user":"56e371538b32a10e00f79750","createdAt":"2016-03-18T23:29:54.308Z","editedParams":true,"parentDoc":null,"project":"56e3719a591f620e00bf5095","__v":3,"category":{"sync":{"isSync":false,"url":""},"pages":["5de85dbbb0b885003ddf3339","5de85dbbb0b885003ddf333a","5de85dbbb0b885003ddf333b","5de85dbbb0b885003ddf333c","5de85dbbb0b885003ddf333d","5de85dbbb0b885003ddf333e","5de85dbbb0b885003ddf333f","5de85dbbb0b885003ddf3340","5de85dbbb0b885003ddf3341","5de85dbbb0b885003ddf3342","5de85dbbb0b885003ddf3343","56e77e22911296190096de13","5de85dbbb0b885003ddf3344","5de85dbbb0b885003ddf3345","5de85dbbb0b885003ddf3346","5de85dbbb0b885003ddf3347","5de85dbbb0b885003ddf3348","5de85dbbb0b885003ddf3349","5de85dbbb0b885003ddf334a"],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5de85dbbb0b885003ddf3334","project":"56e3719a591f620e00bf5095","__v":19,"createdAt":"2016-03-12T01:32:11.359Z","version":"5de85dbbb0b885003ddf339f"},"version":{"version":"1.5","version_clean":"1.5.0","codename":"Domain","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5de85dbbb0b885003ddf3334","56e7b24ad365390e007baeab","5de85dbbb0b885003ddf3335","5de85dbbb0b885003ddf3336","5de85dbbb0b885003ddf3337","5de85dbbb0b885003ddf3338"],"_id":"5de85dbbb0b885003ddf339f","__v":0,"project":"56e3719a591f620e00bf5095","forked_from":"56e3719a591f620e00bf5098","createdAt":"2016-03-12T01:32:10.751Z","releaseDate":"2016-03-12T01:32:10.751Z"},"editedParams2":true}

get/pricingperiods/

Retrieve pricing periods for a given property

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

uid:
required
string
The unique ID of the property
to:
yyyy-mm-ddtoday
Retrieve periods where date start is after this date

Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}