Overview

Requirements

Installation

$ pip install django-saas-billing

Setup

#    settings.pyINSTALLED_APPS= [                       ...,'rest_framework','subscriptions_api','cryptocurrency_payment',#for crypto payments'saas_billing'                       ]SUBSCRIPTIONS_API_SUBSCRIPTIONTRANSACTION_MODEL='saas_billing.SubscriptionTransaction'SAAS_BILLING_MODELS= {'stripe': {'plan':'saas_billing.StripeSubscriptionPlan','cost':'saas_billing.StripeSubscriptionPlanCost','subscription':'saas_billing.StripeSubscription'           },'paypal': {'plan':'saas_billing.PaypalSubscriptionPlan','cost':'saas_billing.PaypalSubscriptionPlanCost','subscription':'saas_billing.PaypalSubscription'           }       }SAAS_BILLING_AUTH= {'stripe': {'PUBLISHABLE_KEY':'Your Publishable Key','LIVE_KEY':'You Live key can be test or live','CANCEL_URL':'Where you want to redirect to if user cancels payment','SUCCESS_URL':' Where to redirect to if subscription is successful'           },'paypal': {'CLIENT_ID':'Your paypal rest client id','CLIENT_SECRET':'Your paypal rest secret id','TOKEN':None,'ENV':'live|development','CANCEL_URL':'Where to redirect to if subscription fails','SUCCESS_URL':'Where to redirect to if subscription is successful','WEB_HOOK_ID':'Your paypal rest webhook id'           }   }CRYPTOCURRENCY_PAYMENT= {"BITCOIN": {"CODE":"btc","BACKEND":"merchant_wallet.backends.btc.BitcoinBackend","FEE":0.00,"REFRESH_PRICE_AFTER_MINUTE":15,"REUSE_ADDRESS":False,"ACTIVE":True,"MASTER_PUBLIC_KEY":'PUT_YOUR_WALLET_MASTER_PUBLIC_KEY',"CANCEL_UNPAID_PAYMENT_HRS":24,"CREATE_NEW_UNDERPAID_PAYMENT":True,"IGNORE_UNDERPAYMENT_AMOUNT":10,"IGNORE_CONFIRMED_BALANCE_WITHOUT_SAVED_HASH_MINS":20,"BALANCE_CONFIRMATION_NUM":1,"ALLOW_ANONYMOUS_PAYMENT":False,"DERIVATION_PATH":"m/0","ADDRESS_TYPE":"p2wpkh"   }}DFS_DEFAULT_PLAN_COST_ID='Optional Put plan cost id here for new user to be automatically subscribed to this plan or subscription to be downgraded here'

path('',include('saas_billing.webhook_urls'))#Compulsory for webhook register url webhook on paypal and stripe#create webhook url https://yourdomain.com/billing/stripe/webhook/#https://yourdomain.com/billing/paypal/webhook/path('api/subscriptions/',include('subscriptions_api.urls')),path('api/',include('saas_billing.urls')),

Usage

Step 1

https://yourdomain/billing/stripe/webhook/#Please use ngrok on  localhosthttps://yourdomain/billing/paypal/webhook/

#apps.pyclassMyAppConfig(AppConfig):defready(self):importsaas_billing.signals

Step 2

pythonmanage.pymigrate

fromsubscription_api.modelsimportSubscriptionPlan,PlanCost,MONTHfree_plan=SubscriptionPlan(plan_name='Free Plan',features='{"can_perform_action": false, "token_limit": 3}',group=optional_already_created_group_obj_user_will_be_added_to)free_plan.save()pro_plan=SubscriptionPlan(plan_name='Pro Plan',features='{"can_perform_action": true, "token_limit": 10}',group=already_created_group_obj).save()pro_plan.save()PlanCost(plan=pro_plan,recurrence_unit=MONTH,cost=30,min_subscription_quantity=20).save()#30$/month #min_subscription_quantity user must subscribe upto quantity to use this cost

Tips

#In your code or views you can useifnotuser.subscription.plan.can_perform_action:print('I am a free user')else:print('I am a pro user')# features is a json dict that can be accessed from plan and group is normal django group that user will belong to# You should be able to implement most subscriptions access and permissions with the feautures and django groups

Step 3

pythonmanage.pybillinggatewayall# Create all plans on stripe.com and paypal.compythonmanage.pybillinggateway<paypal|stripe># Create   only on paypal.com or Stripe.compythonmanage.pybillinggateway<paypal|stripe>--action<activate|deactivate># Activate or Deactivate plans

Tips

Getting Active Subscriptions Of a User

subscription=request.user.subscriptions.filter(active=True).first()#if you only allow a subscription per usersubscription.transactions.all()#returns all transaction payment of this subscriptionsrequest.user.subscriptions.filter(active=True).all()#for all subscriptions if you allow multiple subscription per user

transactions=request.user.subscription_transactions.all()#Returns all payment trasnsaction for this user

Building A Payment And Active Subscription View

fromsaas_billing.modelsimportSubscriptionTransaction#import this to show crypto paymentsfromsubscriptions_api.base_modelsimportBaseSubscriptionTransaction# use this to only show paypal & stripe paymentclassBillingView(ListView):model=BaseSubscriptionTransactioncontext_object_name='payment_transactions'template_name='transactions.html'defget_queryset(self):returnself.request.user.subscription_transactions.order_by('-date_transaction')defget_context_data(self,**kwargs):context=super().get_context_data(**kwargs)context['active_subscription']=self.request.user.subscriptions.filter(active=True).first()returncontext

<!-- transactions.html --><tableclass="table table-bordernone display"id="basic-1"><thead><tr><thscope="col">Date</th><thscope="col">Subscription</th><thscope="col">Amount</th><thscope="col">Status</th></tr></thead><tbody>           {% for tran in payment_transactions %}<tr><td>{{ tran.payment_transactions }}</td><td><divclass="product-name">{{ tran.subscription_name }}</div></td><td>${{ tran.amount }}</td><td>Paid</td></tr>           {% endfor %}</tbody></table>

Step 4

How To Subscribe A User to a Plan Cost

$.ajax({url:'/api/plan-costs/${id-of-cost}/init_gateway_subscription/',{gateway:'paypal',quantity:1}}).then((post_return_data)=>{window.open(post_return_data.payment_link,'_blank').focus();})

(post_return_data)=>{varstripe=window.Stripe(YOUR_STRIPE_PUBLIC_KEY)returnstripe.redirectToCheckout({sessionId:post_return_data.session_id})}

Tips Api URL To use in frontend app for drf users

'/api/subscriptions/subscription-plans/'#Get all plans to display in frontend'/api/subscriptions/get_active_subscription/'# Returns active UserSubscription Object for the current logged in user'/api/subscriptions/${id}/unsubscribe_user/'# Unsubscribe user from subscription with ${id}'/api/transactions/'# Get payment transactions'/api/transactions/${id}/'# Get single payment transaction with ${id}

Testing

$ pip install -r requirements.txt

$ ./runtests.py

$ tox

Documentation

$ pip install mkdocs

$ mkdocs serveRunning at: http://127.0.0.1:8000/

$ mkdocs build