This documentation is for WSO2 API Manager 1.10.0 View documentation for the latest release.
Page Comparison - Configuring API Monetization Category Labels (v.7 vs v.8) - API Manager 1.10.0 - WSO2 Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added how to define paid and free subscription tiers

When defining throttling tiers using the Admin DashboardPortal, you have the option to specify a given billing plan for tiers. A tier is defined as either a free or paid tier. Depending on the tiers available for a given API, the following API monetization categories (Free, Paid or Freemium) are displayed as labels in the storeare displayed as labels in the store.

  • Free - If all subscription tiers are defined as Free, the API uses the Free billing plan and the API is labeled as Free in the Store.

  • Paid - If all subscription tiers are defined as Paid, the API uses the Commercial billing plan and the API is labeled as Paid in the Store.

  • Freemium - If the API has a combination of Free and Paid subscription tiers, the API uses the Freemium billing plan and the API is labeled as Freemium in the Store.

Follow the configuration steps below to enable API monetization category labels:

  1. Log in to the API Manager's Management Console. 
  2. Navigate to the Main menu, and click Browse, which is under the Resources tab.
  3. Enter the following path in the Location: text-box and click Go.
    /_system/config/apimgt/applicationdata/tenant-conf.json
  4. In the Contents panel, click the Edit as text link and the tenant-conf.json file opens.
  5. To enable monetization categories for APIs, set the EnableMonetization property to true. By default, it is set to false.To define if
  6. Define the subscription tiers as required.
    For example if you are working with the unlimited tier is ,
    • To define the unlimited tier as paid, set
    the
    • the IsUnlimitedTierPaid property to true.
    Alternatively, if the unlimited tier is
    •  
    • To define the unlimited tier as free, set
    it
    • the IsUnlimitedTierPaid property to false. 
    Tip

    As Freemium APIs has a combination of paid and free subscription tiers, the configuration involved in defining the subscription tiers will be the same as above. However, Freemium APIs need to have a minimum of one subscription defined as paid and free.

  7. After the edits, click Save Content.

...