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.

View rate plans

Introduction

You can view a specific rate plan or all rate plans for an organization, or an individual developer or developer category.

You can filter the list of rate plans returned based on whether the rate plan:

  • Has been been accepted by a developer.
  • Is public or private.
  • Is active, draft, or expired.

Viewing rate plans using the UI

You can view rate plans using the Edge UI as described in the following sections.

Viewing all rate plans for an API package using the UI

To view all rate plans for an API package using the UI:

  1. On the Publish tab, select Packages to open the API package catalog.

  2. Click the Packaged Rate Plans tab (if it is not already selected).

The API catalog lists the API packages already created in your organization, the API products in those packages, and the associated rate plans. If you created a rate plan for a specific developer or developer category, its name appears in the Developer column.

You can filter the list by rate plan name and whether it is public or private rate plan.

Viewing a rate plan using the UI

To view a rate plan using the UI:

  1. On the Publish tab, select Packages to open the API package catalog.

  2. Click the Packaged Rate Plans tab (if it is not already selected).
  3. Click the name of the rate plan that you want to view.

The Rate Plan dialog is opened enabling you to view the rate plan details. You can click the name of another rate plan, without closing the Rate Plan dialog, to refresh the dialog contents with the new rate plan details.

Viewing rate plans using the API

You can view rate plans using the monetization API as described in the following sections.

Viewing all rate plans for an API package using the API

To view all rate plans for an API package, issue a GET request to /organizations/{org_name}/monetization-packages/{package_id}/rate-plans,  where {package_id} is the ID of the API package (the package ID is returned when you create the monetization package).

By default, only active and public rate plans are returned in the results. To include:

  • Draft or expired rate plans, set the current query parameter to false (for example, ?current=false).
  • Private rate plans, set the showPrivate query parameter to true (for example, ?showPrivate=true).

For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans" \
-u email:password

Viewing a rate plan for an API package using the API

To view a rate plan for an API package, issue a GET request to /organizations/{org_name}/monetization-packages/{package_id}/rate-plans/{plan_id}, where {package_id} is the ID of the API package, and {plan_id} is the ID of the rate plan (the package ID is returned when you create the monetization package, and the rate plan ID is returned when you create the rate plan).

For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/communications/rate-plans/communications_standard_fixed_plan" \
-u email:password

The following provides an example of the response:

{
   "advance" : true,
   "contractDuration" : 1,
   "contractDurationType" : "YEAR",
   "currency" : {
     "id" : "usd",
     ...
     "organization" : {
       ...
     },
     ...
   },
   "description" : "Standard Fixed Plan",
   "displayName" : "Standard Fixed Plan",
   "earlyTerminationFee" : 0.0000,
   "frequencyDuration" : 1,
   "frequencyDurationType" : "MONTH",
   "id" : "communications_standard_fixed_plan",
   "isPrivate" : false,
   "monetizationPackage" : {
     "description" : "Communications",
     "displayName" : "Communications",
     "id" : "communications",
     "name" : "Communications",
     "organization" : {
      ...
     },
     "product" : [ {
       "customAtt1Name" : "user",
       "description" : "Location",
       "displayName" : "Location",
       "id" : "location",
       "name" : "location",
       "organization" : {
       ...
       },
       "status" : "CREATED"
     }, {
       "customAtt1Name" : "user",
       "description" : "Messaging",
       "displayName" : "Messaging",
       "id" : "messaging",
       "name" : "messaging",
       "organization" : {
         ...
       },
       "status" : "CREATED"
     } ],
     "status" : "CREATED"
   },
   "name" : "Standard Fixed Plan",
   "organization" : {
     ...
   },
   "paymentDueDays" : "30",
   "prorate" : true,
   "published" : true,
   "ratePlanDetails" : [ {
     "aggregateFreemiumCounters" : true,
     "aggregateStandardCounters" : true,
     "currency" : {
       "id" : "usd",
       "name" : "USD",
       "organization" : {
        ...
       },
       "status" : "ACTIVE",
       "virtualCurrency" : false
     },
     "id" : "cb92f7f3-7331-446f-ad63-3e176ad06a86",
     "meteringType" : "UNIT",
     "organization" : {
      ...
     },
     "paymentDueDays" : "30",
     "ratePlanRates" : [ {
       "id" : "07eefdfb-4db5-47f6-b182-5d606c6051c2",
       "rate" : 0.0500,
       "startUnit" : 0,
       "type" : "RATECARD"
     } ],
     "ratingParameter" : "VOLUME",
     "type" : "RATECARD"
   } ],
   "recurringFee" : 200.0000,
   "recurringStartUnit" : 1,
   "recurringType" : "CALENDAR",
   "setUpFee" : 100.0000,
   "startDate" : "2013-01-11 22:00:00",
   "type" : "STANDARD"
 }

Viewing all active rate plans for a developer using the API

To view all active rate plans for a developer, issue a GET request to /organizations/{org_name}/developers/{developer_id}/developer-rateplans, where {developer_id} is the ID of the developer.

You can pass the following query parameters to filter the results:

Query Parameter Description
all Flag that specifies whether to return all API packages. If set to false, the number of API packages returned per page is defined by the size query parameter. Defaults to false.
size Number of API packages returned per page. Defaults to 20. If the all query parameter is set to true, this parameter is ignored.
page Number of the page that you want to return (if content is paginated). If the all query parameter is set to true, this parameter is ignored.

For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans" \
-u email:password

The following provides an example of the response:

{
  "ratePlan" : [ {
    "advance" : true,
    "contractDuration" : 1,
    "contractDurationType" : "MONTH",
    "currency" : {
      "description" : "United States Dollar",
      "displayName" : "United States Dollar",
      "id" : "usd",
      "name" : "USD",
      "organization" : {
        ...
      },
      "status" : "ACTIVE",
      "virtualCurrency" : false
    },
    "description" : "Fee Only RatePlan",
    "displayName" : "Fee Only RatePlan",
    "earlyTerminationFee" : 10.0000,
    "freemiumDuration" : 0,
    "freemiumDurationType" : "MONTH",
    "freemiumUnit" : 0,
    "frequencyDuration" : 1,
    "frequencyDurationType" : "WEEK",
    "id" : "messaging_package_fee_only_rateplan",
    "isPrivate" : false,
    "monetizationPackage" : {
      "description" : "messaging package",
      "displayName" : "Messaging Package",
      "id" : "messaging_package",
      "name" : "Messaging Package",
      "organization" : {
        ...
      },
      "product" : [ {
        "customAtt1Name" : "user",
        "customAtt2Name" : "response size",
        "customAtt3Name" : "content-length",
        "description" : "messaging api product",
        "displayName" : "messaging",
        "id" : "messaging",
        "name" : "messaging",
        "organization" : {
         ...
        },
        "status" : "CREATED",
        "transactionSuccessCriteria" : "status == 'SUCCESS'"
      } ],
      "status" : "CREATED"
    },
    "name" : "Fee Only RatePlan",
    "organization" : {
     ...
    },
    "paymentDueDays" : "30",
    "prorate" : false,
    "published" : true,
    "ratePlanDetails" : [ ],
    "recurringFee" : 10.0000,
    "recurringStartUnit" : 1,
    "recurringType" : "CALENDAR",
    "setUpFee" : 20.0000,
    "startDate" : "2013-02-20 00:00:00",
    "type" : "STANDARD"
  } ],
  "totalRecords" : 1
}

Viewing an active rate plan for a developer using the API

To view an active rate plan for a developer, issue a GET request to /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{plan_id}, where {developer_id} is the ID of the developer, and {plan_id} is the ID of the rate plan.

For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/messaging_package_fee_only_rateplan" \
-u email:password

Viewing all active rate plans for a developer that contain an API product using the API

To view all active rate plans for a developer that contain an API product, issue a GET request to /organizations/{org_id}/developers/{developer_id}/products/{product_id}/rate-plan-by-developer-product, where {developer_id} is the ID of the developer and /{product_id} is the ID of the product.

By default, only public rate plans are returned in the results. To include private rate plans, set the showPrivate query parameter to true (for example, ?showPrivate=true).

For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/products/location/rate-plan-by-developer-product" \
-u email:password

Viewing all rate plans accepted by a developer using the API

To view rate plans that have been accepted by a developer, issue a GET request to /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, where {developer_id} is the ID of the developer.

You can pass the following query parameters to filter the results:

Query Parameter Description
all Flag that specifies whether to return all API packages. If set to false, the number of API packages returned per page is defined by the size query parameter. Defaults to false.
size Number of API packages returned per page. Defaults to 20. If the all query parameter is set to true, this parameter is ignored.
page Number of the page that you want to return (if content is paginated). If the all query parameter is set to true, this parameter is ignored.

For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-accepted-rateplans" \
-u email:password

Help or comments?