Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Monetization APIs

Overview

Monetization API documentation provides instructions on how to interact with the monetization feature using API calls.

The instructions include sample API calls displayed as simple cURL commands. You should be able to copy and paste these commands into your command-line terminal. For 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

After you copy and paste the command to your terminal, you must replace the following variables in the command with information for your Apigee Edge account:

  • {org_name}: Name of your organization.
  • email: Email address for your Apigee Edge account.
  • password: Password for your Apigee Edge  account.

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

API Packages

Creating an API package using the API

Adding an API product to an API package using the API

Adding an API product to an API package with API product-specific rate plans using the API

Deleting an API product from an API package using the API

Viewing API packages using the API

Retrieving API packages accepted by a developer using the API

API package configuration settings for the API

Bank Accounts

Adding a bank account using the API

Retrieving bank accounts using the API

Updating a bank account using the API

Deleting a bank account using the API

Bank account configuration settings for the API

Billing Adjustments

Making a billing adjustment using the API

Retrieving billing adjustments using the API

Updating a billing adjustment using the API

Deleting a billing adjustment using the API

Billing adjustment configuration settings for the API

Billing Documents

Configuring billing documents in the API

Retrieving billing months using the API

Generating draft billing documents using the API

Retrieving information about unpublished billing documents using the API

Generating and publishing final billing documents using the API

Retrieving published document months using the API

Searching for published billing documents using the API

Billing document configuration settings for the API

Billing Reports

Creating a report definition using the API

Retrieving report definitions using the API

Updating a report definition using the API

Deleting a report definition using the API

Generating a report using the API

Reporting transaction activity using the API

Report definition configuration settings for the API

Criteria configuration settings for the API

Credits

Issuing credit using the API

Setting a credit limit using the API

Retrieving a credit limit using the API

Credit configuration settings for the API

Currencies

Retrieving supported currencies using the API

Adding supported currencies using the API

Updating a supported currency using the API

Deleting a supported currency using the API

Supported currency configuration settings for the API

Developer Categories

Creating a developer category using the API

Retrieving developer categories using the API

Updating a developer category using the API

Deleting a developer category using the API

Adding a developer to a developer category using the API

Developer category configuration settings for the API

Creating a developer role using the API

Retrieving developer roles using the API

Developer role configuration settings for the API

Retrieving the tax rate for a developer using the API

Performing other developer-specific tasks using the API

Developer Migration

Migrating developers using the API

Event Notifications and Alerts

Managing notification templates using the API

Configuring notification conditions and actions using the API

Viewing a notification condition and action using the API

Updating a notification condition and action using the API

Deleting a notification condition using the API

Notification condition configuration settings for the API

Notification action configuration settings for the API

Testing webhooks using the API

Viewing and reprocessing notifications using the API

Prepaid Balances

Reloading a prepaid balance using the API

Retrieving balances using the API

Prepaid balance configuration settings for the API

Rate Plans

Adding fees to a rate plan using the API

Adding a freemium plan to a rate plan using the API

Specifying fees only plan details using the API

Specifying adjustable notification plan details using the API

Specifying revenue share plan details using the API

Specifying rate card plan details using the API

Specifying a freemium plan for individual products using the API

Specifying details for a rate card plan with custom attributes using the API

Viewing rate plans using the API

Publishing a rate plan using the API

Saving a rate plan draft using the API

Updating a rate plan draft using the API

Deleting a rate plan draft using the API

Accepting published rate plans using the API

Developer acceptance rate plan configuration settings for the API

Setting up a future rate plan using the API

Refunds

Posting a refund using the API

Refund configuration settings for the API

Synchronize Monetization

Synchronizing your organization using the API

Synchronizing products using the API

Synchronizing developers using the API

Synchronizing applications using the API

Terms and Conditions

Adding terms and conditions using an API

Retrieving terms and conditions using the API

Retrieving terms and conditions accepted by a developer using the API

Updating terms and conditions using the API

Deleting terms and conditions using the API

Terms and conditions configuration settings for the API

Transaction Recording Policies

Creating a transaction recording policy using the API

Specifying transaction success criteria using the API

Specifying custom attributes using the API

Transaction Status

Viewing the status of transactions

Unsuspend developers

Viewing all suspended developers using the API

Viewing a suspended developer using the API

Unsuspending all developers for an API product using the API

Unsuspending a developer using the API

 

Help or comments?