Billing

The Admin Billing Module provides comprehensive billing and subscription management capabilities for administrators, including subscription oversight, payment processing, and billing analytics across the DashClicks platform.

Module Overview

The Admin Billing system manages subscription lifecycles, payment processing, and billing operations within the platform, providing tools for subscription management, payment retry operations, and billing oversight.

Submodules

Subscription Management

Core subscription management operations including subscription retrieval, filtering, and administrative subscription oversight functionality.

Key Features:

• Administrative subscription listing with advanced filtering
• Subscription search across multiple criteria (partner, buyer, product)
• Status-based filtering (active, canceled, past_due, etc.)
• Product-type filtering and subscription categorization

API Endpoints:

• GET /v1/admin/billing/subscriptions - Retrieve subscriptions with filtering
• GET /v1/admin/billing/filters - Get subscription filter counts

Payment Operations

Administrative payment management including subscription payment retry, cancellation, and payment processing operations.

Key Features:

• Subscription payment retry for past-due subscriptions
• Subscription cancellation (immediate and period-end)
• Subscription cancellation resume functionality
• Payment processing and Stripe integration management

API Endpoints:

• POST /v1/admin/billing/subscription/:sub_id - Retry subscription payment
• DELETE /v1/admin/billing/subscription/:sub_id - Cancel subscription
• PUT /v1/admin/billing/subscription/:sub_id/resume - Resume canceled subscription

Billing Analytics

Billing analytics and reporting for administrative insights into subscription performance, revenue metrics, and payment patterns.

Key Features:

• Subscription lifecycle analytics and reporting
• Revenue metrics and payment pattern analysis
• Administrative insights into billing performance
• Subscription health monitoring and reporting

API Endpoints:

• Administrative analytics endpoints for billing metrics

Core Service Methods

The Admin Billing module implements six primary service methods:

querySubs(filters, sort, pagination)

• Retrieves subscriptions with comprehensive administrative filtering
• Supports status-based filtering and product-type filtering
• Provides search functionality across partner, buyer, and product data
• Includes subscription aggregation with partner/buyer/product lookup

retrySub(subId)

• Retries payment for past-due subscriptions
• Integrates with Stripe to process payment retry
• Updates subscription status based on payment success
• Provides detailed error handling for payment failures

cancelSub(subId, immediate)

• Cancels subscriptions with immediate or period-end options
• Manages Stripe subscription cancellation workflow
• Updates subscription status and pending task flags
• Handles invoice verification for canceled subscriptions

resumeCancelSub(subId)

• Resumes previously canceled subscriptions
• Reverses period-end cancellation settings
• Updates subscription status to active
• Provides cancellation reversal functionality

clearSub(subId)

• Clears pending task flags for canceled subscriptions
• Manages subscription cleanup operations
• Updates subscription administrative status
• Handles post-cancellation subscription management

getFilters(billingFilters)

• Generates filter counts for administrative filtering
• Provides status-based and product-based filter statistics
• Supports dynamic filter count calculation
• Enables administrative filter interface functionality

Integration Points

Stripe Payment Processing

• Direct Stripe API integration for payment operations
• Subscription lifecycle management through Stripe
• Payment retry and cancellation workflow automation
• Invoice management and verification

Account Management Integration

• Partner (seller) account lookup and information
• Buyer account information and relationship management
• Account-based subscription filtering and organization

Product Catalog Integration

• Product information lookup and display
• Product-type based filtering and categorization
• Subscription-product relationship management
• Tier and pricing information display

Technical Architecture

Database Collections

• _store.subscriptions - Primary subscription collection
• _accounts - Account information for partners and buyers
• _store.products - Product catalog for subscription details
• Aggregation pipelines for complex subscription data assembly

Stripe Integration

• Stripe Subscriptions API for lifecycle management
• Stripe Invoices API for payment processing
• Stripe Payment Methods for payment retry operations
• Webhook integration for real-time subscription updates

Navigation

Choose a submodule to explore specific functionality:

• Subscription Management - Core subscription retrieval and filtering
• Payment Operations - Payment processing and subscription lifecycle
• Billing Analytics - Billing metrics and administrative insights

Related Modules

• Admin Accounts - Account-level billing management
• Admin Orders - Order and subscription creation workflow
• Admin Analytics - Platform-wide billing analytics