billops

Elevate your business with us

Glimpse

About the Project

Managing Subscription and billing

billops is a subscription management platform for businesses. It helps businesses manage their subscription models, billing, and user data. Billops offers a dashboard with analytics like revenue, subscribers, and retention rate. Businesses can also manage their subscriptions, coupons, and user details. Billops provides a secure API for organizations to access their data and webhooks to capture payments.

Built With

• Next.js
• React.js
• Tailwind CSS
• Prisma.io
• Shadcn
• Supabase

Installation

To run this project locally, follow these steps:

1. Clone the repository: git clone https://github.com/Abinash4567/billops
2. Install dependencies: npm install
3. Set up pgAdmin or supabase database on your need
4. Create a .env file like .env.example
5. Add database, URL and secret keys in environment variables
6. Migrate prisma model to database: npx prisma migrate
7. Check middleware.ts under billops/src/ and comment line 11 for local run or line 12 for cloud deployment.
8. Start the development server: npm run dev

Usage

1. After setting up the project locally, access the application at localhost:3000.
2. Create an account or log in.
3. Mangage Users, Subscription under dashboard.

API Endpoints

POST /api/v1/subdetail

Parameters

Name	Required	Type	Description
orgId	required	Int	Organization Key acts like unique key to identify your organization which is to be passed inside body. To see your organization key, head over to setting under dashboard.
APIKey	required	string	API key is high security string which protects endpoint from misuse. Every organization registered under billops has unique one and can be regenerated according to your requirement. It is fired under header section.

Response status Code: 200

{
    "subscriptionDetail": [
        {
            "id": 1,
            "type": "Premium",
            "intendedAudience": "Freelancer, Education",
            "price": "13",
            "features": {
                "Updates": "No",
                "Revisions": "No",
                "Team Size": "2",
                "Web hooks": "No",
                "Video Client": "No",
                "24 Hour Update": "Yes",
                "Customer Support": "No"
            },
            "couponCodes": {
                "hello": "23",
                "selllo": "12"
            },
            "validity": 6
        }
    ]
}

or Status Code: 404

{
    "message": "We are unable to find your organization."
}

or Status Code: 500

{
  message: "Internal Server Error"
}

POST /api/v1/subdetail

Parameters

Name	Required	Type	Description
orgId	required	Int	Organization Key acts like unique key to identify your organization which is to be passed inside body. To see your organization key, head over to setting under dashboard.
userId	required	string	userId is unique user registered in your organization.
APIKey	required	string	API key is high security string which protects endpoint from misuse. Every organization registered under billops has unique one and can be regenerated according to your requirement. It is fired under header section.

Response status Code: 200

{
    "userDetail": [
        {
            "id": 1,
            "name": "foo",
            "email": "[email protected]",
            "planExpiry": "2024-10-13T17:39:47.415Z",
            "planType": "Premium"
        }
    ]
}

or Status Code: 404

{
    "message": "We are unable to find your organization or user."
}

or Status Code: 500

{
  message: "Internal Server Error"
}

Webhook

POST /api/v1/verifypayment

Parameters

1. Webhook integrated from Razorpay on payment capture
2. userId and subId are required under notes field to validate payment.
3. name and email are optional for recurring user but compulsory for new user (Best to include everytime).

Sample Response from Razorpay

{
  entity: 'event',
  account_id: 'acc_M8U2zJ2Lq8Frjk',
  event: 'payment.captured',
  contains: [ 'payment' ],
  payload: 
  { 
     payment: 
     	{ 
           entity: 
  	     {
		  id: 'pay_NyurD8IVtZ7zpk',
		  entity: 'payment',
		  amount: 49900,
		  currency: 'INR',
		  status: 'captured',
		  order_id: 'order_NyuqYOVecmJ4sX',
		  invoice_id: null,
		  international: false,
		  method: 'netbanking',
		  amount_refunded: 0,
		  refund_status: null,
		  captured: true,
		  description: 'Thank you for nothing. Please give us some money',
		  card_id: null,
		  "notes": 
		  {
		    "userId": 1,
		    "subId" 12,
                    "name": "foo",
                    "email": "[email protected]", 
		    "address": "Razorpay Corporate Office"
		  },
		  bank: 'PUNB_R',
		  wallet: null,
		  vpa: null,
		  email: '[email protected]',
		  contact: '+918797837542',
		  fee: 1178,
		  tax: 180,
		  error_code: null,
		  error_description: null,
		  error_source: null,
		  error_step: null,
		  error_reason: null,
		  acquirer_data: { bank_transaction_id: '8435702' },
		  created_at: 1713188029,
		  reward: null,
		  base_amount: 49900
	     }



         } 
  },
  created_at: 1713188034
}

Database Model

---