Glossary

Organization

A business entity or group that holds one or more apps. Organizations manage API keys, members, memberships, and perks. Sandbox orgs are isolated for testing.

App

An application within an organization. Apps can be white-label (user-facing) or API-key-based (B2B).

Member

A person registered in an organization (e.g., a travel agent, admin, or analyst).

Membership

A user's enrollment in a perk program or loyalty tier within an organization.

Tier

A membership level (e.g., Gold, Platinum) that determines benefit allocation and redemption rules.

Perk

A single benefit or service a user can redeem: lounge access, hotel discount, flight upgrade, etc.

Count Ledger

A tracking mechanism that records point/credit allocations and redemptions in a transaction log. See /v1/memberships/{id}/perks/points/transactions.

Point Ledger

A variant of the count ledger that tracks a specific type of currency (miles, points, credits).

Allocation

An award of points or perks to a user (e.g., "allocated 1000 miles on signup").

Redemption

A user's consumption of a perk or points (e.g., "redeemed 500 miles for lounge access").

Circle

A group of users (e.g., a family, team, company) that can share benefits or control allocations together.

Sandbox

A testing environment isolated from production where you can experiment with the API without real charges.

BYOK

"Bring Your Own Key" — a billing mode where organizations provide their own AI provider API key instead of using VanityPass's shared platform key.

X-Environment

A header (X-Environment: Sandbox or X-Environment: Production) that routes a request to the appropriate database schema and billing tier.