Read Membership subscription

GET

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

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

Read an existing instance.

The recurring billing primitive. Distinct from membership because the subscription is the contract+autopay shape (Mindbody Premier’s separation), not the access entitlement. One member who downgrades from monthly to quarterly billing keeps the same membership but transitions to a new subscription row. The subscription attaches to the account, not to an individual membership — a family rate spans the primary + dependent memberships under one contract.

Authorizations

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

properties

required

object

amount

Membership subscription amount

Recurring amount per cycle

object

amount

required

string format: decimal

currency

required

string format: iso-4217

auto_renew

required

Auto-renew (autopay flag)

boolean

cadence

required

Billing cadence

string

Allowed values: monthly quarterly semi_annual annual multi_year

cadence_value

required

Cadence value (for multi_year, the number of years; else 1)

integer

contract_terms_text

Contract-terms snapshot at signing (design-spec §B.2)

string

currency

required

Currency (ISO 4217)

string format: iso-4217

expected_end_date

Expected end (null for open-ended autopay)

string format: date

required

Subscription id

string

next_billing_date

Next scheduled charge date

string format: date

start_date

required

Subscription start

string format: date

suspension_started_at

When suspension started (required when suspension_state != none)

string format: date-time

suspension_state

Suspension state (typed reason)

string

Allowed values: none medically_suspended operator_paused self_paused

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_subscription",
  "properties": {
    "cadence": "monthly",
    "suspension_state": "none"
  },
  "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).