Set cancellation policy

POST

/v1/actions/hospitality.action.set_cancellation_policy/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_cancellation_policy/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "applies_to_no_show": "inherit_last_tier", "code": "example", "currency": "example", "description": "example", "name": "example", "non_refundable": true, "notice_window_basis": "local_property_time", "tiers": [ { "applies_to": "cancellation", "penalty_amount": { "amount": "example", "currency": "example" }, "penalty_kind": "absolute", "penalty_nights": 1, "penalty_rate": "example", "trigger_offset_hours_before_arrival": 1 } ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Author the property’s cancellation terms — the rule booking resolves into a reservation’s frozen cancellation schedule, and the night audit’s no-show sweep charges from. Upsert by code: a repeated code rewrites that policy in place. Unlike the deposit engine there is no dated succession, because a reservation freezes the resolved money at booking and an edit here can no longer reach a booked stay — which is also Apaleo’s contract (“changing a cancellation policy will not affect existing reservations”). tiers is the ladder, sorted descending by trigger_offset_hours_before_arrival; exactly one of penalty_amount / penalty_rate / penalty_nights is set per tier, matching its penalty_kind. A non-refundable rate ships non_refundable = true with empty tiers. Attach to a rate plan via rate_plan_requires_cancellation_policy to outrank the property default.

Effects: create hospitality.cancellation_policy; modify hospitality.cancellation_policy; link hospitality.link.cancellation_policy_at_property.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.set_cancellation_policy:apply

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

applies_to_no_show

required

How a guest who never arrives is charged

string

Allowed values: inherit_last_tier separate_no_show_tier always_100_percent

code

required

Policy code — the terms' identity within the property

string

currency

required

Currency the penalties are denominated in (ISO 4217)

string format: iso-4217

description

Operator-facing description; also the wording a booking freezes

string

name

required

Display name, as the guest sees it

string

non_refundable

required

Advance-purchase shape: the whole stay is forfeit from the moment of booking, and `tiers` is ignored

boolean

notice_window_basis

required

Which clock the notice window is measured on

string

Allowed values: local_property_time guest_local_time utc

tiers

The penalty ladder (omit for a non-refundable or fully flexible policy)

Array<object>

object

applies_to

required

string

Allowed values: cancellation no_show both

penalty_amount

object

amount

required

string format: decimal

currency

required

string format: iso-4217

penalty_kind

required

string

Allowed values: absolute percent_of_total n_nights

penalty_nights

integer

penalty_rate

string format: decimal

trigger_offset_hours_before_arrival

required

integer

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.property

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.cancellation_policy_at_property

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created modified

object_type

required

Allowed values: hospitality.cancellation_policy

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.cancellation_policy_at_property"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.cancellation_policy"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.