Send Docs Feedback

Steps to set up monetization

Before you begin

Before you begin using monetization, you need to sign up for an Apigee Edge account at https://accounts.apigee.com/accounts/sign_up. You also need to purchase monetization.

Monetization depends on Edge. However, Edge does not initially include the monetization API or integrate monetization into the  management UI. You need to purchase the monetization feature to incorporate the monetization API and the monetization UI components into Edge.

An Apigee Edge account provides you with:

  • An organization
  • A username
  • A password

You use these credentials to login to enterprise.apigee.com. This exposes the Edge API Services APIs and the Edge management UI.

After you purchase monetization, you need to:

Initial setup performed by the Apigee Edge configuration team

Work with the Apigee Edge configuration team to complete the initial setup of monetization. Based on your input the configuration team will set up the following:

  • Whether your organization is a telecommunications company.
  • Which billing type you wish to support for for developers who purchase your rate plans: prepaid, postpaid, or both.
    • A prepaid developer pays in advance for the use of your API products. Funds are deducted from a prepaid developer's balance when the API product is used.
    • A postpaid developer is billed monthly (through an invoice) for the use of your API products.
  • Tax engine information (if you plan to use monetization for billing documents).
  • Whether or not you want to auto-schedule bill runs rather than run them manually (if you plan to use monetization for billing documents). Learn more about the scheduler and scheduled jobs in Schedule monetization jobs, and about generating billing documents manually in Create billing documents.
  • Whether you want detailed or summary data extracted from monetization into your accounting system and the data format required.
  • Custom email reply address. For monetization email notifications that are sent to companies and developers, a default noreply@apigee.com address is configured. You must request a custom reply name and address for your organization.

The Apigee configuration team also runs a script that synchronizes monetization with your organization and any developers, applications, and products that you created using the Edge API Services. After a period of time (such as a few months) and periodically after that, it's advisable to re-synchronize your organization with monetization, and any developers, applications, and products that you created using Edge API Services. See Synchronize Apigee Edge data with monetization for details.

Set up monetization

After the Edge configuration team creates the initial configuration, here's what you need to do to further set up and use monetization:

  1. Edit the organization profile. The organization profile includes your organization’s name, country, terms and conditions, and supported currencies.
  2. Add terms and conditions (T&C's) that developers must accept before they can purchase your rate plans. See Specify terms and conditions for details.
  3. Edit the currencies initially set up for your organization. See Manage supported currencies for details.
  4. Add bank account information for billing and invoices. You only need to do this if you want monetization to generate billing documents and you plan to support postpaid developers. See Add bank accounts for details.
  5. Enforce monetization limits on the API proxies in your API products.
  6. Configure billing documents. The configuration provides some basic information such as the country in which you’re registered for tax purposes (this allows monetization to generate the applicable taxes on invoices and other billing documents).
  7. Create API packages that you want to monetize for sale to developers. Each API package groups one or more API products.

    You can create API packages before you create transaction recording policies for API products, or you can create API packages after you create transaction policies. Monetization does not mandate the order in which you perform these actions.

  8. Create a transaction recording policy for each of your API products. The transaction recording policy defines what you would like to capture in the transaction records for an API product, including any custom attributes.

    Use the management UI or Edge API Services APIs to create API products if you haven't already done so. For further details, see Creating an API product.

  9. Create rate plans for each API package. You can set up standard rate plans, rate plans for developer categories, or developer-specific rate plans. After you create rate plans, you can publish them for viewing by developers or save them as drafts (see Managing and publishing rate plans).
  10. Group multiple developers into companies (as applicable). By creating companies and assigning developers to them, you can create rate plans that apply to specific companies.
  11. Set up notifications using notification templates that you want to enable.
  12. Configure monetization in the developer portal, as described in Overview of Monetization in the Developer Portal.

Manage monetization

After you set up monetization, you can do the following:

  • Create reports. You can create billing, prepaid balance, revenue, and variance reports. For prepaid developers, you can reconcile prepaid balance reports with bank deposits.
  • Generate billing documents (if you use monetization for billing).
  • Make adjustments to billing and traffic details to correct discrepancies in your records, for example.
  • Manage credit (such as refunds and adjustments), if applicable.
  • Manage prepaid account balances for prepaid accounts using a third-party payment provider or by setting up automatic reload.
  • Post refunds to developers for purchase transactions.
  • Schedule monetization jobs to send notifications, fetch and revise tax rates, and more.
  • Synchronize Apigee Edge data with monetization periodically to ensure that the data is in sync.
  • Test monetization to test the execution of webhooks and notifications, and view status of transactions.
  • Extract files to other systems for accounting (and billing if you don't use monetization for billing). This depends on the extraction process for integration with other systems that the Apigee Edge configuration team created in the initial configuration.

Next steps

Learn how to access monetization using the UI and monetization API Get started using monetization.

Help or comments?