Read Membership tier

GET

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

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

Read an existing instance.

A tier definition that admits Saint Haven (quota_ladder), Soho House Every House vs Local House (scope_set), RH Members (discount_bundle), and Aman Founders (recognition_band) without per-operator extension. The tier_kind enum is the load-bearing distinguisher; the shape-specific fields (quota_size, prorates_on_change, transferable, legacy_initiation) become meaningful only when the tier_kind calls for them.

Authorizations

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

properties

required

object

code

required

Tier code

string

description

Description

string

is_active

required

Currently offered (sunset tiers coexist with active tiers)

boolean

legacy_initiation

required

Tier carries a non-recurring initiation fee (see commit 3 membership_initiation)

boolean

name

required

Tier name

string

prorates_on_change

required

Prorates dues on mid-cycle tier change

boolean

proration_method

Proration method (required when prorates_on_change = true)

string

Allowed values: daily monthly none

quota_remaining

Quota remaining (denormalised projection)

integer

quota_remaining_computed_at

When quota_remaining was last computed

string format: date-time

quota_size

Quota size (required when tier_kind = quota_ladder)

integer

refund_policy_text

Refund policy snapshot at tier creation (design-spec §B.2)

string

tier_kind

required

Tier kind (load-bearing — see enum docs)

string

Allowed values: quota_ladder scope_set discount_bundle recognition_band

transferable

required

Tier survives original member's death / departure (Aman Founders legacy)

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.membership_tier",
  "properties": {
    "proration_method": "daily",
    "tier_kind": "quota_ladder"
  },
  "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).