entitlement

Documentation

Index

• Variables
• type OrganizationService
• type PlanService
• type ProductService
• type Service
  • func NewEntitlementService(subscriptionService SubscriptionService, featureService ProductService, ...) *Service
  • func (s *Service) Check(ctx context.Context, customerID, featureOrProductID string) (bool, error)
  • func (s *Service) CheckPlanEligibility(ctx context.Context, customerID string) error
• type SubscriptionService

Variables

var (
	ErrPlanEntitlementFailed = fmt.Errorf("plan entitlement failed")
)

Types

type OrganizationService

type OrganizationService interface {
	MemberCount(ctx context.Context, orgID string) (int64, error)
}

type PlanService

type PlanService interface {
	GetByID(ctx context.Context, id string) (plan.Plan, error)
}

type ProductService

type ProductService interface {
	List(ctx context.Context, f product.Filter) ([]product.Product, error)
	GetFeatureByID(ctx context.Context, id string) (product.Feature, error)
	GetByID(ctx context.Context, id string) (product.Product, error)
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewEntitlementService

func NewEntitlementService(subscriptionService SubscriptionService,
	featureService ProductService, planService PlanService,
	organizationService OrganizationService) *Service

func (*Service) Check

func (s *Service) Check(ctx context.Context, customerID, featureOrProductID string) (bool, error)

Check checks if the customer has access to the feature or product

func (*Service) CheckPlanEligibility

func (s *Service) CheckPlanEligibility(ctx context.Context, customerID string) error

CheckPlanEligibility checks if the customer is eligible for the plan

type SubscriptionService

type SubscriptionService interface {
	List(ctx context.Context, filter subscription.Filter) ([]subscription.Subscription, error)
}