Introduction

This step is optional. It only applies if you set up a revenue share plan and you want to display any restrictions in pricing to developers.

In monetization, price points specify the minimum price (gross or net) and maximum price (gross or net) that developers can charge for the use of apps that access resources provided by an API product.

Toolbox

You can set price points using the management UI or monetization API. If you use the UI, you set price points using the Product Settings tab in the package catalog.

If you use the API, you set price points by issuing a POST request to the /organizations/{org_name}/price-points resource.

After you initially set price points, you can perform management operations on them such as update or delete. Management operations on price points are performed by issuing calls to the /organizations/{org_name}/products/{product_id}/price-points/{pricepoint_id} resource.

Setting price points using the UI

  1. Select the Product Settings tab in the package catalog.
  2. Select the pertinent API product.

    This opens the Product Settings window.

  3. Click Edit.
  4. Enter the following information in the Price Points section of the Product Settings window:
    Field Description
    Operator (or Organization)

    The name of your organization company. This field is preset using the Operator (or Organization) field value in the Organization Profile.

    Country

    The country of operation of your organization. This field is preset using the Country field value in the Organization Profile.

    Gross/Net

    The basis of the price points. Select Gross price, Net price, or Gross and Net price.

    Min Gross

    The minimum gross price point. This field is enabled only if the selection in the Gross/Net field is Gross or Gross and Net.

    Max Gross

    The maximum gross price point. This field is enabled only if the selection in the Gross/Net field is Gross or Gross and Net.

    Min Net

    The minimum net price point. This field is enabled only if the selection in the Gross/Net field is Net or Gross and Net.

    Max Net

    The maximum net price point. This field is enabled only if the selection in the Gross/Net field is Net or Gross and Net.

  5. Click Save (or Revert to cancel).

Setting price points using the API

You can set price points by adding one or more price points to an API product.

You can add price points to an API product before you create API packages or after you create the API packages. Monetization does not mandate the order in which you perform these actions.

To add a price point, issue a POST request to /organizations/{org_name}/products/{product_id}/price-points. When you add a price point, you can supply input such as the minimum and maximum net price or minimum and maximum gross price that a developer can charge, when the price point goes into effect (the start date), and when it ends (the end date). Only the start date is mandatory. You also must specify whether the price point should be published (true) or not (false). See Price point configuration settings for a list of price point options exposed to the API.

For example, the following request sets a minimum and maximum gross price, specifies a start date, and sets the published flag to false:

$ curl -H "Content-Type:application/json" -X POST -d \
'{
  "grossStartPrice": "10.0000",
  "grossEndPrice": "30.0000",  
  "published": "false",
  "startDate": "2013-08-15"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/products/location/price-points" \
-u myname:mypass

The response should look like this (only part of the response is shown):

{
  "grossEndPrice" : 30.0000,
  "grossStartPrice" : 10.0000,
  "id" : "7e806f75-0125-433a-922b-8dbb3e6b5b47",
  "organization" : {
    ...
  },
  "published" : false,
  "startDate" : "2013-08-15 00:00:00"
}

Retrieving price points using the API

You can retrieve an individual price point or all the price points set for an API product. To retrieve an individual price point, issue a GET request to /organizations/{org_name}/products/{product_id}/price-points/{pricepoint_id} where {pricepoint_id} is the identification of the price point (the ID is returned in the response when you add the price point to an API product. For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/products/location/price-points/7e806f75-0125-433a-922b-8dbb3e6b5b47" \
-u myname:mypass

To retrieve all the price points for an API product, issue a GET request to /organizations/{org_id}/products/{product_id}/price-points. For example:

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/products/location/price-points" \
-u myname:mypass

The response should look something like this (only part of the response is shown):

{
  "pricePoint" : [ {
    "grossEndPrice" : 50.0000,
    "grossStartPrice" : 40.0000,
    "id" : "6e56169d-e143-4a38-9655-e9b090ed0288",
    "organization" : {
     ...
    },
    "published" : false,
    "startDate" : "2013-10-01 00:00:00"
  }, {
    "grossEndPrice" : 30.0000,
    "grossStartPrice" : 10.0000,
    "id" : "7e806f75-0125-433a-922b-8dbb3e6b5b47",
    "organization" : {
      ...
    },
    "published" : false,
    "startDate" : "2013-08-15 00:00:00"
  } ]
}

Updating a price point using the API

You can update a price point by issuing a PUT request to /organizations/{org_name}/products/{product_id}/price-points/{pricepoint_id}, where {pricepoint_id} is the identification of the price point you want to update. When you make the update, you need to specify as input:

  • The updates.
  • The ID of the price point.
  • The start date
  • The published flag.

Also, if you update a gross or net price, you need to specify both the minimum and maximum price.

For example, the following API call updates the maximum gross price for the price point (the updated parameter is highlighted in the example):

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
  "id" : "7e806f75-0125-433a-922b-8dbb3e6b5b47",  
  "grossStartPrice": "40.0000",
  "grossEndPrice": "70.0000",  
  "published": "false",
  "startDate": "2013-10-01"
}' \
"https://api.enterprise.apigee.com/v1/mint/organization/org_name}/products/location/price-points/7e806f75-0125-433a-922b-8dbb3e6b5b47" \
-u myname:mypass

The response should look like this (the updated data is highlighted and only part of the response is shown):

{
   "grossEndPrice" : 70.0000,
   "grossStartPrice" : 40.0000,
   "id" : "7e806f75-0125-433a-922b-8dbb3e6b5b47",
   "organization" : {
     ...
   },
   "published" : false,
   "startDate" : "2013-10-01 00:00:00"
 }

Deleting a price point using the API

To delete a price point, issue a DELETE request /organizations/{org_name}/products/{product_id}/price-points/{pricepoint_id} where {pricepoint_id} is the identification of the price point to be deleted. For example:

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/products/location/price-points/7e806f75-0125-433a-922b-8dbb3e6b5b47" \
-u myname:mypass

Price point configuration settings

The following price point configuration options are exposed to the API:

Name Description Default Required?
netStartPrice

The minimum net price point.

N/A No
netEnd Price

The maximum net price point.

N/A No
grossStartPrice

The minimum gross price point.

N/A No
grossEndPrice

The maximum gross price point.

N/A No
published

Indicates whether the price point should be published. The value can be one of the following:

  • true. The price point should be published.
  • false. The price point should not be published.

 

N/A Yes
startDate

The date when the price point goes into effect.

N/A Yes
endDate

The date when the price point is no longer in effect.

N/A No
organization

The organization that contains the price point.

N/A No

Get help

For help, see Apigee Customer Support.

Next steps

See Create rate plans and start creating rate plans for your API products.

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?)