Creating a Product Plan

Actor: Portal Administrator

Procedure

  1. Log in to the API Manager Portal as a partner administrator.
  2. Click the Products tab and select an existing product from the list of products. The product details page appears.
  3. Click the Plans tab, and then click Add Plan.

    The create new plan interface appears.

  4. Specify the following information to set up the plan:
    • Plan Name

      Enter a name for the plan.

    • Level

      Specifies the ordering of the plan in the list of product plans, where the plans are placed in the increasing order of the level. Choose a level from the drop-down menu: Custom, Level 1, Level 2, Level 3, Level 4, and Level 5.

      Note: After Plan name and Level are created, custom plans are not displayed on the UI. However, the custom plans can be selected when creating a subscription.
    • Subscriptions

      After you create the plan, you can add a subscription to it.

    • Price or Keyword

      Enter a price or a keyword to be highlighted for the plan.

    • Contact

      Contact for the plan.

    • Product

      Displays the product name for which the plan is to be created.

    • Auto Subscribed

      Select Yes to create a plan that can be auto-provisioned.

    • Plan Details

      Enter the details of the plan.

    • Rate Limit

      Specifies the number of requests to the API allowed per second. Prior to release 2.2.0, entering a rate limit was mandatory. Now, this field is optional.

    • Quota Limit

      Specifies the number of requests to the API allowed per day for products using the plan.

      Count Failure is a new check box to the right of the Quota Limit which specifies the number of failure calls. To activate this feature, select the checkbox.

    • Description

      Enter a description for the plan.

  5. Click Save to save the plan, and add it to the selected product.

    The newly created plan appears on the product page for the product.

    After creating a product and adding a plan, you must associate an environment with the product. See the section "Associating a Basepath with a Product" for more details.