Send Docs Feedback

Specify rate plan details

Introduction

When you create a rate plan, there are details that you need to specify, such as:

  • Revenue model that applies to the rate plan.
  • Whether the rate plan applies to all the products in an API package or to a specific product.
  • For a revenue share plan, whether the revenue share is based on the net or gross price of a transaction.
  • For a rate card plan, whether charges are based on the volume of transactions or based on a custom attribute defined in the transaction recording policy.
  • For a revenue share or rate card plan, when payment is due.

Specifying details based on revenue model

You can create rate plans that use the revenue models, or rate plan types, defined in the following table. Based on the revenue model that you choose, you need to provide additional details. For example, for a revenue share plan, you can specify a fixed sharing model or a flexible sharing model. For a rate card plan, you can charge a developer a flat rate, charge based on "volume bands", that is, ranges of transaction volume for which you can apply different rates, or charge a set amount (up-front) for each "bundle" of transactions. For any revenue model, you can set fees to 0 so no charges are incurred by the app developer that accepts the plan.

Revenue Model Description
Fees only

App developer only pays the API provider fees specified in the rate plan. There are no additional transaction-related fees. For information about specifying fees for the rate plan:

Adjustable Notification

Notification only plan. API provider can adjust the target number of transactions for each app developer that will trigger the notification. 

Note: An adjustable notification rate plan can be adjusted after the rate plan is published. For all other rate plan types, the rate plan details are final once the plan is published and are the same for all app developers that accept the plan.

You can configure if and when notifications are sent based on what percentage of the target number has been reached, such as 90%, 100%, or 150%. Additional transactions are not blocked after the target number is reached. See Specifying adjustable notification plan details for further information.

Adjustable Notification with Custom Attribute

Notification only plan. Functionally equivalent to an Adjustable Notification plan, but the transaction counter is based on a variable or custom value.

For example, you may need to:

  • Charge developers a variable amount based on a value provided in the message of an API call. For example, you may want to charge app developers based on the number of bytes transmitted in the API request.
  • Bundle multiple API calls into a single transaction.
Revenue Share

API provider shares with the app developer a percentage of the revenue generated from each transaction (based on the gross or net price of a transaction). For example, the consumer purchases a physical or digital product using the API and a portion of the proceeds are shared with the app developer. See Specify revenue share plan details for further information.

Rate Card

App developer is charged for each transaction. See Specify rate card plan details for further information.

Rate Card with Custom Attribute

App developer is charged based on a custom attribute within each transaction. For example, if you set up a plan where you charge the developer for each transaction, you can set the rate for the plan based on a custom attribute, such as the number of bytes transmitted on the back-end which can vary per transaction. See Specify rate plan with custom attribute details for further information.

This rate plan type is available only if you specify custom attributes for the API product.
Revenue Share and Rate Card

API provider shares a percentage of the revenue generated from each transaction with the app developer, and the app developer is charged for each transaction. See Specify revenue share plan details and Specify rate card plan details for further information.

Get help

For help, see Apigee Customer Support.

Next steps

Specify rate card details for your revenue model:

Help or comments?