Skip to main content
Skip table of contents

Setting up Monetization

After every step illustrated below, ensure clicking the Save icon; else the changes won't be saved.

Creating an API Project

Refer the Manage API Projects section to create an API Project.

Click the icon beside the respective project to open it.

Creating a Monetization Limit Check policy

Click the Policy Configurations icon on the left margin of the API Projects screen and perform the following actions:

  1. Create a Monetization Limit Check policy.

    Refer to the Adding a Policy the Monetization Limit Check policy section to understand the policy configuration.

  2. Click the environment in which configuration needs to be set, ensure that the Enabled option is selected, and click the Save icon to save the policy.

Adding the policy to the Project Level Policies repository

  1. Click the Project Level Policies icon and go to the Proxy Response tab.
  2. Click the Add button and select the Monetization policy from the dialog box
  3. Click OK to add the Monetization policy.
  4. Click the Save icon to apply the changes.

Creating a product and adding to the Monetization Project

Go to the Applications page and perform the following in the Products section.

    1. Select the server group and add a new API Product

    2. Provide the values as per requirement and click the Save icon.

      After saving, two panels (API Projects and Organizations) appear below the existing section.

    3. Click the Edit icon In the API Projects panel, select the project created at the beginning of this section from the Available Projects panel, and click the OK icon.
    4. Click the Save icon to save the product configuration.

Configuring Monetization

Click the Monetization tab under the Product Configuration section and perform the actions in the section below.

Adding a Transaction Recording Policy

  1. Expand the Transaction Recording Policy section and click the Add button.
  2. Add the parameters to be checked to the context variables and click OK.
  3. Click the Add button above the Header panel. To configure the success criteria, provide the value of the Transaction Status parameter. Select Checking Criteria as "EQUALS" or "MATCHING" depending on the requirement.

  4. In the Custom attributes panel, add the attributes that need to be monitored for invoice generation.

    If some attribute has to be added to the rating parameter while using custom variables, the attribute mentioned has to be added to this panel.

  5. Click the Save icon to save the configuration

Adding Product rate plans

Expand the Rate Plan section, click the Add icon and add a Rate Plan ID. Click OK.

Standard Rate Plan

In the Standard rate plan, only the provider and the user are involved and hence the developer does not get revenue.

Only the Ratecard revenue model is valid for the Standard rate plan.

  1. Under the Rate plan Configuration section, provide a unique name, and click the Rate plan scope drop-down and select "Standard".
  2. In the Plan Details tab, select the options below:
    1. Revenue Model: Ratecard.

    2. Rating Parameter: Choose from the options "Volume" and "Custom Variable". 

      If CUSTOM VARIABLE is selected, please specify the variable/parameter to be used for charging the user. For CUSTOM VARIABLE, the parameter specified has to be added to the custom attributes section in the transaction recording policy.

    3. Metering Type: Choose from the options UNIT, STAIR STEP, and VOLUME, and specify the "Duration", "Renewal Term" and the "Payment Due" details.
    4. Freemium Package: Specify if it is applicable; else select "No".
    5. Under the Rate Plan Rates section, click the Add icon to add the Rate for transactions depending on the "Metering Type".
  3. In the Fees tab, enter all other fees details.
  4. Click the Save icon to save the product.
Developer Rate Plan

In the Standard rate plan, the developer, provider, and user are involved and thereby the developer gets a share from the provider for the APIs developed .

Under the Rate plan Configuration section, provide a unique name, and click the Rate plan scope drop-down and select "Developer".

In the Plan Details tab, choose the Rating Parameter from the options "Volume" and "Custom Variable". 

If CUSTOM VARIABLE is selected, please specify the variable/parameter to be used for charging the user. For CUSTOM VARIABLE, the parameter specified has to be added to the custom attributes section in the transaction recording policy.

Unlike the Standard RAte plan scope, all Revenue Models listed below are applicable for the Developer rate plan:

  • Ratecard
  • Revshare
  • Revshare Ratecard

Each of these revenue models is explained in the following sections:

Ratecard Revenue Model

In the Plan Details tab, select the below options for the Ratecard revenue model:

    1. Metering Type: Choose from the options UNIT, STAIR STEP, and VOLUME, and specify the "Duration", "Renewal Term" and the "Payment Due" details.
    2. Freemium Package: Specify if it is applicable; else select "No".
    3. Under the Rate Plan Rates section, click the Add icon to add the transaction rate depending on the "Metering Type".

Creating Client

  1. Click the Clients icon on the left pane in the Applications page, click the Add button, and provide a valid email ID.
  2. Specify configuration details and click the Save icon to save the client details.

Creating Client Subscriptions with the Monetization product

Click the Client Subscriptions icon present below the Clients icon and perform the following actions:

  1. create a new client subscription by choosing the client added above.
  2. Provide the subscription details and click Edit button in the Subscribed Products property.
  3. Use the "Subscribed Products" option to select the product and the rate plans associated with the product.
  4. Click the Save icon to save the Client Subscription

1. Subscribed Products in client-subscription cannot be changed after adding the product and setting the rate plans. Client subscriptions should not be edited if it is already being used.

2. Individual rate plans should not be changed after publishing the rate plan. Only the end date of a published rate plan can be changed (only if it was previously left as null).

Verifying Monetization Setup

To verify whether monetization is enabled, the rate plan ID is set correctly and the limit was successfully executed, perform the following actions in the Analytics page.

Go to the Advanced tab in the Analytics screen. In the Group by drop-down, select the options below as required:

  • MONETIZATION_ENABLED: To verify whether Monetization is enabled or not.
  • MONETIZATION_SUCCESS: To verify whether the Monetization Limit Check is applied correctly or not.
  • API_APPLICATION_RATEPLAN_ID: To verify whether the rate plan ID is set correctly or not.

Select other filtering options such as Chart Type, Server Group Date, etc. as per requirement.

The green color in the graph represents successful completion of the above tasks and the blue represents failure.

Click Refresh icon after changing the Group By options above to retrieve the respective graphs.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close