Perks & Balances

Manage membership perk balances, view transaction history, and redeem perks for services. All endpoints are scoped to a membership and require a valid JWT.

Total Perk Balance

GET /v1/memberships/{membership_id}/perks/counts/balance

Total perk count balance across all product types for the membership. Returns a summary of available perk counts grouped by product type.

curl -X GET 'https://cloud.vanitypass.com/v1/memberships/{membership_id}/perks/counts/balance' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \

Balance by Product Type

GET /v1/memberships/{membership_id}/perks/counts/balance/{product_type}

Balance for a specific product type (e.g. lounge, fast_track, meet_and_greet). Returns the available count and any expiry information for the given product type.

curl -X GET 'https://cloud.vanitypass.com/v1/memberships/{membership_id}/perks/counts/balance/{product_type}' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \

Perk Transactions

GET /v1/memberships/{membership_id}/perks/counts/transactions

Transaction history for all perk types on this membership. Returns a paginated list of perk credit and debit events with timestamps and service references.

curl -X GET 'https://cloud.vanitypass.com/v1/memberships/{membership_id}/perks/counts/transactions' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \

Redeem Perk

POST /v1/memberships/{membership_id}/perks/redeem

Redeem a perk for a specific product type. Deducts from the membership's perk balance and returns a redemption reference that can be presented at the service point.

curl -X POST 'https://cloud.vanitypass.com/v1/memberships/{membership_id}/perks/redeem' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \
  -d '{"product_type":"lounge","quantity":1}'

Perk Action Logs

GET /v1/memberships/{membership_id}/perks/action-logs

Audit log of perk actions for the membership. Returns a chronological record of all perk-related events including redemptions, grants, adjustments, and expirations.

curl -X GET 'https://cloud.vanitypass.com/v1/memberships/{membership_id}/perks/action-logs' \
  -H 'Content-Type: application/json' \
  -H 'X-Environment: Sandbox' \