Get started using monetization

Access monetization using the UI or the monetization API, as described in the following sections.

Using monetization in the UI

When monetization is enabled for your organization, additional monetization menus are available in the UI, as summarized in the following table:

Monetization Menu Description
Admin > Organization profile Perform the following tasks:
Admin > Bank accounts Add bank accounts
Admin > Notifications Set up notifications using notification templates
Admin > Webhooks Set up notifications using webhooks
Publish > Packages Create API packages to bundle your API products
Publish > Products Create a transaction recording policy for each API product you want to monetize
Publish > Companies Group your developers into companies
Monetization > Reports Create reports for billing, prepaid balances, revenue, or variance
Monetization > Adjustments Make adjustments to traffic details
Monetization > Credits Issuing credits for developers
Monetization > Refunds Post refunds to developers for purchase transactions
Monetization > Billing Documents Create billing documents such as invoices and revenue share statements for use of your APIs
Monetization > Billing Document Configuration Configure information required for billing documents

Using the monetization API

The base path of the monetization API is https://api.enterprise.apigee.com/v1/mint. The URL of all monetization requests starts with the monetization base path followed by the path of the target resource.

For a complete list of monetization APIs, see Monetization APIs.

The following provides an example:

$ curl -H "Content-Type: application/json" -X POST -d \
'{
 "url":"www.testoperator/termsandconditions",
 "tncText":"Sample text for the T&C", 
 "version":"1.1",
 "startDate":"2013-06-24”
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-u email:password

Examples of the monetization APIs are provided using cURL throughout the documentation. You can copy and paste the sample commands into your command-line terminal. After you copy and paste the command to your terminal, you must replace the variables in the command with information for your Apigee Edge account. For example, in the example above, you would need to replace the following variables:

  • {org_name}: The name of your organization.
  • email: The email address for your Apigee Edge account.
  • password: The password for your Apigee Edge account.

Next steps

Enable monetization for an organization and learn how to edit your organization profile in Edit the organization profile.

Send feedback about...

Apigee Docs