Read Incidental hold policy

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.incidental_hold_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.incidental_hold_policy/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One property’s rule for the card hold a check-in suggests: a basis (the allowance per night, the room total plus the allowance per night, the room total plus a flat amount, or a flat amount — OPERA’s authorization rules 7, 2, 9 and 5), the allowance, and optionally the reservation guarantee it is for (a prepaid stay holds incidentals only, a card-guaranteed one the room as well). Rules are keyed by code within the property; suggest_incidental_hold picks the active rule for the reservation’s guarantee, falling back to the rule for any guarantee. Since 2026-10-19 a rule may also name a room type, a rate plan and a booking source (OPERA’s advanced rules, most specific first), four more of OPERA’s formulas (the room alone, per person, a percentage of the room), and the night audit’s top-up takes the rule’s allowance as what the card must still cover beyond the bill.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.incidental_hold_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.incidental_hold_policy

properties

required

object

active

required

Whether check-ins draw on this rule

boolean

allowance

required

Incidental hold policy allowance

The per-night allowance (per_night, room_and_per_night) or the flat amount (room_plus_flat, flat)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

basis

required

How the suggested hold computes

string

Allowed values: per_night room_and_per_night room_plus_flat flat room room_and_per_person_night per_person_night room_plus_percent

code

required

Policy code — the rule's identity within the property

string

description

Operator-facing description

string

guarantee

The reservation guarantee this rule is for; absent = any guarantee without a rule of its own

string

Allowed values: none hold credit_card deposit prepaid corporate_billed voucher

required

Incidental hold policy id

string

percent

The percentage of the room total `room_plus_percent` adds (10 = 10%)

string format: decimal

rate_plan_ref

The rate plan this rule is for; absent = any rate plan

string format: uuid

room_type_ref

The room type this rule is for; absent = any room type

string format: uuid

source

The booking source this rule is for; absent = any source

string

Allowed values: direct_web direct_call property_direct ota gds wholesale corporate walk_in group_block agent loyalty

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.incidental_hold_policy",
  "properties": {
    "basis": "per_night",
    "guarantee": "none",
    "source": "direct_web"
  },
  "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).