Manage Account Plans

This article describes the logic behind account plans and how to configure them.
Portal Admins can add, edit, and delete account plans. Account plans control which APIs Developers and applications within an organization can access. Publishers can also design account plans that constrain an organization's API usage. The following implementation details apply:
  • All organizations require an account plan. Account plans can consist of more than one organization, but you can assign each organization to only one account plan.
  • You can define a quota and a rate limit for the account plan. The quota specifies the maximum number of hits per day or month, while the rate limit specifies the maximum number of hits per second.
  • Account plans cannot exceed their quota and rate limit regardless of how the hits are divided among an organization's applications and APIs.
Portal Admins manage the visibility of APIs at the organization level.
For more information, see Create and Set Permissions for APIs.
When a user self-registers for
Layer7 API Developer Portal
,
Layer7 API Developer Portal
assigns the Org Admin role and a new organization is created for the user. The
Bronze
default account plan is automatically assigned to this organization.
You can also manage your account plans by way of the Portal API (PAPI) or use this API in your scripts for managing account plans.
For more information about the PAPI, see Portal API (PAPI).
In this article:
Account Plans, Visibility, and Consumption of Private APIs
The following diagram describes the relationship between account plans, private APIs, organizations, and applications:
Often publishers offer multi-tiered account plans. For example, the basic plan could offer a few APIs to get started and lower cumulative limits for all the organizations under it. The premium plan could offer higher (or even unlimited) cumulative limits and access to more APIs.
If you are using API plans as well as account plans, ensure that your account plans have higher quota and rate limit than your API plans.
For more information, see Manage Plans.
Locate an Account Plan
Follow these steps:
  1. Log in to
    Layer7 API Developer Portal
    as a Portal Admin.
  2. From the menu bar, select
    Manage
    ,
    Account Plans
    .
    The
    Account Plans
    page appears, showing the quota and the rate limit for each account plan, and the number of organizations that use each plan.
Add an Account Plan
Follow these steps:
  1. From the
    Account Plans
    page, select
    Add Account Plan
    .
    The
    Add Account Plan
    page opens.
  2. In the
    Details
    section, complete the following items:
    • Enter a unique name and a public description for the account plan.
    • (Optional) Specify the maximum number of hits an organization applications can hit an API
      per day or month
      by selecting the
      Enable quota for this plan
      checkbox, entering the limit, and defining the frequency (day or month).
    • (Optional) Specify the maximum number of hits an organization applications can hit an API
      per second
      by selecting the
      Enable rate limits for this plan
      checkbox, and then entering the limit.
  3. Select
    Create
    .
Edit an Account Plan
Follow these steps:
  1. From the
    Account Plans
    page, select
    Edit
    from the drop-down list in the
    Actions
    column.
    The
    Edit Account Plan
    page opens.
  2. Edit the account plan, and then select
    Save
    .
Delete an Account Plan
You can delete account plans that are not assigned to an organization. You cannot delete the default account plan.
Follow these steps:
  1. From the
    Account Plans
    page, select
    Delete
    from the drop-down list in the
    Actions
    column.
  2. Select
    Ok
    to confirm the account plan deletion.