When defining throttling tiers using the admin dashboard UI there exists Admin Portal, you have the option of specifying to specify a given tiers billing plan for tiers. Here a A tier is defined as either a Free free or Paid paid tier. Depending on which the tiers are available for a given API to subscribe to , the API Monetization Catergory label of Free, Paid or Freemium will be displayed following API monetization categories are displayed as labels in the store.
This functionality is not enabled by default, to enable it the following configuration changes need to be done.
...
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:
- Log in to the API Manager's Management Console and select Browse under Resources menu.Select the file: .
- Navigate to the Main menu, and click Browse, which is under the Resources tab.
- Enter the following path in the Location: text-box and click Go.
/_system/config/apimgt/applicationdata/tenant-conf.json
- In the Contents panel, click the Edit as text link and the
tenant-conf.jsonfile opens. - To enable Monetization monetization categories for APIs, set "the
EnableMonetization" property to true. By default, to disable set it to false. This configuration is set to false by default.To define if the Unlimited tier is paid set "IsUnlimitedTierPaid" to true, else if the Unlimited tier is free set it to false. This configuration is set to false by default. - Define the subscription tiers as required.
For example if you are working with the unlimited tier,- To define the unlimited tier as paid, set the
IsUnlimitedTierPaidproperty to true. - To define the unlimited tier as free, set the
IsUnlimitedTierPaidproperty 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.
- To define the unlimited tier as paid, set the
- After the edits, click click Save Content.
| Tip |
|---|
Note that the above configuration can be done independently on a per a tenant basis |
...
. |
When the above "EnableMonetization" config property is set to true for the respective tenant, the API Monetization Category label will be monetization category labels are displayed in the tenant api API store.
