Overview

Core Entities

User

The primary entity that holds memberships and receives benefits.

• Typically represents an individual person
• Can also represent a business, team, or organization

Examples:

• A sports club, gym or loyalty program: one user per individual
• A professional association:
  • either one user per business, or
  • one user per employee member, grouped under an organization

Product

A purchasable offering that grants access to benefits.

• Can be a subscription or one-off purchase
• Supports configuration such as:
  • start dates
  • billing intervals (recurring or one-time)
  • expiration rules
  • trial periods

Subscription

Connects a user to a product.

• Can be free or paid
• While active, it entitles the user to the product’s benefits

Invoice

Represents charges associated with a subscription.

• Generated per billing cycle for recurring subscriptions
• If unpaid, access to benefits can be revoked at renewal

Benefit

A defined entitlement a user can receive.

Examples:

• Access (e.g. gym entry)

• Allowances (e.g. 5 bookings per week)

• Value units (e.g. loyalty points)

• Products can include multiple benefits

• Simple setups may use a single boolean benefit (e.g. is_member)

Benefit Grant

A specific allocation of a benefit to a user.

• Defines quantity and validity
• Can be:
  • automatically created
  • manually assigned

Examples:

• 100 loyalty points
• 5 meeting room bookings

Supports:

• expiration rules (e.g. points expire after 1 year)
• consumption (e.g. points reduced when used)

Benefit Schedule

Automates the creation of benefit grants.

• Can run once or on a recurring basis

Example:

• Add 10 booking credits each billing cycle

Meter Event

Tracks usage or accrual of quantitative benefits.

• Decreases balance when benefits are used
• Increases balance when benefits are earned

Examples:

• Spending credits
• Earning loyalty points from purchases

How It Fits Together

1. A User purchases a Product through a Subscription (even for one-off products)
2. The subscription creates Benefit Grants for one-offs, or Benefit Schedules for recurring benefits
3. Schedules will generate Benefit Grants to the user on an ongoing basis
4. Meter Events adjust balances as benefits are used
5. Invoices track payment and can gate access