In this section: Elite status

Elite status

Elite status tiers a member holds and the benefits each one grants.

compare_atmos_earning

Compare Alaska Atmos Rewards distance, price and segment earning for one traveler's flights under the rules effective 2027-01-01 (2025/2026 input is a replay, not posted history).

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
travel_yearintegerrequired2025, 2026 or 2027: the departure year compared.
flightsobject[]requiredOne object per traveler per flight number. Fields (* required): id*; departure_date*; marketing_carrier; operating_carrier; ticket_stock; booking_channel (alaska_hawaiian
defaultsobject{elite_status, elite_status_held_all_year}: the tier for rows without one; held_all_year for a status match.
other_status_pointsnumberNon-flight status points.
other_redeemable_pointsnumberNon-flight redeemable points.
detail_offsetintegerPaging.
detail_limitintegerRows returned; default all (500).

get_elite_status

The user's elite status, self-reported and card-granted. elite_status is what the member TOLD Miles. card_granted is what their cards give: held (now) and available (gated behind enrollment/registration/spend -- never report as held).

ScopeQuota
miles:readstandard

No parameters.

get_status_benefits

What an airline/hotel elite TIER grants -- checked bags, lounge access, upgrades, breakfast, late checkout, points bonus, and an estimated annual value. Reference data about the program; it reads nothing about the member (get_elite_status is what they hold).

ScopeQuota
miles:readstandard
NameTypeRequiredDescription
programstringrequiredThe airline or hotel loyalty program to describe, e.g. Alaska Atmos Rewards or World of Hyatt. Reference data about the program, not the member's own status.
tierstringOne elite tier within the program, e.g. Atmos Gold. Omit for the program's full tier ladder.

remove_elite_status

Forget a stored elite status -- the member lost it, never had it, or it was recorded against the wrong program. Requires wallet-change access. Removes every stored spelling of the program.

ScopeQuota
miles:writestandard
NameTypeRequiredDescription
programstringrequiredThe loyalty program whose stored elite status to forget, e.g. World of Hyatt. Every stored spelling of the program is removed. To change a tier instead, call set_elite_status.
memberstringHousehold member whose status it is; omit for the member's own.

set_elite_status

Record elite status the member says they hold, and how far along they are toward the next hotel tier. Requires wallet-change access.

ScopeQuota
miles:writestandard
NameTypeRequiredDescription
programstringrequiredThe loyalty program the status is held in, e.g. World of Hyatt -- a program Miles knows; get_elite_status lists them as known_programs. One call per program; calling again for the same program replaces that program's stored tier.
tierstringThe tier exactly as the member stated it, e.g. Globalist. Omit only when updating a night count for a program that already has a stored tier, or when storing nights_per_year. Never inferred.
nights_ytdintegerQualifying hotel nights this year, a whole number exactly as the member states it. The program's own count already includes card-granted elite night credits, so pass it through unchanged. Hotels only.
nights_ytd_as_ofstringThe calendar date the nights_ytd count is current as of, written YYYY-MM-DD. Omit for today.
nights_bookedintegerNights booked but not yet stayed, a whole number kept as a separate forecast alongside nights_ytd.
memberstringHousehold member who holds it, by name; omit for the member's own. An unknown name is refused: ask who.
nights_per_yearintegerRoughly how many nights a year they stay with this program, NOT counting card elite night credits.