Skip to main content

plans.go

plans.go - Overview​

  1. Overview

This file defines constants and variables related to different subscription plans (Basic, Pro, Enterprise) and their associated features. It also includes a mapping for converting old plan keys to new plan names.

  1. Detailed Documentation

Constants:

  • SSO: String constant representing Single Sign-On.
  • Basic: String constant representing the Basic plan.
  • Pro: String constant representing the Pro plan.
  • Enterprise: String constant representing the Enterprise plan.
  • PlanNameEnterprise: String constant "ENTERPRISE".
  • PlanNameTeams: String constant "TEAMS".
  • PlanNameBasic: String constant "BASIC".
  • LicenseStatusInvalid: String constant "INVALID".
  • DisableUpsell: String constant "DISABLE_UPSELL".
  • Onboarding: String constant "ONBOARDING".
  • ChatSupport: String constant "CHAT_SUPPORT".
  • Gateway: String constant "GATEWAY".
  • PremiumSupport: String constant "PREMIUM_SUPPORT".

Variables:

  • MapOldPlanKeyToNewPlanName: A map that translates old plan keys (e.g., "BASIC", "TEAMS", "ENTERPRISE") to new plan names (e.g., Basic, Pro, Enterprise).
    • Type: map[string]string
    • Purpose: To provide a mapping between older plan naming conventions and the current plan names.
  • BasicPlan: A basemodel.FeatureSet variable that defines the features available in the Basic plan.
    • Type: basemodel.FeatureSet
    • Purpose: Holds a collection of basemodel.Feature structs, each representing a specific feature and its attributes (Name, Active, Usage, UsageLimit, Route).
  • ProPlan: A basemodel.FeatureSet variable that defines the features available in the Pro plan.
    • Type: basemodel.FeatureSet
    • Purpose: Holds a collection of basemodel.Feature structs, each representing a specific feature and its attributes (Name, Active, Usage, UsageLimit, Route).
  • EnterprisePlan: A basemodel.FeatureSet variable that defines the features available in the Enterprise plan.
    • Type: basemodel.FeatureSet
    • Purpose: Holds a collection of basemodel.Feature structs, each representing a specific feature and its attributes (Name, Active, Usage, UsageLimit, Route).
  1. Code Examples

Not applicable; the file mainly consists of variable declarations.

  1. Clarity and Accuracy

The documentation is based on direct observation of the code.

Include in Getting Started: NO