GrowstackAI-Credit-Lib

📚 Table of Contents

• About
• Information
• Key Features
• Installation
• Usage
• Documentation
• Requirement Background
• License

About

The GrowstackAI-Credit-Lib is a powerful library designed to help manage credit-based subscription systems in Growstack applications.

This system enables easy plug-and-play credit management through an npm package.
It supports functions to deduct credits, add credits, and upgrade plans at both user and organization levels.

It is lightweight, scalable, and designed specifically for AI services that often charge based on token usage.

Information

• Library Name: GrowstackAI-Credit-Lib
• Purpose: Manage credit balances, transactions, and plan upgrades for users and organizations across Growstack services.
• Installation Command: npm i growstackai-credit-lib
• Integration: Import the library into your microservice and use simple functions to interact with the credit system.
• Technology Stack: Node.js, Microservices Architecture
• Environment: B2B and B2C SaaS models
• API Coverage:
  • Add Credits
  • Deduct Credits
  • Upgrade Plan
  • Retrieve Credit Balance
• Supported Levels: User Level, Organization Level
• Scalable: Designed to easily extend for new pricing models and third-party integrations.

Key Features

• 🔌 Plug and Play microservice integration.
• ➕ Add Credits for users or organizations.
• ➖ Deduct Credits based on token/usage consumption.
• 📈 Upgrade Plans dynamically.
• 🎯 Dynamic Token-to-Credit Mapping to optimize costs.
• 🏢 Manage B2B and B2C Subscriptions.
• 🛠️ Simple API for seamless integration.
• 📊 Track Transactions and monitor balances.

Installation

Install the package via npm:

npm install growstackai-credit-lib