Was this helpful?

Introduction

A freemium plan is optional. By default, a rate plan is not a freemium plan

When you create a rate plan, you can set up a freemium plan that allows developers to use the resources provided by the API package without charge. You can set up a freemium plan for an entire API package or for an individual API product.

You can create a freemium plan for an individual API product if your rate plan type is rate card and only if you set up the plan for a specific product — see Specify rate card plan details for further information.

The freemium plan terms define the period in which the developer can use the resources provided by the API package without charge. The period can be based on one of the following:

  • Duration, that is, the time between an effective date and an end date.
  • Quantity, such as the number of transactions involving the API package.
  • Whichever threshold is reached first.

The developer is charged for the use of those API products after the free period ends.

Toolbox

You can add a freemium plan using the management UI or monetization API. If you use the UI, you add fees in the the Freemium tab in the Rate Plan window.

If you use the API, you add fees by setting freemium-related properties in the request body in a call to the /organizations/{org_name}/monetization-packages/{package_id}/rate-plans resource (when you create the rate plan) or to the /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/plan_id resource (when you update the rate plan).

Adding a freemium plan to a rate plan using the UI

  1. Select the Freemium tab.

  2. Enter the following information:
    Field Description
    Freemium Package?

    The extent of the free period. Select one of the following radio buttons:

    • By Quantity. The free period is based on a quantity specified in the Volume field.
    • By Duration. The free period is based on a time interval specified in the Freemium Duration field.
    • Whichever comes first. The free period ends when either the quantity in the Volume field or the time interval in the Freemium Duration field is reached, whichever happens first.
    • No. This is not a Freemium plan. This is the default.
    Freemium Volume

    The volume of transactions (or volume pertaining to a custom attribute recorded in the transaction recording policy) for which the developer is charged. The volume is measured across all products in the API package. Enter a volume number, such as 5000. This means that when the developer starts the plan, he is not charged for the first 5000 transactions (or for the first 5000 uses of a custom attribute-related item). This field is enabled only if you select "By Quantity" or "Whichever comes first" in the "Freemium Package?" field.

    Freemium Duration

    The time interval during which the developer is not charged. Enter a number and select a time period, for example, 1 Month. This means that the developer is not charged for 1 month following the start date of the purchased plan. This field is enabled only if you select "By Duration" or "Whichever comes first" in the "freemium Package?" field.

Adding a freemium plan to a rate plan using the API

You can add a freemium plan when you create or update the rate plan plan. You specify the freemium properties in the request body of the call.

For example, the following request creates a standard rate plan with freemium duration period of 30 days. (The freemium-related specifications are highlighted.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "freemiumDuration": "30",
     "freemiumDurationType": "DAY",
     "monetizationPackage": {
      "id": "location_package"
     },
     "organization": {
      "id": "{org_name}
     },
     "published": "true",
     "ratePlanDetails": [
     {
      …
      }
      ],
     "startDate": "2013-09-15",
     "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location_package/rate-plans" \
-u myname:mypass

To specify a freemium-based quantity (such as the number of transactions involving the API package or the volume pertaining to a custom attribute recorded in the transaction recording policy), specify it as a number of freemium units. For example, the following property assignment, specifies that the freemium is based on 5000 freemium units:

"freemiumUnit": "5000"

See Rate plan configuration settings for a complete list of rate plan options.

Get help

For help, see Apigee Customer Support.

Next steps

When you create a rate plan, there are details that you need to specify. Learn what the details are in Specify plan details.

Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.