From 31b79eab16258eba2b9efc0c74ddbde94423b984 Mon Sep 17 00:00:00 2001 From: Abu Sakib Date: Mon, 15 Jun 2026 20:34:43 +0600 Subject: [PATCH] Move cloud API monetization inside 'Analytics & Monetization' section --- .../api-monetization/getting-started.md | 0 .../manage-paid-subscription-plans.md | 0 .../subscribe-to-paid-plan.md | 0 .../view-billing-and-usage.md | 0 .../analytics-and-monetization/overview.md | 46 +++++++++++++------ en/docs/cloud/api-monetization/overview.md | 23 ---------- en/mkdocs.yml | 25 +++++----- 7 files changed, 45 insertions(+), 49 deletions(-) rename en/docs/{cloud => analytics-and-monetization}/api-monetization/getting-started.md (100%) rename en/docs/{cloud => analytics-and-monetization}/api-monetization/manage-paid-subscription-plans.md (100%) rename en/docs/{cloud => analytics-and-monetization}/api-monetization/subscribe-to-paid-plan.md (100%) rename en/docs/{cloud => analytics-and-monetization}/api-monetization/view-billing-and-usage.md (100%) delete mode 100644 en/docs/cloud/api-monetization/overview.md diff --git a/en/docs/cloud/api-monetization/getting-started.md b/en/docs/analytics-and-monetization/api-monetization/getting-started.md similarity index 100% rename from en/docs/cloud/api-monetization/getting-started.md rename to en/docs/analytics-and-monetization/api-monetization/getting-started.md diff --git a/en/docs/cloud/api-monetization/manage-paid-subscription-plans.md b/en/docs/analytics-and-monetization/api-monetization/manage-paid-subscription-plans.md similarity index 100% rename from en/docs/cloud/api-monetization/manage-paid-subscription-plans.md rename to en/docs/analytics-and-monetization/api-monetization/manage-paid-subscription-plans.md diff --git a/en/docs/cloud/api-monetization/subscribe-to-paid-plan.md b/en/docs/analytics-and-monetization/api-monetization/subscribe-to-paid-plan.md similarity index 100% rename from en/docs/cloud/api-monetization/subscribe-to-paid-plan.md rename to en/docs/analytics-and-monetization/api-monetization/subscribe-to-paid-plan.md diff --git a/en/docs/cloud/api-monetization/view-billing-and-usage.md b/en/docs/analytics-and-monetization/api-monetization/view-billing-and-usage.md similarity index 100% rename from en/docs/cloud/api-monetization/view-billing-and-usage.md rename to en/docs/analytics-and-monetization/api-monetization/view-billing-and-usage.md diff --git a/en/docs/analytics-and-monetization/overview.md b/en/docs/analytics-and-monetization/overview.md index 151aa32d..929235ca 100644 --- a/en/docs/analytics-and-monetization/overview.md +++ b/en/docs/analytics-and-monetization/overview.md @@ -1,49 +1,69 @@ -# Analytics and Monetization with Moesif +# Analytics and Monetization -To provide enterprise-grade observability and usage-based billing, WSO2 API Platform integrates directly with Moesif, a leading analytics and monetization platform for AI and API products. +This page provides a high-level overview of what you can achieve with Moesif and API Platform API monetization features. + +## API Platform API Monetization +API monetization allows organizations to generate revenue from their APIs by offering paid subscription plans to API consumers. By integrating with Stripe as a payment provider, API Platform enables organizations to define flexible pricing models and manage billing for API usage directly from the console. + +With API monetization in API Platform, organizations can seamlessly monetize their APIs by creating paid subscription plans with various pricing models. This allows you to: + +- **Integrate with Stripe:** Connect your Stripe account to API Platform to handle payments and billing securely. +- **Define Flexible Pricing Models:** Create subscription plans using pricing models such as Free, Flat, Unit, Volume, and Graduated to match different business needs. +- **Enable Monetization Per API:** Choose which APIs offer paid plans, giving you granular control over your monetization strategy. +- **Manage Subscriptions:** API consumers can discover and subscribe to paid plans via the Developer Portal, streamlining the purchasing experience. + +By monetizing APIs through API Platform, organizations gain a streamlined way to offer tiered access, manage billing, and grow API-driven revenue. + +### Getting Started + +1. **Configure Stripe:** Add your Stripe credentials at the organization level to enable payment processing. +2. **Create Paid Subscription Plans:** Define subscription plans with the appropriate pricing model for your APIs. +3. **Enable Plans for APIs:** Assign paid subscription plans to specific APIs to make them available for consumers. +4. **Consumer Subscription:** API consumers discover and subscribe to paid plans through the Developer Portal. + +## Analytics and Monetization with Moesif +To provide enterprise-grade observability and usage-based billing, WSO2 API Platform also integrates directly with Moesif, a leading analytics and monetization platform for AI and API products. Instead of building complex data pipelines and billing infrastructure from scratch, you can leverage Moesif to instantly understand how your APIs are being consumed, track user journeys, and automatically enforce monetization rules. Visit [Moesif documentation](https://moesif.com/docs) to explore comprehensive setup guides, SDKs, concepts, and deep-dive tutorials. -This page provides a high-level overview of what you can achieve with Moesif. - -## Core Capabilities +### Core Capabilities Moesif extends your API platform with these primariy capabilities: -### API Analytics and Observability +#### API Analytics and Observability Deeply understand customer API usage to improve your API strategy. * **Usage and Body Analytics:** Track API logs, payloads, and metrics to see exactly which endpoints are heavily used and how they perform. * **Customizable Dashboards:** Build customized views to track funnel metrics like Time to First Hello World, adoption rates, and drop-offs. * **Customer Journey Tracking:** Correlate API traffic with website and portal interactions to observe the end-to-end user experience. -### API Monetization and Metered Billing +#### API Monetization and Metered Billing Effortlessly turn your APIs and AI endpoints into revenue centers. * **Usage-Based Billing:** Set up billing meters based on API calls, LLM token counts, or custom metrics. * **Billing Provider Integrations:** Connect directly to payment gateways like Stripe, Recurly, Chargebee, or Zuora to automate invoicing and payments. * **Product Catalogs:** Define pricing plans, tiers, and prepaid credits without writing custom billing code. -### API Governance +#### API Governance Enforce contract terms and prevent API abuse dynamically. * **Quotas and Limits:** Automatically enforce subscription quotas and block traffic when customers exceed limits. * **Prepaid Credits:** Manage trial accounts, freemium tiers, and prepaid credit balances. -### Proactive Monitoring and Alerting +#### Proactive Monitoring and Alerting Guarantee customer success and reduce mean time to resolution (MTTR). * **Behavioral Alerts:** Get notified when a key customer's API usage drops suddenly, indicating a potential churn risk or integration issue. * **Error Tracking:** Dig into API traffic, headers, and traces to quickly resolve customer implementation issues. * **Automated Emails:** Automatically guide developers at scale by sending behavioral emails—for example, when they near their quota limit or successfully make their first API call. -### Developer Experience +#### Developer Experience Share insights directly with your API consumers. Use Embedded Metrics to expose usage metrics and quota dashboards directly inside Developer Portal so users can track their consumption in real time. ## Next Steps - +* [Get started with API Platform API monetization](./api-monetization/getting-started.md) * [Visit Moesif documentation](https://www.moesif.com/docs/). -* [Get familiar with Metered Billing](https://www.moesif.com/docs/metered-billing/). -* [Learn to set up real-time Dashboards](https://www.moesif.com/docs/api-dashboards/) to build custom analytics views for your API traffic. \ No newline at end of file +* [Get familiar with Moesif Metered Billing](https://www.moesif.com/docs/metered-billing/). +* [Learn to set up real-time Dashboards in Moesif](https://www.moesif.com/docs/api-dashboards/) to build custom analytics views for your API traffic. \ No newline at end of file diff --git a/en/docs/cloud/api-monetization/overview.md b/en/docs/cloud/api-monetization/overview.md deleted file mode 100644 index 90cc6154..00000000 --- a/en/docs/cloud/api-monetization/overview.md +++ /dev/null @@ -1,23 +0,0 @@ -# API Monetization - -## What is API Monetization? - -API monetization allows organizations to generate revenue from their APIs by offering paid subscription plans to API consumers. By integrating with Stripe as a payment provider, API Platform enables organizations to define flexible pricing models and manage billing for API usage directly from the console. - -## API Monetization Overview - -With API monetization in API Platform, organizations can seamlessly monetize their APIs by creating paid subscription plans with various pricing models. This allows you to: - -- **Integrate with Stripe:** Connect your Stripe account to API Platform to handle payments and billing securely. -- **Define Flexible Pricing Models:** Create subscription plans using pricing models such as Free, Flat, Unit, Volume, and Graduated to match different business needs. -- **Enable Monetization Per API:** Choose which APIs offer paid plans, giving you granular control over your monetization strategy. -- **Manage Subscriptions:** API consumers can discover and subscribe to paid plans via the Developer Portal, streamlining the purchasing experience. - -By monetizing APIs through API Platform, organizations gain a streamlined way to offer tiered access, manage billing, and grow API-driven revenue. - -## Getting Started - -1. **Configure Stripe:** Add your Stripe credentials at the organization level to enable payment processing. -2. **Create Paid Subscription Plans:** Define subscription plans with the appropriate pricing model for your APIs. -3. **Enable Plans for APIs:** Assign paid subscription plans to specific APIs to make them available for consumers. -4. **Consumer Subscription:** API consumers discover and subscribe to paid plans through the Developer Portal. diff --git a/en/mkdocs.yml b/en/mkdocs.yml index ad163e45..cbcd22ef 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -291,14 +291,6 @@ nav: - Compliance Dashboard: cloud/monitoring-and-insights/compliance.md - Integrate API Platform with Moesif: cloud/monitoring-and-insights/integrate-bijira-with-moesif.md - API Platform Status Page: cloud/monitoring-and-insights/status-page.md - - API Monetization: - - Overview: cloud/api-monetization/overview.md - - Monetizing APIs: - - Getting Started: cloud/api-monetization/getting-started.md - - Manage Paid Subscription Plans: cloud/api-monetization/manage-paid-subscription-plans.md - - Consume Monetized APIs: - - Subscribe to a Paid Plan: cloud/api-monetization/subscribe-to-paid-plan.md - - View Billing and Usage: cloud/api-monetization/view-billing-and-usage.md - Administer: - Create API Subscription Plans: cloud/administer/settings/create-api-subscription-plans.md - Configure a Custom Domain for Your Organization: cloud/administer/settings/configure-a-custom-domain-for-your-organization.md @@ -441,6 +433,13 @@ nav: - Analytics Header Filter: ai-gateway/analytics/analytics-header-filter.md - Analytics & Monetization: - Overview: analytics-and-monetization/overview.md + - API Monetization: + - Monetizing APIs: + - Getting Started: analytics-and-monetization/api-monetization/getting-started.md + - Manage Paid Subscription Plans: analytics-and-monetization/api-monetization/manage-paid-subscription-plans.md + - Consume Monetized APIs: + - Subscribe to a Paid Plan: analytics-and-monetization/api-monetization/subscribe-to-paid-plan.md + - View Billing and Usage: analytics-and-monetization/api-monetization/view-billing-and-usage.md - Policy Hub: - Overview: policy-hub/overview.md - Guides: @@ -584,11 +583,11 @@ plugins: ai-workspace/policies/rate-limit/token-based-rate-limit.md: cloud/ai-workspace/policies/rate-limit/token-based-rate-limit.md ai-workspace/policies/writing-an-ai-policy.md: cloud/ai-workspace/policies/writing-an-ai-policy.md # API Monetization - api-monetization/getting-started.md: cloud/api-monetization/getting-started.md - api-monetization/manage-paid-subscription-plans.md: cloud/api-monetization/manage-paid-subscription-plans.md - api-monetization/overview.md: cloud/api-monetization/overview.md - api-monetization/subscribe-to-paid-plan.md: cloud/api-monetization/subscribe-to-paid-plan.md - api-monetization/view-billing-and-usage.md: cloud/api-monetization/view-billing-and-usage.md + api-monetization/getting-started.md: analytics-and-monetization/api-monetization/getting-started.md + api-monetization/manage-paid-subscription-plans.md: analytics-and-monetization/api-monetization/manage-paid-subscription-plans.md + api-monetization/overview.md: analytics-and-monetization/api-monetization/overview.md + api-monetization/subscribe-to-paid-plan.md: analytics-and-monetization/api-monetization/subscribe-to-paid-plan.md + api-monetization/view-billing-and-usage.md: analytics-and-monetization/api-monetization/view-billing-and-usage.md # API Platform Gateway api-platform-gateway/analytics.md: cloud/api-platform-gateway/analytics.md api-platform-gateway/apply-custom-policies-to-apis.md: cloud/api-platform-gateway/apply-custom-policies-to-apis.md