Read Cancellation policy

GET

/v1/object-types/hospitality.cancellation_policy/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.cancellation_policy/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.cancellation_policy/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Structured cancellation terms — an ordered penalty ladder keyed on hours-before-arrival, plus the no-show carve-out and the notice-window clock basis. Reservations bind both a live cancellation_policy_ref and a cancellation_policy_text snapshot at booking time per the structured-policy + immutable-snapshot pattern (design-spec §B.2). Brand-standard policies live at brand; bespoke / property-specific at property. Non-refundable advance-purchase rates ship with empty tiers, non_refundable = true, and applies_to_no_show = always_100_percent.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.cancellation_policy:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.cancellation_policy

properties

required

object

applies_to_no_show

required

No-show handling

string

Allowed values: inherit_last_tier separate_no_show_tier always_100_percent

code

required

Policy code

string

currency

required

Currency (ISO 4217)

string format: iso-4217

description

Operator-facing description

string

name

required

Display name

string

non_refundable

required

Non-refundable (advance-purchase shape)

boolean

notice_window_basis

required

Notice-window clock basis

string

Allowed values: local_property_time guest_local_time utc

tiers

required

Cancellation policy tiers

Penalty tier ladder (sorted descending by trigger offset)

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

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.cancellation_policy",
  "properties": {
    "applies_to_no_show": "inherit_last_tier",
    "notice_window_basis": "local_property_time",
    "tiers": [
      {
        "applies_to": "cancellation",
        "penalty_kind": "absolute"
      }
    ]
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).