Manage Account Plans

As an administrator, you can add, edit, and delete account plans. All organizations need an account plan. Account plans control which APIs can be accessed by organization developers and applications. Publishers can also design account plans that constrain an organization API usage.
This section describes the logic behind Account Plans and how to configure them.
In this article:
About Account Plans
As an API Portal administrator, you can add, edit, and delete Account Plans. The following implementation details apply:
  • All organizations need an Account Plan. An Account Plan can consist more than one organizations, but each organization can only be assigned to one Account Plan.
  • You can define a quota and a rate limit for your 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.
  • An Account Plan cannot exceed its quota and rate limit regardless of how the hits are divided among an organization's applications and APIs.
The visibility of APIs is no longer managed on the Account plan level. Administrators manage the visibility of APIs on an Organization level. For more information, see Create and Set Permissions for APIs.
When a user self-registers for the CA API Developer Portal, the Org Admin role is assigned 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 Portal API, see Portal API (PAPI).
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 Your Account Plans
The
Account Plans
page shows the quota and the rate limit for each Account Plan, and the number of organizations that use each plan.
  1. Select the
    Services
    icon.
  2. Select
    Publish
    ,
    Account Plans
    . The
    Account Plans
    page opens.
Add Account Plans to the CA API Developer Portal
  1. From the
    Account Plans
    page, select
    Add Account Plan
    . An
    Add Account Plan
    page opens.
  2. On the
    Details
    tab, 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. (Optional) On the Available
    Private APIs
    tab, add Private APIs to the Account Plan to make them visible to all organizations under the Account Plan.
  4. Select
    Create
    .
Edit Account Plans
  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.
  3. Select
    Save
    .
Delete Account Plans
If you did not assign the Account Plan to any organizations, you can delete the plan. You cannot delete the default Account Plan.
  1. From the
    Account Plans
    page, select
    Edit
    from the drop-down list in the
    Actions
    column.
  2. Select
    Delete
    .
Next step: Manage API Plans