Managing Plan Subscriptions
Applications subscribe to plans to be able to send requests to the APIs in the plan.
Understanding 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.
Viewing Plan Subscriptions
Subscribing a Plan to an Application
You can create a subscription from an application to a plan from the Plans List page.
- On the Plans List page, click the plan to which you want to subscribe an application.
- Click the (Subscriptions) tab.
- Click Subscribe Application.
- Select the application(s) you want to subscribe to the plan.
- Select an 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. See Approving or Rejecting Application Subscriptions to approve subscription requests.
- Suspended: The application is subscribed, but it is in a suspended state. See Resuming a Suspended Application Subscription to activate suspended subscriptions.
- Click Subscribe.
Approving or Rejecting Plan Subscriptions
A Plan Manager can approve or reject 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:
- From the Plans List page, click the application for which a developer has requested for subscription to a plan.
- Click the (Subscriptions) tab.
- Click the Requesting tab.
- Click the name of the application requesting a subscription.
- Click Approve to approve the subscription, Reject to reject the subscription, or Dismiss to dismiss the subscription.
- Optionally specify the reason for your action, and then click Yes to approve or No to reject the subscription.
Suspending Plan Subscriptions
You can temporarily suspend an application’s subscription to a plan. While the subscription is suspended, the requests from the application to the entitled APIs in the plan are rejected.
- On the Plans List page, click the plan for which you want to suspend an applications’s subscription.
- Click the (Subscriptions) tab.
- Click the Subscribed tab on the Subscriptions page.
- Click the application for which you want to suspend the subscription.
- Click Suspend.
- Optionally specify the reason for suspending the subscription and then click Yes.
Resuming a Suspended Plan Subscription
You can resume an application’s suspended subscription to a plan.
- On the Plans List page, click the plan in which you want to resume an application’s subscription.
- Click the (Subscriptions) tab.
- Click the Suspended tab.
- Click the application for which you want to resume the subscription.
- Click Resume.
- Optionally, specify the reason for resuming the subscription and then click Yes.
Unsuscribing a Plan
You can unsubscribe an application from a plan to remove its access to the APIs entitled by the plan.
When an application unsubscribes 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.
- On the Plans List page, click the plan from which you want to unsubscribe an application.
- Click the (Subscriptions) tab.
- Click the Subscribed tab. If the subscription is in the suspended state, click the Suspended tab.
- Click the application you want to unsubscribe from the plan.
- Click Unsubscribe.
- Click Yes in the banner to confirm.