Chameleon

Credit Rules Management

Manage credit rules for user registration, AI generation, and system operations

Credit Rules Management

The Credit Rules Management system allows administrators to configure and manage credit rules that control how credits are granted and consumed throughout the system.

Overview

Credit rules define the logic for:

  • Registration bonuses: Credits given to new users
  • AI generation costs: Credits consumed for AI operations
  • Price tier bonuses: Credits granted with purchases
  • Manual adjustments: Admin-issued credit changes
  • System operations: Automated credit transactions

Features

Rule Types

The system supports several rule types:

  • Registration: Credits granted when users register
  • AI Generation: Credits consumed for AI content generation
  • Price Tier: Credits granted with product purchases
  • Manual: Admin-issued credit adjustments
  • System: Automated system operations

Rule Configuration

Each rule can be configured with:

  • Rule Key: Unique identifier (e.g., new_user, openai_text)
  • Rule Name: Display name for the rule
  • Credits Amount: Positive for grants, negative for consumption
  • Description: Optional rule description
  • Sort Order: Display order in lists
  • Status: Enabled/disabled state

Usage

Creating Credit Rules

  1. Navigate to Admin System → Credit Rules
  2. Click Add Rule button
  3. Configure the rule parameters:
    • Select rule type
    • Enter rule key and name
    • Set credits amount
    • Add description (optional)
    • Set sort order
    • Enable/disable rule
  4. Click Create to save

Managing Rules

  • View Rules: All rules are displayed in a table with filtering options
  • Edit Rules: Click edit button to modify existing rules
  • Delete Rules: Remove rules with confirmation dialog
  • Filter Rules: Filter by rule type and status

Rule Types in Detail

Registration Rules

  • Purpose: Grant credits to new users
  • Example: new_user rule grants 100 credits on registration
  • Usage: Automatically triggered during user registration

AI Generation Rules

  • Purpose: Define credit costs for AI operations
  • Example: openai_text rule consumes 10 credits per text generation
  • Usage: Applied when users generate AI content

Price Tier Rules

  • Purpose: Grant credits with product purchases
  • Example: starter_package grants 1000 credits with purchase
  • Usage: Triggered during successful payment processing

File Locations

  • Admin Interface: src/app/[locale]/(admin)/admin/credit-rules/page.tsx
  • API Routes: src/app/api/admin/credit-rules/
  • Types: src/types/credit-config.ts
  • Models: src/models/credit-rule.ts

Common Tasks

Set Up New User Bonus

  1. Create a registration rule with key new_user
  2. Set credits amount to desired bonus (e.g., 100)
  3. Enable the rule
  4. Test with new user registration

Configure AI Generation Costs

  1. Create AI generation rules for each provider/model
  2. Set negative credits amount for consumption
  3. Use descriptive rule keys (e.g., openai_gpt4, deepseek_text)
  4. Enable rules for active use

Manage Price Tier Bonuses

  1. Create price tier rules for each product
  2. Set positive credits amount for grants
  3. Use product IDs as rule keys
  4. Coordinate with payment system

Troubleshooting

Rules Not Applied

  • Check Status: Ensure rules are enabled
  • Verify Rule Key: Confirm correct key is used in code
  • Check Sort Order: Higher priority rules may override others

Credits Not Granted

  • Registration Rules: Verify rule is enabled and has positive amount
  • Price Tier Rules: Check product ID matches rule key
  • Manual Rules: Confirm admin has proper permissions

Credits Not Consumed

  • AI Generation Rules: Verify rule exists for provider/model
  • Negative Amount: Ensure consumption rules have negative values
  • Rule Key Match: Confirm code uses correct rule key