Read Rate plan

GET

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

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

Read an existing instance.

A pricing plan attached to a property or brand. Reservations reference a rate plan to determine pricing, inclusions, and cancellation policy.

Authorizations

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

properties

required

object

cancellation_policy

Cancellation policy

string

code

required

Rate plan code

string

commissionable

Whether stays on this plan earn agent commission (default true)

boolean

currency

required

Currency (ISO 4217)

string format: iso-4217

day_use

Day-use plan (sells zero-night day slots; default false)

boolean

derived_modifier_kind

Derived modifier kind (bar_grid only)

string

Allowed values: percent absolute

description

Description

string

inclusion

required

Inclusion

string

Allowed values: room_only breakfast half_board full_board all_inclusive

max_stay_nights

Maximum nights

integer

min_stay_nights

Minimum nights

integer

name

required

Rate plan name

string

pricing_strategy

required

Pricing strategy

string

Allowed values: bar_grid open_pricing hybrid static_contract

yieldable

required

Yieldable by revenue agent

boolean

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.rate_plan",
  "properties": {
    "derived_modifier_kind": "percent",
    "inclusion": "room_only",
    "pricing_strategy": "bar_grid"
  },
  "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).