Policy **

The Policy capability extends both Product and Option objects with the fields cancellable, refundable, cutOff, holdablePeriod and cancelPolicy that contains policy information related to holds and bookings. This means that if the policy fields are added to the Product, they relate to the product. If the policy fields are added to the Option, they relate to the Option. It is possible that both Product and Option have different policy fields. In case there are no fields defined for the Option, the policy fields of the associated product will be adopted.

X-Capabilities: redeam/policy

Product

The Policy capability allows additional policy fields to be added to the policy object that relates to the Product.

Field Name	Type	Required	Description
`cancellable`	bool	No	Indicates whether Bookings with this Product can be cancelled after confirmation
`refundable`	bool	No	Indicates whether Bookings with this Product can be refunded after confirmation
`cutOff`	integer	No	The minimum amount of time (in minutes) between the current time and the start time of a new hold
`holdablePeriod`	integer	No	The maximum amount of time (in seconds) between a booking hold creation and its expiration time

{ "id": "8f13bb02-7d5e-4b1e-bf39-3ac2ec7ac6d0", // .. rest of the Product object "policy": { "cancellable": true, "cutOff": 86400, "refundable": true "holdablePeriod": 86400, }

Option

The Policy capability allows additional policy fields to be added to the policy object that relates to the Option under the Product.

Field Name	Type	Required	Description
`cancellable`	bool	No	Indicates whether Bookings with this Option can be cancelled after confirmation.
`refundable`	bool	No	Indicates whether Bookings with this Option can be refunded after confirmation.
`cutOff`	integer	No	The minimum amount of time (in minutes) between the current time and the start time of a new hold
`holdablePeriod`	integer	No	The maximum amount of time (in seconds) between a booking hold creation and its expiration time
`cancelPolicy`	string	No	Text details defining the cancellation policy

{ "id": "b760a5a8-eca4-4e44-aded-0d9a8add41b6", // .. rest of the Option object "policy": { "cancellable": true, "cutOff": 86400, "refundable": false "holdablePeriod": 86400, }

Last updated on

Was this page helpful?