Register rate plan

POST

/v1/actions/hospitality.action.register_rate_plan/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.register_rate_plan/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "code": "example", "currency": "example", "description": "example", "inclusion": "room_only", "name": "example", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "return_modified": false }'

• Production API

Register a rate plan at property_id under its code, with its name, inclusion (what a night includes beyond the room) and currency; optionally a description. Upsert by code: the same code again restates the plan in place (a renamed rate updates, never duplicates; an identical restatement writes nothing; a field the call does not carry is left alone). The code is tenant-unique, so a code already registered at another property is refused. Pricing strategy and yieldability take the type’s defaults (open pricing, yieldable) and are set by the revenue surface afterwards. Links the plan to its property (property_has_rate_plan) on first registration. A Mews connector provisions one per active rate of the bookable service (code == the rate id, inclusion room-only — Mews attaches products to a rate rather than naming a board basis, currency == the enterprise default). Emits rate_plan.registered.

Effects: create hospitality.rate_plan; modify hospitality.rate_plan; link hospitality.link.property_has_rate_plan.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.register_rate_plan: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

code

required

The rate plan's code (trimmed; the tenant-unique business key — a vendor's rate id when a connector provisions it)

string

currency

required

The currency the plan is priced in (ISO 4217)

string format: iso-4217

description

A description of the plan

string

inclusion

required

What a night on the plan includes beyond the room

string

Allowed values: room_only breakfast half_board full_board all_inclusive

name

required

The rate plan's name

string

property_id

required

The property the rate plan is sold at

string format: uuid

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

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.property_has_rate_plan

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.rate_plan

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.property_has_rate_plan"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.rate_plan"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.