Manage Plan Subscriptions

Applications subscribe to plans to be able to send requests to the APIs in the plan.

Topics:

• Understand Plan Subscriptions

• View Plan Subscriptions

• Subscribe a Plan to an Application

• Approve or Reject Plan Subscriptions

• Suspend Plan Subscriptions

• Resume a Suspended Plan Subscription

• Unsubscribe a Plan

Understand Plan Subscriptions

Subscriptions represent the relationship between an application and a plan.

To invoke an API that is entitled to plans, an application must be subscribed to a plan entitling that API. An application cannot subscribe to different plans that have entitlements to the same API.

When an application is subscribed to a plan with multiple API entitlements, it has access to all the APIs in the plan.

View Plan Subscriptions

While viewing subscriptions, you can subscribe an application to a plan, or approve, reject, suspend, or reactivate application subscriptions to plans.

To view the subscriptions to a plan:

1. From the Plans List page, click the plan for which you want to view subscriptions.
2. Click the (Subscriptions) tab.
3. Click an application in the list to expand the item and view application details. Click the heading to collapse the item again.

Subscribe a Plan to an Application

You can create a subscription from an application to a plan from the Plans List page.

You cannot subscribe an application to a plan if the application is already subscribed to a different plan that provides entitlements to the same API or APIs.

To subscribe an application to a plan:

1. On the Plans List page, click the plan to which you want to subscribe an application.
2. Click the (Subscriptions) tab.
3. Click Subscribe Application.
4. Select the application(s) you want to subscribe to the plan.
5. Select the initial subscription state.
   • Subscribed: The application is subscribed to the plan.
   • Requesting Subscription: The application is subscribed, but the subscription must be approved by an API Manager.
   • Suspended: The application is subscribed, but it is in a suspended state.
6. Click Subscribe.

Approve or Reject Plan Subscriptions

A Plan Manager approves or rejects a developer’s request to subscribe their application to a plan to get access to APIs entitled by the plan.

Approving the subscription allows an application to send requests to APIs that are entitled by the plan. Until the subscription is approved, or if the subscription is rejected, requests to these APIs are rejected.

To approve or reject an application’s subscription to a plan:

1. From the Plans List page, click the application for which a developer has requested for subscription to a plan.
2. Click the (Subscriptions) tab.
3. Click the Requesting tab.
4. Click the name of the application requesting a subscription.
5. Click Approve to approve the subscription, Reject to reject the subscription, or Dismiss to dismiss the subscription.
6. Optionally specify the reason for your action, and then click Yes to approve or No to reject the subscription.

Suspend Plan Subscriptions

You can temporarily suspend a subscription of an application to a plan. While the subscription is suspended, the requests from the application to the entitled APIs in the plan are rejected.

To suspend a subscription of an application to a plan:

1. On the Plans List page, click the plan for which you want to suspend the subscription.
2. Click the (Subscriptions) tab.
3. Click the Subscribed tab on the Subscriptions page.
4. Click the application for which you want to suspend the subscription.
5. Click Suspend.
6. Optionally specify the reason for suspending the subscription and then click Yes.

Resume a Suspended Plan Subscription

You can resume a suspended subscription of an application to a plan.

To resume a subscription to a plan:

1. On the Plans List page, click the plan in which you want to resume an application’s subscription.
2. Click the (Subscriptions) tab.
3. Click the Suspended tab.
4. Click the application for which you want to resume the subscription.
5. Click Resume.
6. Optionally, specify the reason for resuming the subscription and then click Yes.

Unsubscribe a Plan

You can unsubscribe an application from a plan to remove its access to the APIs entitled by the plan.

When you unsubscribe an application from a plan, Application Developers can no longer see the analytics data for the application in the plan in the API Platform Cloud Service Developer Portal.

To unsubscribe an application from a plan:

1. On the Plans List page, click the plan from which you want to unsubscribe an application.
2. Click the (Subscriptions) tab.
3. Click the Subscribed tab. If the subscription is in the suspended state, click the Suspended tab.
4. Click the application you want to unsubscribe from the plan.
5. Click Unsubscribe.
6. Click Yes in the banner to confirm.