mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
chore(schemas): add comments for ReservedPlanId
(#5542)
This commit is contained in:
parent
ecd3db2c71
commit
cec57e3c33
1 changed files with 23 additions and 0 deletions
|
@ -1,6 +1,29 @@
|
|||
/**
|
||||
* Logto-provided predefined subscription plan IDs.
|
||||
*
|
||||
* In theory, the subscription plan ID will be a random string,
|
||||
* but Logto provides some predefined subscription plans and their IDs are reserved plan IDs.
|
||||
*/
|
||||
export enum ReservedPlanId {
|
||||
Free = 'free',
|
||||
/**
|
||||
* @deprecated
|
||||
* In recent refactoring, the `hobby` plan is now treated as the `pro` plan.
|
||||
* Only use this plan ID to check if a plan is a `pro` plan or not.
|
||||
* This plan ID will be renamed to `pro` after legacy Stripe data is migrated by @darcyYe
|
||||
*
|
||||
* Todo @darcyYe:
|
||||
* - LOG-7846: Rename `hobby` to `pro` and `pro` to `legacy-pro`
|
||||
* - LOG-8339: Migrate legacy Stripe data
|
||||
*/
|
||||
Hobby = 'hobby',
|
||||
/**
|
||||
* @deprecated
|
||||
* Now this `pro` ID is not used anymore, we use `hobby` as the `pro` plan ID.
|
||||
* Only use this `pro` value when displaying the plan ID to the user.
|
||||
*
|
||||
* Todo @darcyYe see `Hobby` todo
|
||||
*/
|
||||
Pro = 'pro',
|
||||
Development = 'dev',
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue