Skip to content

Latest commit

 

History

History
107 lines (58 loc) · 2.18 KB

File metadata and controls

107 lines (58 loc) · 2.18 KB

@letsgo/pricing

@letsgo/pricing

This package defines the pricing plans of your app.

Table of contents

Interfaces

Variables

Functions

Variables

ActivePlans

Const ActivePlans: Plan[]

The list of active plans only.

Defined in

index.ts:117


DefaultPlanId

Const DefaultPlanId: string = "free"

The default plan Id to use for all new tenants. This is typically a freemium plan.

Defined in

index.ts:55


Plans

Const Plans: Plan[]

The list of all plans, active and non-active. Never remove a plan from this list that has any active tenants using it, even if you no longer offer this plan to new users. Mark it as active: false instead.

Defined in

index.ts:61

Functions

getActivePlan

getActivePlan(planId): Plan | undefined

Gets an active plan by Id.

Parameters

Name Type Description
planId string The plan Id

Returns

Plan | undefined

The plan if it exists and is active, undefined otherwise.

Defined in

index.ts:124


getPlan

getPlan(planId): Plan | undefined

Gets a plan by Id.

Parameters

Name Type Description
planId string The plan Id

Returns

Plan | undefined

The plan or undefined if it does not exist.

Defined in

index.ts:133