Enable the Apigee Monetization Add Credit Module

Enable prepaid app developers to add credit to their balance by installing the Apigee Monetization Add Credit module, setting up a Drupal Commerce store, and defining products to increment the credit balance. The steps are outlined in the following sections:

• Step 1: Install the required Monetization and Commerce modules
• Step 2: Set up a store
• Step 3: Add products to the store
• Step 4: Add an Add Credit button to your prepaid balance page
• Step 5: Configure permissions to view and purchase Add Credit products
• Step 6: Configure wait settings for Add Credit top-ups
• Step 7: Configure notifications for adding credit
• Step 8: Test the shopping experience
• Step 9: Manage orders

Step 1: Install the required Monetization and Commerce modules

Ensure that you have installed the Apigee Monetization module, as described in Install the Apigee Monetization module.

In addition, you will need to install the Drupal Commerce module to provide the dependencies needed for the Apigee Monetization Add Credit module. The Apigee Monetization Add Credit module is included in the Apigee Monetization module, but will need to be installed, as described below.

1. Install the Drupal Commerce module using Composer. Note: Composer must be executed at the root of your Drupal installation. For example:
    

   cd path/to/drupal/root
   composer require drupal/commerce
   

2. Select Extend in the Drupal administration menu.
3. Scroll to the Apigee section of the page.
4. Select Apigee Monetization Add Credit.
5. Click Install.
6. When prompted to install Drupal Commerce modules required as dependencies, click Continue.

Step 2: Set up a store

To enable prepaid developers to add credit to their balance and manage any orders, you need to set up a store. See also Setting up your store in the Drupal Commerce documentation.

To set up a store:

1. If necessary, add a new currency, as described in Adding a currency in the Drupal Commerce documentation.
2. From the Drupal administration menu, select Reports > Requirements report.
3. Click Setup store.
4. Configure the store details, including name, email address for notifications, default currency, and mailing address.
5. Click Submit.

Step 3: Add products to the store

Add products to the store to enable prepaid developers to add credit to their balance using a fixed or custom value. See also Products in the Drupal Commerce documentation.

To add and configure products automatically:

1. From the Drupal administration menu, select Reports > Requirements report.
2. Click Create product type.

   

3. At the prompt, click Submit to create the product type and variation.
4. Click Create products.

   

5. Select the supported currencies for your products.
6. Click Submit.

Alternatively, you can add and configure products manually:

1. Select Commerce > Configuration > Products > Product types.
2. Click + Add product type.
3. Configure the product type details.
4. Ensure that you select Enable Apigee Monetization Add Credit for this product type.
5. Configure any additional properties for this product type.
   1. The first three properties are enabled by default upon installation of the Commerce module, but may be unchecked if you wish to limit the number of product variations for a product type, remove product variation details from the display of your product, or require manual publishing of your product in your store.
   2. You can also choose to Skip cart and go directly to checkout for this product type if you wish to eliminate the Cart message from your portal’s Add Credit page, and proceed directly to checkout.
   3. Click Save.
6. Customize the Add Credit product type:
   1. Select Commerce > Configuration > Products > Product variation types.
   2. In the Operations column for the Add Credit product type, select Manage display.
   3. Drag the Product field from the Disabled section to the first field position.
   4. Drag List price to the Disabled section.
   5. For the Product and Price fields, select Hidden in the Label column.
   6. Click Save.
   7. Select Commerce > Configuration > Products > Product types.
   8. For the Add Credit product type, select Manage display in the Operations column.
   9. For the Variations field, select Hidden in the Label column.
   10. Click Save.
7. Add a product using the Add Credit product type:
   1. Select Commerce > Products.
   2. Click + Add product.
   3. Click on the product type of the product you wish to create, i.e. your Add Credit product type.
   4. Configure the title and description of the product. Ensure that This is an Apigee add credit product is selected.
   5. Click Save and add variations.
   6. Click + Add variation.
   7. Enter a title, SKU and price details, and select Published.
   8. Click Save.
8. Customize the “Add to Cart” checkout page display for Add Credit products:
   1. Select Commerce > Configuration > Orders > Order Item types.
   2. Select Manage form display from the Operations column for your Order Item type. Note: Your Order Item type may be named “Default,” depending upon your configuration.
   3. Click the Add to Cart tab.
   4. Drag and drop the Unit Price or other data fields from Disabled to the displayed field list, as desired.
   5. Use the field widgets to display the appropriate values for each field, as desired. For example, you can use the Unit Price field widget to select the price or unit price value for display.
   6. Click Save.

Step 4: Add an Add Credit button to your prepaid balance page

You can make it easy for developers to add credit to their prepaid balances using the Add Credit products from your store. If you created Add Credit products automatically using the "Requirements report" page in Step 3, the "Add Credit" button is automatically added to your prepaid balance page.  You can skip to Step 5: Configure permissions below.

If you manually created Add Credit products, follow these steps to add an Add Credit button to your portal’s prepaid balance page:

1. Select Configuration > Apigee Edge > Monetization > Prepaid Balance.
2. Select the Add credit tab.
3. Create or edit an Add Credit product to enable adding credit to prepaid balances. One product must be added for each currency offered. If more than one currency is enabled for prepaid balances, make sure to add or configure a separate Add Credit product for each currency offered.
   1. For each currency displayed, select a product from the autocomplete list.
   2. To edit an Add Credit product that you previously added under the Commerce configuration, click the edit operation and make changes as needed.
   3. If no Add Credit products are available, see Step 3: Add products to the store.
   4. Click Save Configuration.
   5. The Add Credit button will display on your prepaid balance page:

      

Step 5: Configure permissions to view and purchase Add Credit products

To configure permissions for developers to view and purchase Add Credit products:

1. Select People > Permissions.
2. Scroll to the Apigee Monetization Add Credit section of the page.
3. Ensure that Add credit to any developer prepaid balance is checked for the Authenticated User role.
4. Click Save Permissions.

To configure permissions that enable a developer portal admin or Team lead to view prepaid balances and purchase Add Credit products for another developer:

1. Log in to the developer portal as an admin or Team lead.
2. Select People > Permissions.
3. Scroll to the Apigee Monetization section of the page. Ensure that the View any prepaid balance permission is checked for the Administrator role.
4. Scroll to the Apigee Monetization Add Credit section of the page.  Ensure that the Add credit to any developer prepaid balance permission is checked for the Administrator role.
5. Click Save Permissions.
6. Navigate to user/uid/monetization/billing, where uid is the user ID of the developer whose prepaid balance is to be viewed or adjusted using Add Credit.
7. View the developer's prepaid balance or add credit for the developer as needed.

Configure wait settings for Add Credit top-ups

In order to synchronize the availability of the Add Credit top-up option for developers in the portal with the Apigee Monetization credit balance API, the developer portal will disable the Add credit option for a specified period of time after each developer top-up.

If needed, the Top-up balance wait time can be configured by the portal administrator:

1. Sign in to the developer portal with admin credentials.
2. Go to Configuration > Apigee Monetization> General> Settings.
3. Edit the number of seconds in the Top-up balance wait field.
4. Click Save configuration.

Note: If the wait time between top-ups is adjusted, make sure that any changes comply with any Monetization availability guarantees for your account to prevent errors.

Step 7: Configure notifications for adding credit

Send a notification when a developer adds credit to their account using the Add Credit product in your portal. You can configure whether to be notified at all times or only when an error is encountered.

To configure notifications for adding credit:

1. Select Configuration > Apigee Edge > Monetization > Prepaid Balance.
2. Select the Add credit tab
3. Scroll down to Notifications section.
4. Select one of the following options:
   • Always: always send a notification when an app developer adds credit. This is the default.
   • Only on error: Send a notification when an app developer encounters an error when adding credit.
   • Enter the email address of an individual or team to receive the notifications.
   • Click Save configuration.

Step 8: Test the shopping experience

To test the shopping experience:

1. Click the Add credit button on your portal’s prepaid balance page. The Add Credit page displays.
2. Click Add to cart.
3. Click the link to your cart in the confirmation message.
4. Edit the item, as required, and click Update cart.
5. Edit items in the cart:
   • Click Remove to remove an item.
   • Edit the item quantity and click Update cart.
   • Click Checkout.
   • Update the order information and add billing information, as required.
   • Click Continue to review.
   • Review the order.
   • Click Pay and complete purchase.

Step 9: Manage orders

To view and manage Add Credit orders:

1. Click My account.
2. Click Orders.
3. Review your orders.
4. To view details of an order, click the order number.