LogoLogo
  • User Guide
    • Getting Started
      • Building a Usage-Based Product in Revenium
      • Setting Up & Using API Analytics & Observability
      • Setting Up & Using Product Analytics
      • Sending Data to Revenium's Metering API
      • Key Concepts & Relationships
    • Connect Your Data
      • cURL Commands for Testing
      • Container-Native Metering
      • Kong
        • Kubernetes Installation
      • Salesforce
        • Revenium Unmanaged Package
          • Anypoint API Experience Hub (AEH)
            • Anypoint API Experience Hub Unmanaged Package Post Installation Instructions
          • Anypoint Community Manager (ACM)
            • Anypoint Community Manager Package Post Installation Instructions
        • Revenium Lightning Web Components
          • Add Components to Experience Cloud site
          • Drop-In Storefront
          • Product Card
          • Product Card (Anypoint)
          • Product Checkout
          • Product Details Button
          • Usage History
          • API Access Requester
      • MuleSoft
        • Metering Policy Configuration
        • Offline Metering Policy Configuration
        • Anypoint API & API Group Synchronization
        • Revenium Connector
        • Disable Default Anypoint Community Manager (ACM) Email Notifications
      • Gravitee
      • Istio
      • Envoy
      • AWS API Gateway
      • Python & Django
      • Golang
      • Spring Boot
      • .Net
      • NodeJs
      • Java/JVM
      • Snowflake
      • Azure API Management
      • IBM
      • Custom Integrations Using Metering Beacons
        • JWT Enrichment
      • Offline Metering via Log Parsing
    • Sources
      • Metering Elements
      • Alerts
        • Alert History
    • API Keys
    • Products & Pricing
      • Product Lines
      • Pricing Rules
        • Revenium Scripting Language
          • RSL Reference
        • Execution Logs
      • SLA Definitions
      • SLA Violation Review
    • Customers
      • Customers
      • Subscribers
      • Subscriptions
      • Subscribers Credentials
      • Subscribers Notifications
    • Billing and Invoicing
      • Manage Refunds
    • Analytics
      • Revenue Analytics
      • Product Analytics
        • Custom Reports (Products)
      • Subscriber Analytics
        • New Subscribers
        • (Daily/Weekly/Monthly) Active Subscribers
        • Most Engaged Subscribers & Customers
        • Historical Usage
      • API Analytics
        • Performance & Availability
        • Compare Periods
        • Traffic by Geography
        • Advanced Search
        • Custom Reports
    • Profile
      • Profile
      • Revenium API Documentation
    • Settings
      • Revenium Users & Organizations
        • Access Permissions by User Type
      • Revenium Subscription
      • Revenium Organizations
      • Notification Templates
      • Transactions Logs
        • Analytics Transaction Log
        • Product Transaction Log
        • Subscription Audit Log
        • No Code Transaction Testing
      • Integrations
        • Data Sync
        • Export Configurations
        • Notification Providers
        • Payment Configurations
          • Customer VAT ID Support
        • ERP Configurations
        • External Integration Logs
        • Identity Providers
      • System Logs
      • Default Configuration Limits
Powered by GitBook

© Revenium - www.revenium.io

On this page
  • 2-Minute Overview
  • 1. Connect Your Data
  • 2. Create / Configure Your Data Sources
  • 3. Create A Product
  • 4. Create a Subscription
  • Optional Configurations
  • Subscriber Credentials
  • Configure Notification Templates
  1. User Guide
  2. Getting Started

Building a Usage-Based Product in Revenium

A step by step guide to build a usage-based product in Revenium, create a subscription, send invoices, and collect payments.

Last updated 7 months ago

2-Minute Overview

Start the video below for a quick review of the entire process before diving into the details below.

1. Connect Your Data

Use one of our many connectors to begin sending usage data to Revenium.

2. Create / Configure Your Data Sources

Once you have connected an API Gateway, SDK, or other data source to Revenium, you will you intend to use for analytics or for monetization in Revenium.

Sources are auto-created by Revenium once your platform is connected, but you'll still want to review the sources corrected and ensure they are configured as needed.

3. Create A Product

The product configuration is where you choose how much customers will pay you for access to your products. You can define recurring non-usage based charges such as a monthly subscription fee, usage-based charges that vary based on information received from the data sources added to the product, as well as many other optional attributes.

4. Create a Subscription

Optional Configurations

Subscriber Credentials

Credentials are used to allow you to report usage against a subscription on an additional level. For example, if your customer asks you to report on usage separately for two divisions, or separate subscribers, but wants all subscribers to be charged against the master subscription, you can achieve this goal through the use of Credentials.

Credentials are configured in Revenium with a unique identifier issued by your software or API gateway, and when that identifier is sent with the usage information, Revenium will categorize that usage accordingly under the master subscription.

Configure Notification Templates

Once Products are created, they can be resold multiple times to different end subscribers. You will create a subscription for each user who is licensed to use your product, and at the end of each invoicing period, the subscription owner will receive an invoice according to the pricing definition in the product. Need to collect automatically with a credit card? Just , that's it. No complex configuration required in Stripe. Provide the key, we'll take care of the rest.

If you'd like to dive a bit deeper into Subscriber Credentials and other key objects in Revenium, it may be helpful to review "" as well.

Revenium allows you to notify your Subscribers when common events occur to avoid having to build this functionality into your own application. Our default notifications are generic enough to be used in most situations, but most customers choose to to their own brand before going live.

Key Concepts & Relationships in Revenium
customize them
in this section
configure the data sources
1-Minute Overview of Auto-Discovery & Configuration of Sources
1-Minute Overivew of Creating & Managing Products
add your Stripe key to Revenium