{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/pricingperiods/","auth":"required","method":"post","params":[{"name":"uid","type":"string","default":"","desc":"The unique ID of the property","required":true,"in":"body","ref":"","_id":"5722653d49df4f0e00528492"},{"name":"from","type":"yyyy-mm-dd","default":"","desc":"The start date with format YYYY-MM-DD","required":true,"in":"body","ref":"","_id":"5722653d49df4f0e00528491"},{"name":"to","type":"yyyy-mm-dd","default":"","desc":"The end date with format YYYY-MM-DD","required":true,"in":"body","ref":"","_id":"5722653d49df4f0e00528490"},{"name":"amount","type":"double","default":"0.0","desc":"The nightly rate for this period","required":false,"in":"body","ref":"","_id":"5722653d49df4f0e0052848f"},{"name":"minimumStay","type":"string","default":"1","desc":"The minimum amount of nights accepted for booking during this period","required":false,"in":"body","ref":"","_id":"5722653d49df4f0e0052848e"},{"name":"isCheckinAllowed","type":"boolean","default":"","desc":"Allow checkin for this date","required":false,"in":"body","ref":"","_id":"5df8ae9e3b4a4e001254b81a"},{"name":"isCheckoutAllowed","type":"boolean","default":"","desc":"Allow checkout for this date","required":false,"in":"body","ref":"","_id":"5df8ae9e3b4a4e001254b819"}],"results":{"codes":[{"name":"","status":400,"language":"json","code":"Orbirental API - Bad request."}]},"settings":"","examples":{"codes":[{"language":"text","code":""},{"code":"","language":"text"},{"language":"text","code":""}]}},"next":{"description":"","pages":[]},"title":"/pricingperiods/","type":"endpoint","slug":"pricingperiods-1","excerpt":"This API allows developers to remotely set the nightly rates for properties. This can also be used to interface the Hostfully Platform with a Price Automation / Yield Management service.","body":"","updates":[],"order":65,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5de85dbbb0b885003ddf3356","editedParams2":true,"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"},"createdAt":"2016-04-28T19:32:13.778Z","editedParams":true,"parentDoc":null,"user":"56e371538b32a10e00f79750","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"},"githubsync":"","__v":5,"project":"56e3719a591f620e00bf5095"}

post/pricingperiods/

This API allows developers to remotely set the nightly rates for properties. This can also be used to interface the Hostfully Platform with a Price Automation / Yield Management service.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

uid:
required
string
The unique ID of the property
from:
required
yyyy-mm-dd
The start date with format YYYY-MM-DD
to:
required
yyyy-mm-dd
The end date with format YYYY-MM-DD
amount:
double0.0
The nightly rate for this period
minimumStay:
string1
The minimum amount of nights accepted for booking during this period
isCheckinAllowed:
boolean
Allow checkin for this date
isCheckoutAllowed:
boolean
Allow checkout for this date

Result Format


User Information

Try It Out

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