Membership

The Membership module is where all settings related to membership types and price plans along with the membership experience and journey within the organization are managed. Rules for member subscriptions including access permissions (by price plan), and renewals (including transition and grace periods) would be set up within the Membership module. Specific settings that control the member journey such as join settings (e.g. join/approval settings, email confirmations, etc.), renewal settings (e.g. auto-renew options, upon renew actions, email confirmations, etc.), payment settings (e.g. online vs. offline options, confirmation text, etc.).

Related API Endpoints

  • Entities can have one active subscription at a time per account

  • Membership can be attached to different entity types (e.g. on one account, a company record and a person record could both have their own individual membership)

    • On Multi-Chapter accounts, members can have subscriptions to each individual chapter account.

  • Membership can be created through a join form

  • Membership can be renewed through a renewal form

Subscription Fields

  • SubscriptionId

  • Name

  • FriendlyId

  • Status

  • Kind

  • IsMain

  • Type

  • UsedByEntity

  • Entity (complex field)

    • EntityId

    • EntityName

    • EntityTypeId

  • AccountEntity (complex field)

    • AccountId

    • AccountName

    • AccountEntityId

  • MembershipType (complex field)

    • MembershipTypeName

    • MembershipTypeCode

    • MembershipTypeId

  • PricePlan (complex field)

    • PricePlanName

    • PricePlanCode

    • PricePlanId

  • JoinedOn

  • AppliedOn

  • ApprovedOn

  • StartsOn

  • EndsOn

  • ExpiresOn

  • ValidUntil

  • OriginalEndsOn

  • DeclinedOn

  • ExtendedOn

  • CreatedOn

  • AutoRenewOn

  • RePaymentOn

  • OriginalAutoRenewOn

  • AutoRenewAttempt

  • AutoRenewPaymentAttempt

  • LockedAutoRenewOn

  • OrderId

  • OrderBalance

  • PricePaid

  • OriginalPrice

  • PriceRefunded

  • CancellationReason

  • CancellationComment

  • FormResultId

  • NextStatusUpdateOn

  • NeverUpdateStatus

  • NeverUpdateStatusMessage

  • OriginalSubscriptionId

  • NextSubscriptionId

  • PreviousSubscriptionId

Subscriptions

When a member joins or renews, the system automatically creates a membership subscription based on the membership type/price plan settings. The active subscription grants the member access to the system for the term of their membership.

Membership subscriptions can be:

  • Paid

  • Free

Subscription Types

  • new - fresh subscription

  • renewal - renewed subscription

  • reinstated - renewed subscription after grace period

Subscription Statuses

  • Active

  • Pending

  • Declined

  • Expired

  • Active (Grace)

  • Terminated

  • Active (Cancelled)

  • Future

Subscription Status Flow

Subscription status changes are triggered either manually or through a system-driven action.

  • User driven

    • on Subscription list

    • custom configuration using triggers (on forms, views, listings)

  • System driven

    • automation (auto renewal)

    • Service

      • Future → Active When new term starts

      • Active (Cancelled) → Terminated When term end and grace period is over

      • Active → Active (Grace) When term ends and grace period starts

      • Active → Expired When term ends and there is no grace period

      • Active (Grace) → Expired When grace period ends