DokuWiki

Goal

1. LRS subsite should be billable based on the statements. There will be a trail period for few days that can be done by super site admin under site subscription.
2. Once the trail period is expired subsite admin should subscribe the plan based on the statements e.g : (Ex- Free - 500 statements, plan A - 2000, plan B - 5000, plan C - 9000 and etc.)
3. We should be able to track the statements of every period and be able to charge subsite as per different plans. Also, if the statement count exceeds the allowed plan's count, overage statements are billable
4. A Super site admin can set up a subscription settings and different types of subscription plan
5. Subscription plan will have different subscription type(Day/Week/2Week/Monthly/Quarterly/Yearly) which can be given to various subsite.
6. If the price of the subscription changes then the user shall be notified.
7. A User will have an option to Un-subscribe at any time.

The following Models will be used for Implementation

class Company < ActiveRecord::Base
  #This model already exists just add below association
  belongs_to :site_subscription
end

class SubscriptionSetting < ActiveRecord::Base 
end 

class SubscriptionPlan < ActiveRecord::Base
  has_many :site_subscriptions
  has_many :site_orders
  has_many :site_custom_plans , :dependent => :destroy
end

class SiteSubscription < ActiveRecord::Base
  belongs_to :subscription_plan
  has_one :company, :dependent => :destroy
  has_many :site_orders
  has_many :site_order_items, :through => :site_orders, :dependent => :destroy
  has_many :payments_made, :class_name => "SitePayment", :foreign_key => "payer_id"
  has_many :site_usages
  has_one :site_custom_plan, :dependent => :destroy
  has_one :custom_plan, :through => :site_custom_plan, :source => :subscription_plan
end

class SiteOrder < ActiveRecord::Base
  belongs_to :site_subscription
  belongs_to :subscription_plan
  has_one :site_payment, :dependent => :destroy
  has_many :site_order_items, :dependent => :destroy
end

class SiteOrderItem < ActiveRecord::Base
  belongs_to :site_order
  belongs_to :item, :polymorphic => true
end

class SiteCustomPlan < ActiveRecord::Base
  belongs_to :subscription_plan
  belongs_to :site_subscription
end

class SitePayment < ActiveRecord::Base
  belongs_to :site_order
  belongs_to :payer, :class_name => "SiteSubscription"
  belongs_to :user_paid, :class_name => "User", :foreign_key => "payer_user_id"
end

Table Name: companies(This table already exists. Just add following columns)

Table Name: subscription_settings

Table Name: subscription_plans

Table Name: site_custom_plan

Table Name: site_subscriptions

Table Name: site_orders

Table Name: site_order_items

Table Name: site_payments

Table Name: site_usages

Saves the statement details for each and every billing cycle at the end of the billing cycle.

General flow of record creation

When company purchases subscription

1. Create a record in site_orders and site_order_items. At present the items for an order will always be 1 viz. subscription. Set payment_status = NIL
2. Generate the parameters that need to be sent to payment gateway and based on those parameters and the site_order_id create a record in site_payments table. Set 'status' column to NIL. After the response from the gateway is received, update the 'response' column of site_payments and based on the success or failure update the 'status' column. Also update the payment_status column in site_orders table to proper value i.e. success or failure.
3. Also if payment was successful then update the site_subscriptions table with proper status, preapproval_id and last_payment_id and last_payment_status

Recurring Billing

1. Run the cron job which will run the task to check the site billing period end time from site_usages table and make the recurring billing and follow the above payment process steps

Overage statements

1. Subsite admin has to pay from billing page, The overage statement and the pricing information will be shown.