Understand how app developers interact with Apigee Monetization

Last updated on
26 October 2021

The following sections describe how app developers interact with Apigee Monetization. The Apigee Monetization module is dependent on the Apigee Edge module. App developers can perform the tasks described in Understand how app developers interact with the Apigee Edge module in addition to those tasks described in this topic.  Tips for configuring and customizing the experience are provided.

Explore the Apigee monetization features in the developer portal

When you install the Apigee Monetization module, the Apigee monetization features are available in the developer portal.  The available monetization tabs and UI layout will differ depending on your portal's connection to a monetized org in Apigee Edge, hybrid, or Apigee X.

Monetization features for Apigee Edge-connected portals

The figure below shows the "My account" view of monetization in developer portals connected to Apigee Edge orgs:

Explore monetization

As highlighted in the previous figure, the Pricing & Plans tab enables app developers to view and purchase rate plans. App developers can then manage their purchased rate plans, prepaid balances, and payment methods from the My account page.

Note: The Prepaid Balance tab on the My Accounts page displays only if you support adding credit to a prepaid balance.

The following sections describe the app developer interactions in more detail:

Monetization features for Apigee X and hybrid-connected portals

The figure below shows the "My account" view of monetization in developer portals connected to Apigee X or hybrid orgs:

As highlighted in the previous figure, the Buy API tab enables app developers to view and purchase rate plans. App developers can then manage their purchased subscriptions from the My account page.

The following sections describe the app developer interactions in more detail:

Manage teams of app developers (Apigee Edge-connected portals)

The Apigee Monetization Teams module lets you manage permissions for groups of app developers in Apigee Edge-connected portals.  Before getting started, you will need to install and configure the module, as described in Configure team management.

Once the module is installed, you can create teams, add members, and manage apps.

To manage teams:

  1. Select Teams in the top nav bar.
  2. Click Add team  to add a new team.
  3. Complete the form.
    Note:  To configure the fields that are displayed in the team registration form, see Configure team management.
  4. Click Add team.
  5. Click the name of the team to view details.
  6. Click the Members tab to add or remove team members.
  7. Click the Team Apps tab to register team apps.
  8. Click the Prepaid balance tab to manage prepaid balances.
  9. Click the Purchased plans tab to manage purchased rate plans.
  10. Click the Billing details tab to manage billing information.
  11. Click the Edit or Delete tab to edit the team name or delete the team, respectively.

View and purchase rate plans

When registering an app, app developers will be able to use the following APIs only:

  • APIs available via a purchased rate plan
  • APIs available via a freemium plan
  • APIs that are public and do not require that you purchase a rate plan

Notes:

  • Before purchasing a rate plan, app developers will be prompted to view and accept the terms and conditions if they have not done so already. To add terms and conditions, see Managing terms and conditions.
  • You can configure the appearance of rate plans in the developer portal, as described in Configure rate plan settings

Rate plans and pricing for Apigee Edge-connected portals

To view rate plans and pricing:

  1. Sign in to the developer portal.
  2. Click Pricing & plans for Apigee Edge-connected portals or Buy APIs for Apigee X or hybrid-connected portals.
  3. Click the row of the API package to view the available rate plans.
  4. To purchase a rate plan:
    1. Click Purchase plan.
      The purchase rate plan page displays.
    2. Enter a Start Date.
    3. Click Purchase Plan.
    4. If prompted for billing information, enter it and click Save.
      Available for on-site payment gateways only. 

Rate plans and pricing for Apigee X and hybrid-connected portals

To view rate plans and pricing:

  1. Sign in to the developer portal.
  2. Click Buy APIs.
  3. Click the API package to view the available rate plans.
  4. To purchase a rate plan, click Purchase plan.

Manage purchased rate plans

View and manage the rate plans that you have purchased.

Managed purchased plans for Apigee Edge-connected portals

Purchased plans

To manage purchased plans:

  1. Sign in to the developer portal.
  2. To manage purchased plans:
    • For your account, click My account.
    • For a team, click Teams, then click the name of the team in the list to display the team details. 
  3. Click the Purchased plans tab.
  4. Click the name of the plan to view more details.
  5. Click Cancel to cancel the rate plan, if desired.

Manage purchased products for Apigee X and hybrid-connected portals

To manage purchased products:

  1. Sign in to the developer portal.
  2. To manage purchased products:
    • For your account, click My account.
    • For a team, click Teams, then click the name of the team in the list to display the team details. 
  3. Click the Profile home tab to expand the menu options.
  4. Click the Purchased products tab.
  5. Click View Rate Plan from the Actions dropdown to view more details.
  6. Click Cancel from the Actions dropdown to cancel the rate plan, if desired.

Manage prepaid balances

Developers with a Prepaid billing type can view and manage their balance based on currency.

For Apigee Edge-connected portals, developers an manage the following details using the Prepaid tab: including:

  • Balance brought forward
  • Total credit added to the account
  • Current usage
  • Tax incurred
  • Current balance for this billing period

For Apigee X and hybrid-connected portals, developers can use the Prepaid tab to view current balances.

Note: To enable app developers to add credit to a prepaid balance, see Support adding credit to a prepaid balance.

prepaid balance

To manage prepaid balances:

  1. Sign in to the developer portal.
  2. To manage purchased plans:
    • For your account, click My account.
    • For a team (Apigee Edge-connected portals only), click Teams, then click the name of the team in the list to display the team details.
  3. Click the Prepaid balance tab.
  4. Review the current prepaid balance.
  5. Apigee Edge-connected portals can download a previous statement as a comma-separated values (CSV) file from this tab.

Manage billing information

Manage billing information, including billing details and payment methods.

Note: To configure the payment gateways, see Manage payment gateways.

To manage billing details for Apigee Edge-connected portals:

  1. Sign in to the developer portal.
  2. To manage billing details:
    • For your account, click My account.
    • For a team (Apigee Edge-connected portals only), click Teams, then click the name of the team in the list to display the team details.
  3. Click the Billing Details tab.
  4. Apigee Edge-connected portals can also edit the legal company name from this tab.

Manage payment methods for Apigee Edge-connected portals

To view and manage payment methods for on-site payment gateways used for purchasing rate plans:

  1. Sign in to the developer portal.
  2. Click My account.
  3. Click the Payment methods tab.

Note: Not applicable to off-site payment gateways.

Manage payment methods for Apigee X and hybrid-connected portals

To view and manage payment methods for on-site payment gateways used for purchasing API products:

  1. Sign in to the developer portal.
  2. Click My account.
  3. Click the Profile home tab to expand the menu options.
  4. Click the Payment methods tab.

Note: Not applicable to off-site payment gateways.  

Help improve this page

Page status: No known problems

You can: