Add a Plan
A plan is the commercial representation of a service. In a plan, you associate APIs to the service, and define the pricing and limits of consumption.
Last updated
A plan is the commercial representation of a service. In a plan, you associate APIs to the service, and define the pricing and limits of consumption.
Last updated
Having created a Service, click on Continue to Step 2: Plans. On the new page, you will find the Add a Plan button. Here you can add one or multiple plans for your Service.
Once you click on Add a Plan, you will be brought to a new page with several tabs. Please fill out the relevant information in each tab.
Define your plan's name, service type, and approval process.
When defining your Plan Name, please note that the plan name cannot be changed after the plan has been published.
Mark the Set as a Demo checkbox if appropriate. A demo plan is a free plan to which users can subscribe so that they can try out your service (for example, for testing and integration purposes). Demo plans are highlighted in the marketplace. Setting a rate limit under Limits and Pricing is mandatory for Demo plans.
If your service will be exclusively consumed via API calls, select the Service type API.
For independent SaaS offerings, which will be consumed differently by your customers (e.g. via a combination of web application, mobile application, e-mail, etc.), select the Service type Application.
You can enable Subscription Approval if you would like tighter control over your subscribers. This is Off by default, allowing everyone to subscribe to your publicly available plans. You will find the list of your subscribers and their contact details in the Subscribers section, irrespective of this setting.
Application plans have no assigned APIs and limited pricing options.
The cursive sections below only apply to API plans.
Decide whether your plan is public or restricted.
Selected Workspaces - can be offered individually to other Workspaces, otherwise hidden from the catalog. Your own workspace is included by default. If you don't add any further workspaces, the Plan will be private to your own workspace.
All Workspaces - available for anyone to consume, publicly listed in the marketplace catalog.
Here you can select one or more APIs from your API Collection. The Limits and Pricing section will parse the assigned APIs in order to provide granular configuration per endpoint and transactions.
A transaction is a unit of measurement that can be used for your offered services' billing purposes. You can create multiple transactions for one service and refer to them while configuring your pricing plan.
Click Add Transaction.
Specify a Transaction Name.
Select the Transaction Recognition Type (Single Request or Response Header).
Single Request will count any request to a certain endpoint, followed by a specified server response (e.g. 200-203 as successful requests).
Response Headers allow you to configure multiple endpoints. An additional ID needs to be added as a header. A response from any of the endpoints including this additional header value will be counted as a transaction.
Select the appropriate Endpoint(s).
For Single Request, define the HTTP Response Codes; for Response Header, define the Header Name and Value.
Click Add Transaction to finish adding the transaction.
Limits can be defined for your pricing plan. E.g. "100 Requests per month."
Click Add Limit.
Under Amount, specify the maximum amount for this limit
Under Unit, Requests are specified as the unit of measurement for the limit
Under Period, specify the time interval for the limit.
Define prices, such as an overall periodical fee, or a fee for each unit or for each transaction.
Price per period:
Under Amount, define the price that should be billed per period.
Under Period, select the duration of one period.
Price per unit:
Under Amount, define the price for one unit.
Under Unit, Requests are specified as the unit of measurement.
Under Threshold, you can optionally define a starting point for tiered pricing. (e.g. a threshold of 50 means that the pricing will be applied from the 50th request onwards)
Price per transaction:
Under Amount, define the price for one transaction.
Under Transaction, select the transaction for which this price should be billed.
Under Threshold, you can optionally define a starting point for tiered pricing. (e.g. a threshold of 50 means that the pricing will be applied from the 50th transaction onwards)
Upload a contract that describes the terms and conditions of the service you are providing.
When you completed the service description and the setup of the plan(s), continue with publishing: Preview & Publish your Services and Plans
