Update: Razorpay api updated

Author: Shafaf

.env.sample

@@ -1,29 +1,10 @@
-# APP_DB_DRIVER=postgresql
-# APP_DB_USER=postgres
-# APP_DB_PASS=postgres
-# APP_DB_HOST=localhost
-# APP_DB_PORT=5432
-# APP_DB_DATABASE=boilerplate_db
-
 # Set the POSTGRES_USER and POSTGRES_PASSWORD 
 export POSTGRES_USER=<user>
 export POSTGRES_PASSWORD=<password>
 export POSTGRES_HOST=<postgres>
 export POSTGRES_PORT=<5432>
-export POSTGRES_DB=<razorpay>
-
-
-# SQLALCHEMY_POOL_SIZE=10
-# SQLALCHEMY_POOL_TIMEOUT=300
-# SQLALCHEMY_POOL_RECYCLE=100
-# SQLALCHEMY_MAX_OVERFLOW=5
-
-# FLASK_WEBSERVER_ADDRESS=0.0.0.0
-# FLASK_WEBSERVER_PORT=8088
-
-# GUNICORN_WEBSERVER_TIMEOUT=30
-# GUNICORN_WORKERS=5
-
-# FLASK_CONFIG_FILE_PATH=config.py
+export POSTGRES_DB=<postgres_db>
 
-# MIGRATION_FOLDER_PATH=./src/migrations
+# Razorpay api key
+export RAZORPAY_API_KEY_ID="XXXXXXX"
+export RAZORPAY_API_SECRET="XXXXXXX"

README.md

@@ -1,8 +1,6 @@
 <div align="center">
   <h1><code>Razorpay Python Client </code></h1> 
-  <p><strong><em>Python bindings for interacting with the Razorpay API
-
-This is primarily meant for merchants who wish to perform interactions with the Razorpay API programatically.</em></strong></p>
+  <!-- <p><strong><em>Python bindings for interacting with the Razorpay API This is primarily meant for merchants who wish to perform interactions with the Razorpay API programatically.</em></strong></p> -->
 </div>
 
 ---

api/v1/plan.py

@@ -3,8 +3,8 @@
 
 from . import v1
 from model.subscription import Plan
+from extension import db, client
 
-from extension import db
 
 class Plans(MethodView):
     def get(self):
@@ -13,10 +13,13 @@ def get(self):
             {
                 "id": plan.id,
                 "name": plan.name,
+                "period" : plan.period,
+                "currency" : plan.currency,
                 "description": plan.description,
                 "amount": plan.amount,
                 "intervals": plan.intervals,
-                "plan_id": plan.plan_id
+                "plan_id": plan.plan_id,
+                "notes" : plan.notes
             }
             for plan in plans
         ]
@@ -29,6 +32,8 @@ def post(self):
         plan_name = req.get("name")
         plan_amount = req.get("amount")
         plan_interval = req.get("interval")
+        plan_period = req.get("period")
+        currency = req.get("currency")
 
         if plan_name is None:
             return jsonify({"message": "name is required"}), 400
@@ -38,18 +43,39 @@ def post(self):
 
         if plan_interval is None:
             return jsonify({"message": "interval is required"}), 400
-        
-        plan = Plan(
-            name=plan_name,
-            description=req.get("description"),
-            amount=plan_amount,
-            intervals=plan_interval,
-            plan_id=req.get("plan_id")
-        )
-        
-        db.session.add(plan)
-        db.session.commit()    
-        
-        return jsonify({"id": plan.id}), 201
+    
+
+        try:
+            plan = client.plan.create({
+                "period": plan_period,
+                "interval": plan_interval,
+                "item": {
+                    "name": plan_name,
+                    "amount": plan_amount,
+                    "currency": currency,
+                    "description": req.get("description")
+                },
+                "notes": req.get("notes")
+            })
+            
+            plan = Plan(
+                name=plan_name,
+                period=plan_period,
+                currency=currency,
+                description=req.get("description"),
+                amount=plan_amount,
+                intervals=plan_interval,
+                plan_id=plan["id"],
+                notes=req.get("notes")
+            )
+            
+            db.session.add(plan)
+            db.session.commit()    
+            
+            return jsonify({"id": plan.id}), 201
+            
+        except Exception as e:
+            db.session.rollback()
+            return jsonify({"error": str(e)}), 500
 
 v1.add_url_rule("/plan", view_func=Plans.as_view("plan"))

api/v1/subscription.py

@@ -3,7 +3,7 @@
 
 from . import v1
 from model.subscription import Subscription, Plan, User
-from extension import db
+from extension import db, client
 
 
 class Subscriptions(MethodView):
@@ -36,24 +36,42 @@ def post(self):
         if not Plan.query.filter_by(id=plan_id).all():
             return jsonify({"message" : "Not a valid plan_id"})
 
+        # get plan id.
+        razorpay_plan_id = Plan.query.filter_by(id=plan_id).first()
+        
         # check is valid user_id
         user_id = req.get("user_id")
         if user_id is not None:
             user_exists = User.query.filter_by(id=user_id).first()
             if not user_exists:
                 return jsonify({"message": "Not a valid user_id"}), 400
 
-        sub = Subscription(
-            plan_id = req.get("plan_id"),
-            razorpay_user_id = req.get("razorpay_user_id"),
-            subscription_id = req.get("subscription_id"),
-            user_id = user_id,
-            subscription_status = req.get("subscription_status")
-        )
-        
-        db.session.add(sub)
-        db.session.commit()
+        try:
+            subscription = client.subscription.create({
+                "plan_id": razorpay_plan_id.plan_id,
+                "customer_notify": 1,
+                "quantity": req.get("quantity"),
+                "total_count": req.get("total_count"),
+                "notes": req.get("notes")
+            })
+            
+            sub = Subscription(
+                plan_id = req.get("plan_id"),
+                total_count = req.get("total_count"),
+                notes = req.get("notes"),
+                quantity = req.get("quantity"),
+                razorpay_user_id = req.get("razorpay_user_id"),
+                subscription_id = req.get("subscription_id"),
+                user_id = user_id,
+                subscription_status = req.get("subscription_status")
+            )
+            
+            db.session.add(sub)
+            db.session.commit()
 
-        return jsonify({"id": sub.id}), 201
+            return jsonify({"id": sub.id, "payment_url" : subscription["short_url"]}), 201
+        except Exception as e:
+            db.session.rollback()
+            return jsonify({"error": str(e)}), 500
 
 v1.add_url_rule("/subscription", view_func=Subscriptions.as_view("subscription"))

connection.py

@@ -1,14 +1,17 @@
 import os
 
 # Get the environment variables
-pg_user = os.getenv('POSTGRES_USER', "muhammedshafaf")
+pg_user = os.getenv('POSTGRES_USER', "postgres_user")
 pg_pass = os.getenv('POSTGRES_PASSWORD', "postgres")
-pg_host = os.getenv('POSTGsRES_HOST', "localhost")
+pg_host = os.getenv('POSTGRES_HOST', "localhost")
 pg_port = os.getenv('POSTGRES_PORT', "5432")
-pg_db = os.getenv('POSTsGRES_DB', "demodb")
+pg_db = os.getenv('POSTGRES_DB', "postgres_db")
 
 
 SQLALCHEMY_DATABASE_URI = os.getenv(
     "DATABASE_URL",
     f"postgresql://{pg_user}:{pg_pass}@{pg_host}:{pg_port}/{pg_db}",
 )
+
+RAZORPAY_KEY_ID = os.getenv('RAZORPAY_API_KEY_ID', None)
+RAZORPAY_SECRET = os.getenv('RAZORPAY_API_SECRET', None)

extension.py

@@ -1,5 +1,9 @@
 from flask_sqlalchemy import SQLAlchemy
 from flask_migrate import Migrate
+import razorpay
+
+from connection import RAZORPAY_KEY_ID, RAZORPAY_SECRET
 
 db = SQLAlchemy()
-migrate = Migrate()
+migrate = Migrate()
+client = razorpay.Client(auth=(RAZORPAY_KEY_ID, RAZORPAY_SECRET))

model/subscription.py

@@ -1,16 +1,24 @@
-from sqlalchemy import Column, String, Integer, ForeignKey, Enum
+from sqlalchemy import Column, String, Integer, ForeignKey, Enum, JSON
 from sqlalchemy.orm import Mapped, mapped_column
 from extension import db
 
 class Plan(db.Model):
     __tablename__ = "plan"
+    PERIOD_CHOICES = ["daily", "weekly", "monthly", "yearly"]
 
     id = Column(Integer, primary_key=True, nullable=False)
+    period = Column(
+        Enum(*PERIOD_CHOICES, name="period_types", native_enum=False),
+        nullable=False,
+        default="monthly"
+    )
+    currency = Column(String, nullable=False)
     name = Column(String, nullable=False)
     description = Column(String(300), nullable=True)
     amount = Column(Integer, nullable=False)
     intervals = Column(Integer, nullable=False)
     plan_id = Column(String)
+    notes = Column(JSON, nullable=False)
 
 class Subscription(db.Model):
     __tablename__ = "subscription"
@@ -19,9 +27,12 @@ class Subscription(db.Model):
 
     id = Column(Integer, primary_key=True, nullable=False)
     plan_id = Column(Integer, ForeignKey(Plan.id), nullable=False)
+    total_count = Column(Integer, nullable=False)
     razorpay_user_id = Column(String)
     subscription_id = Column(String)
     user_id = Column(Integer, ForeignKey("user.id"), nullable=True)
+    notes = Column(JSON, nullable=True)
+    quantity = Column(Integer, nullable=True)
     subscription_status = Column(
         Enum(*STATUS_CHOICES, name="status", native_enum=False),
         nullable=False,

requirements.txt

@@ -2,4 +2,6 @@ Flask==3.0.2
 psycopg2==2.9.9
 SQLAlchemy==2.0.29
 Flask-SQLAlchemy
-Flask-Migrate
+Flask-Migrate
+razorpay==1.4.2
+setuptools