Appearance
TiruPay
TiruPay is a centralized payment and subscription management platform. It acts as the single source of truth for all subscription, order, and article-related data across your services.
Instead of implementing complex billing logic in every service you build, TiruPay handles it for you.
Core Concepts
Services
A Service is the top-level organization unit. Each service represents a separate integration (e.g. a SaaS product or business division). Services are fully isolated from each other and come with their own customers, articles, orders, and configuration.
Customers
A Customer represents a person or company purchasing from a service. Customers can have orders, balances, mandates, and linked user accounts.
Articles
An Article represents a product or service that can be sold either as a one-time purchase or as a recurring subscription. Articles can unlock Features and top up Balances upon purchase.
Orders & Subscriptions
Orders track all purchases. They follow a lifecycle from draft to completion, supporting one-time payments and recurring billing. Subscriptions can be paused, upgraded, terminated, or extended with add-ons (Article Extensions).
Features
Features are boolean or integer values tied to articles. When a customer purchases an article, the associated features are activated. This lets your services check feature access without managing subscription logic themselves.
Balance System
TiruPay provides a two-tiered balance system:
- Service-Specific Balances: Track consumption per balance type (e.g. API calls, storage) within a service. Supports pay-as-you-go (PAYG) billing.
- Credit Balance: A global prepaid wallet that works across all services and can be used as payment method within any service.
Coupons
Coupons provide percentage or amount-based discounts, targetable to specific articles or categories.
Key Features
- Multi-Provider Payment Processing: Integrates seamlessly with Mollie, Stripe, and Nemo (in-house) via the Payment Processor Microservice.
- Subscription Management: Recurring billing with configurable intervals, upgrades and downgrades.
- Tax Compliance: Multi-country tax support with country-specific tax categories and payment method restrictions.
- Invoicing: Optional automatic invoice generation with the SevDesk integration.
- Role-Based Access Control: Four user roles (User, Service-User, Admin, Superadmin) with fine-grained permissions.
- Audit Trail: Feature change logging and full order lifecycle tracking.
API
The API is split into three access tiers:
- User API (
/user) - For end users to view their orders, features, and subscriptions. - Service API (
/service) - For service integrations to manage customers, articles, orders, and payments. - Admin API (
/admin) - For administrators to configure services, users, and system-wide settings.
How It Works
- Configure your Service in TiruPay with articles, features, and payment methods.
- Create Customers via the Service API.
- Create Orders for one-time purchases or subscriptions.
- Process Payments through the Payment Processor, which handles provider-specific logic.
- Query Features from your service to determine what a customer has access to.