Monetization
Plans and Subscriptions
The Plans & Subscriptions module under API Monetization allows portal administrators to create, manage, and publish API subscription plans. These plans determine how consumers access APIs, either through fixed subscription tiers or pay-as-you-go usage-based billing.
Plans
The Plans section allows portal administrators to create, configure, and publish monetization plans for APIs. Two plan types are supported; Subscription-Based Plans and Usage-Based Plans, enabling both recurring billing and pay-per-use models.
Purpose
To define pricing models, billing tiers, and feature entitlements associated with API products.
Key Capabilities
Create and publish monetization plans for API products
Define subscription tiers with pricing, call limits, and feature details
Link plans to digital products for tracking and billing
Configure both fixed (subscription) and metered (usage-based) models
How to Create a Plan
Login to the portal as a Portal Admin.
Navigate to API Monetization → Plans & Subscriptions → Plans.
Click Add Plan and choose one of the two types
Plan Types and Configuration
1. Subscription-Based Plans
Used for recurring, tiered API access with fixed billing schedules and feature sets.
Steps to Create a Subscription-Based Plan
Log in to the site as a Portal Admin.
Navigate to API Monetization > Plans & Subscriptions > Plans.
Click Add Plan and select Subscription-Based.
Fill in the following fields:
Plan Name: Enter a descriptive plan title.
Description: Provide a clear summary of what the plan includes.
Text Format: Specify display formatting if applicable.
Under Subscription Tiers, add tier-specific details:
Billing Schedule: Define the frequency (e.g., monthly, quarterly, annual).
Tier Name: Identify each pricing or feature tier.
API Call Limit: Specify the maximum number of calls allowed per billing cycle.
Price (USD): Set the tier price in USD.
Short Description: Summarize the tier’s value proposition.
Features (Text Format): List the included benefits and capabilities.
Select Digital Product: Choose the API product associated with this plan.
Promotional Tags: Optionally tag the plan for marketing visibility.
Click Create Subscription Tier to finalize tier details.
Select the Published checkbox to make the plan live.
Click Save to complete the setup.
2. Usage-Based Plans
Designed for flexible, pay-as-you-go models where users are billed based on actual API consumption.
Steps to Create a Usage-Based Plan
In the same Plans section, click Add Plan and select Usage-Based.
Provide the following details:
Plan Name: Define the name for your pay-per-use plan.
Under the Tiers section, configure:
Billing Schedule: Specify when billing occurs (e.g., monthly).
Tier Name: Label the usage tier.
Free API Call Credits: Define how many API calls are free before billing begins.
Minimum Price (USD): Set the base cost for the plan.
Price per API Call (Post Free Credits): Indicate the charge per call after free credits are used.
Features (Text Format): Describe the functionality included.
Select Digital Product: Link the plan to an existing digital API product.
Select the Published checkbox to make the plan available.
Click Save to activate the usage-based plan.
Benefits
Flexible Monetization: Support for both recurring and usage-based billing models.
Tiered Offerings: Enable differentiated access levels to cater to developers, partners, and enterprises.
Automation: Seamlessly link pricing and billing with digital products.
Visibility & Control: Manage publication status and promotions directly within the admin interface.
Manage Subscriptions
The Manage Subscriptions section provides administrators with a centralized dashboard to view and track all active customer subscriptions. Each entry includes details such as plan name, tier, billing type, and customer information.
Key Features
View all active and historical subscriptions
Filter by customer email, plan name, or tier
Access subscription details and manage renewals
Export subscription data for reporting
How to Use
Navigate to API Monetization → Plans & Subscriptions → Subscriptions.
Use the search filters to find a specific subscription by Email or Plan Name.
Review subscription details such as Plan Type, Billing Type, and Subscription Date.
Click View under the Operations column to open the subscription details.
Optionally, export the data in CSV format for external analysis.
Manage Orders
The Manage Orders section provides visibility into customer orders associated with API plans — both one-time and recurring. It enables administrators to track billing states, verify payments, and manage customer invoices.
Key Features
Monitor all default and recurring orders
Filter orders by ID, Type, or State (Active, Billed, etc.)
Access order details and transaction history
Print or download order receipts in PDF format
How to Use
Navigate to API Monetization → Plans & Subscriptions → Orders.
Use filters to narrow results by Order ID, Type, or State.
Review order details including Customer Name, Total Amount, and Order Date.
Click View under Operations to open detailed order information.
Download or print order details as needed.
Use the Export to CSV option to generate a report of all visible orders.
Manage Invoices
The Manage Invoices section offers a consolidated view of all billing invoices generated from customer orders. It tracks payment status, issue dates, and customer details to maintain a complete billing record.
Key Features
Access all generated invoices with status tracking
Filter by customer name, invoice date, or payment status
View, print, or download invoices in PDF format
Export invoice data for reconciliation or reporting
How to Use
Navigate to API Monetization → Plans & Subscriptions → Invoices.
Search by Customer Name or filter by Status (Paid, Pending, Refunded).
Review invoice details such as Invoice Date, Amount, and Payment Status.
Click View to open an invoice and access Print or Download PDF options.
Use the Export to CSV function to download invoice summaries.
Last updated