From 1f21988881258d0b361119e8ebdff92114b8794a Mon Sep 17 00:00:00 2001 From: Sunny Tyagi <107617248+Tyagi-Sunny@users.noreply.github.com> Date: Wed, 15 Jan 2025 12:05:02 +0530 Subject: [PATCH] docs(subscription-service): update readme to include plan customization (#59) ## Description update readme to include plan customization Fixes # (issue) ## Type of change Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Intermediate change (work in progress) ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - [ ] Test A - [ ] Test B ## Checklist: - [ ] Performed a self-review of my own code - [ ] npm test passes on your machine - [ ] New tests added or existing tests modified to cover all changes - [ ] Code conforms with the style guide - [ ] API Documentation in code was updated - [ ] Any dependent changes have been merged and published in downstream modules Co-authored-by: yeshamavani <83634146+yeshamavani@users.noreply.github.com> --- services/subscription-service/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/services/subscription-service/README.md b/services/subscription-service/README.md index 545f007..ec01947 100644 --- a/services/subscription-service/README.md +++ b/services/subscription-service/README.md @@ -14,6 +14,27 @@ A Microservice for handling subscription management operations. It provides - ## Billing & Invoicing we have created a package [loopback4-billing](https://github.com/sourcefuse/loopback4-billing) that is designed to integrate billing functionality into LoopBack 4 applications. It provides an abstraction layer to work with billing services such as Chargebee, Stripe etc, offering common billing operations like creating and managing customers, invoices, payment sources, and transactions. +## Customizing Plans with Sizes and Features +This feature allows for the creation and management of plans with different sizes and features. Plans are used to represent various service tiers or options you offer to your customers. Sizes define the overall scope or capacity of a plan, while features are specific functionalities that can be enabled or disabled for each plan. + +The Plan Customization feature consists of two main aspects: +- Plan Sizes: Manage different plan sizes and their configurations. +- Plan Features: Customize features associated with a specific plan. + +#### Plan Sizes + +Plan sizes are defined by the PlanSizes model. Here's a breakdown of PlanSize: + +- size: The name or label of the plan size (string, required) +- config: An optional object that can hold additional configuration details specific to the plan size + + +#### Plan Features + +Plan features are managed through the FeatureValues model and associated with plans using the PlanFeaturesController. Here's a breakdown of the relevant concepts: + +- Feature: Represents a general capability or functionality offered in your plans. +- FeatureValues: This model associates features with specific plans and allows configuration of their values. ## Installation