Migrating application subscriptions to another Plan

By using the Products view within a Catalog in API Manager, you can migrate application subscriptions between Plans, including between different Products. [V5.0.5 or later]The syndication feature in IBM® API Connect means that you can also use the Products view within a Space in a Catalog to migrate application subscriptions.

Before you begin

Your Plan that you are migrating subscriptions from must be a part of a Product that is in one of the following states:
  • Published
  • Deprecated

[V5.0.8 or later]If you are migrating to a paid plan, you must have a credit card account set up with a supported credit card processing vendor.

To complete the Product and Plan management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Manage permission for Products in the Catalog that contains the Plan and its parent Product. If you have View permission for Products in this Catalog, you will have read-only access to the Product management page. For information on configuring Product management permissions for a Catalog, see Creating and configuring Catalogs.

The syndication feature in IBM API Connect means that Products can be contained within a Space in a Catalog. In this case, to complete the Product management tasks that are described in this topic, you must either be the owner of the API provider organization, or be assigned Manage permission for Products in the Space that contains the Product. For information on configuring Product management permissions for a Space, see Managing user access in a Space.

[V5.0.5 or later]Restriction: If the Plan is part of a Product that is contained within a Space in the Catalog, and the migration action is being made at the Space level, the Plan that you are migrating subscriptions from must be located in the same Space as the Plan you are migrating to. If the migration action is being made at the Catalog level, subscriptions can be migrated across Spaces. For more information about the Space feature, see Using syndication in IBM API Connect.

About this task

Application developers initially subscribe their applications to one or more Plans by using the Developer Portal. For more information, see Selecting a Plan in the developer portal. However, by using API Manager, for a chosen Plan you can migrate one or more of its application subscriptions to another Plan, which may be a part of the same Product or a part of a different Product.

Procedure

To migrate Plan subscriptions, complete the following steps:

  1. On the Dashboard of the API Manager UI, select the Catalog that you want to work with.
    The Products tab of the Catalog opens, and all of the Products available in that Catalog are displayed. You can select which states are shown by clicking the filter icon in the Search banner and selecting one or more of the State check boxes.
  2. [V5.0.5 or later] If the Product that you want to work with is contained within a Space, select the required Space by clicking the down arrow next to the Catalog name in the submenu navigation banner.
    The Products tab of the Space opens, and all of the Products available in that Space are displayed. You can select which states are shown by using the filter check boxes in the State bar.
  3. Expand the Product version that is the parent of the Plan you want to migrate subscriptions from.
    The view expands to display all of the APIs and Plans contained in the Product.
  4. Alongside the Plan version whose application subscriptions you want to migrate, click the Migrate subscriptions icon Migrate subscriptions icon.
    The Migrate subscriptions to another plan dialog box opens.
  5. Select the application subscriptions that you want to migrate, and then click Next.
  6. Click the Plan that you want to migrate the application subscriptions to, and then click Migrate.

Results

The new Plan has the migrated subscriptions, and those subscriptions are removed from the Plan from which they were migrated.