Was this Helpful?

Introduction

Fees are optional. You do not have to specify any fees in a rate plan.

After you initially set up a rate plan, you can specify any fees pertinent to the use of the API package and its resources. This can include:

  • A setup fee. A one-time fee that is charged to each developer on the start date of the plan.
  • An early termination fee. A one-time fee that is charged if the developer ends the plan before the renewal term.
  • A recurring fee. A fee that is charged to the developer on an ongoing basis until the developer ends the plan. If you specify a recurring fee, you need to also specify its duration, that is, indicate the period of time between recurring fee charges (such as 30 days).
  • Whether the fee is prorated. This pertains to developers that start or end the plan part of the way through a month. If the fee is prorated, the initial fee is based on the number of days until the end of the period (or the number of days used in the period). If the fee is not prorated, the developer is charged the full initial fee irrespective of when the he starts (or ends) the plan.
  • Whether the recurring fee is charged in advance. If the recurring fee is charged in advance, the developer is charged on the invoice prior to the current period. For example, if the period is 1 month, the recurring fee is charged on the invoice that is generated when the prior billing month ends. If the recurring fee is not charged in advance, it is charged at the end of the current period (for example, at the end of the billing month).
  • When fees are due, for example in 30 days.

Toolbox

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

If you use the API, you add fees by setting fee-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 fees to a rate plan using the UI

  1. Select the Fees tab in the Rate Plan window.

  2. Enter the following information:
    Field Description
    Currency

    The currency in which you want the fees to be charged. Select a currency from the list of supported currencies in the drop-down menu.

    Setup Fee Amount

    A one-time fee that is charged to each developer on the start date of the plan (that is, the date the developer purchases the plan). Enter the amount to be charged.

    Early Termination

    A one-time fee that is charged if the developer ends the plan before the renewal term. Enter the amount to be charged.

    Recurring

    A fee that is charged to the developer on an ongoing basis until the developer ends the plan. Specify the amount to be charged.

    Period

    The period of time between recurring fee charges. Enter a number (between 1 and 12) and select Week or Month. For example, enter 1 and select Month to specify that the developer is charged the recurring fee once per month.

    Pro Rata?

    Indicates whether or not the recurring fee is prorated. This field pertains to the developer starting or ending the plan part of the way through a month. Select one of the following radio buttons:

    • Yes, prorated. Monetization prorates the initial fee based on the number of days until the end of the period (or the number of days used in the period).
    • No, full fee. Monetization charges the full initial fee irrespective of when the developer starts (or ends) the plan. This is the default.
    In Advance?

    Indicates whether or not the recurring fee is charged in advance. Select one of the following radio buttons:

    • Yes, charged in advance. Monetization charges the recurring fee in advance. For example, if the period is 1 month, the recurring fee is charged on the invoice generated when the prior billing month ends.
    • No, in arrears. Monetization charges the fee at the end of the period. For example, if the period is 1 month, the recurring fee is charged on the invoice when the current billing month ends. This is the default.
    Fees Due

    Indicates when the fees are due. Select either 30, 45, 60, or 90 days. Or choose Custom to specify another fees due period.

Adding fees to a rate plan using the API

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

For example, the following request creates a standard rate plan with an early termination fee, a setup fee, and a recurring fee (each are set at 10 U.S. dollars). The fee duration is 30 days, fees are due in 30 days, and the recurring fee is prorated. (The fee-related specifications are highlighted.)

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Simple rate plan",
     "currency": {
      "id" : "usd"
     },
     "earlyTerminationFee": "10",
     "frequencyDuration": "30",
     "description": "Simple rate plan",
     "displayName" : "Simple rate plan",
     "frequencyDurationType": "DAY",
     "monetizationPackage": {
      "id": "location_package"
     },
     "organization": {
      "id": "myorg"
     },
     "prorate": "true",
     "paymentDueDays": "30",
     "published": "true",
     "ratePlanDetails": [
     {
      …
      }
      ],
     "recurringFee": "10",
     "setUpFee": "10",
     "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

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

Get help

For help, see Apigee Customer Support.

Next steps

You can set up a freemium plan in a rate plan. The freemium plan terms define a period in which developers can use the resources provided by the API package without charge. The developer is charged for the use of those API products after the free period ends. Learn how to set up a freemium plan in Add a freemium plan.

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)