django-subscription-midtrans

A production-ready Django package for subscription billing with Midtrans Core API integration.

django-subscription-midtrans provides a full subscription management system with:

• Subscription Plans with configurable billing intervals, trials, and feature flags

• 7 Payment Methods: Credit Card, Bank Transfer (BCA/BNI/BRI/Permata/CIMB), GoPay, ShopeePay, QRIS, E-Channel, Wallet

• Automatic Billing via Celery Beat periodic tasks

• Invoice System with auto-generated line items

• Wallet & Top-Up with internal balance management

• Webhook Processing with SHA-512 signature verification

• Django Unfold Admin with status badges and bulk actions

• 20+ Django Signals for lifecycle events

• REST API via Django REST Framework

Important

This package uses the Midtrans Core API (/v2/charge, /v1/subscriptions, /v1/invoices), NOT Midtrans Snap.

Contents

Getting Started

• Installation
  • From PyPI
  • From Source (Development)
  • Requirements
  • Verify Installation
• Quick Start
  • 1. Add to INSTALLED_APPS
  • 2. Environment Variables
  • 3. Configure Django Settings
  • 4. Celery Configuration
  • 5. URL Configuration
  • 6. Run Migrations & Setup
  • 7. Start Services
  • Next Steps
• Configuration
  • SUBSCRIPTION_SETTINGS
  • Midtrans Settings
  • Celery Settings
  • REST Framework Settings
  • Environment Variables (.env)

User Guide

• Models
  • Plan
  • Subscription
  • Payment
  • Invoice
  • InvoiceItem
  • WebhookLog
  • NotificationLog
  • Wallet
  • WalletTransaction
  • TopUp
  • Entity Relationship Diagram
• Services
  • SubscriptionService
  • WalletService
• REST API Reference
  • Authentication
  • Plans
  • Subscriptions
  • Payments
  • Invoices
  • Webhook
  • Notifications
  • Wallet
  • Top-Ups
• Webhook Processing
  • Overview
  • Setup
  • Signature Verification
  • Processing Flow
  • WebhookLog Statuses
  • Security
  • Testing Webhooks Locally
• Celery Tasks
  • Setup
  • Task Reference
  • Task Summary Table
  • Customizing Schedules
• Signals
  • Connecting to Signals
  • Signal Reference
  • How Signals Are Dispatched
  • Example Use Cases
• Middleware
  • SubscriptionAccessMiddleware
• Wallet System
  • Architecture
  • How It Works
  • Top-Up Flow
  • Paying Subscription from Wallet
  • Balance Safety
  • Transaction Types
  • Wallet Signals
• Admin Dashboard
  • Features
  • Registered Models
  • Admin Navigation
  • Customization

Example Application

• Example Application
  • Running the Example
  • Pages
  • Template Tags
  • Example Views
  • Management Commands

Deployment

• Production Deployment
  • Environment Variables
  • Production Checklist
  • Gunicorn
  • Systemd Services
  • Nginx Configuration
  • Database Migrations
  • Monitoring
• Docker Deployment
  • docker-compose.yml
  • Dockerfile
  • .env for Docker
  • Running
  • Stopping

Architecture

• Architecture Diagrams
  • System Architecture
  • Subscription Lifecycle
  • Database Entity Relationship

Development

• Contributing
• Changelog

Indices and tables

• Index

• Module Index

• Search Page