Enable Monetization

The Apigee Developer Portal Kickstart provides the option to set up and customize Monetization features during site installation. If your Apigee Edge organization has Monetization enabled, the installer prompts you to enable Monetization in your portal. If your Apigee Edge organization does not have Monetization enabled at the time of Kickstart installation, you can install and enable the Monetization module later.

Set up Monetization during Apigee Kickstart Site Installation (recommended)

Follow the Installation instructions to install the Apigee Kickstart profile and set up your web server.

If you enter connection details for a Monetization-enabled Apigee org and you are using the latest version of the apigee/devportal-kickstart-project in your main composer file, the installer prompts you to:

1. Enable Monetization.
2. Enable Add Credit module (visible after checking Enable Monetization) or proceed to Step 3. If you check Enable Add Credit module, you are prompted to:
   • Configure the Drupal Commerce Store name, email, and address
   • Create an "Add Credit" product for supported currencies
   • Create a test payment gateway
3. Complete the installation.

If you check Enable Monetization, the installer:

• Configures the connection to Apigee Edge
• Installs the Apigee Monetization module with the Kickstart custom theme, including:
  • A Pricing and Plans page to display available rate plans
  • Rate Plan detail pages for each rate plan
  • A Balance and Plans tab, for viewing and managing prepaid balances, purchased plans, and billing details

If you also check Enable Add Credit module, the installer:

• Installs the Apigee Monetization Add Credit (submodule)
• Installs the Drupal Commerce module and its dependencies
• Creates the "Add credit" Commerce entities preconfigured to work with the Apigee Monetization Add Credit module and the Apigee Kickstart custom theme.
• Creates Drupal Commerce products for each supported currency selected during installation
• Configures the Drupal Commerce Store
• Customizes Drupal Commerce Views for a Kickstart-themed checkout experience.

Once the installation completes, perform these steps to complete your Monetization set up:

1. Review your products and settings, and adjust as needed.
2. Set up a payment gateway.
3. Review the Apigee Monetization documentation for additional options and features, including enabling recurring payments for prepaid developers.

Set up Monetization for Apigee Kickstart via Module Installation

If you have previously installed an Apigee Kickstart site, you can still set up Monetization for use with a Monetization-enabled Apigee org. See Install the Apigee Monetization module for details.

Note: If you would like to use the "Add Credit" functionality to enable developers to add credit to their balance through your Kickstart portal, follow the steps outlined in Enable the Apigee Monetization Add Credit Module. The “Add Credit” products must be manually configured in a module installation of Monetization.