Skip to main content
All CollectionsBuildAPI Plans
Working with APIs on a Plan
Working with APIs on a Plan

How to work with your APIs by adding and removing them from an API Product Plan

Updated over a year ago

An API Product may have multiple Plans. Plans are a very powerful way to organize your product offerings so that they make sense to the consumer.

By adding or removing APIs from a Plan, you can create bundles or packages of APIs tailored for the API consumer's use. Each plan you create should solve a particular use case that your target customer is facing. You can have a different set of APIs in each plan.

Select an API Gateway

An API Gateway must be connected for Apiable to read the list of APIs.

To connect a new API Gateway, navigate to:

Portal Management > Integrations > + Add Gateway.

Note: You may need additional permissions to add a new API gateway.

The "Select an API Gateway" drop-down will show all the API gateways currently connected to your environment. By default, Apiable offers the following example API gateways:

  • Apiable Amazon Gateway

  • Apiable Kong Gateway

You may use these to test adding and removing APIs to a plan.

Choosing alternate gateways in different plans attached to the same product is also possible. An everyday use case is a plan that connects the consumer to a Sandbox environment vs a plan connected to the production server.

Selecting APIs

Once selected, Apiable will retrieve a complete list of APIs found on this gateway. Select the APIs that should be in this plan.

Once a plan has been saved and has active subscribers, it is no longer possible to remove an API from this plan. However, APIs may still be added to it.

If you need to remove an API, consider duplicating the plan and asking your API consumers to migrate.

Note: If an API has a red check next to it, a previously available API can no longer be found on the API gateway. Please contact your gateway administrator to ask if the API has changed.

Did this answer your question?