You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Create an API package

Resource Summary

Security

Content Type

application/json

Category

API packages,

Create an API package

POST

Create an API package

Create an API package.

An API package is a collection of API products that is presented to developers as a bundle, and typically associated with one or more rate plans for monetization. An API package does not become visible to developers until you publish a rate plan for the package (with a start date of the current or future date).

Developers can register their apps to use an API package only by purchasing one of the rate plans currently in effect. If an API package does not have a published rate plan that is currently in effect, the package is not monetized.

You can create multiple API packages. You decide which API products to include in each API package. You can even put the same API product or products in different packages and associate them with the same or different rate plans.

After you add an API product to a package, you may need to set up price points for the API product. You need to do this only if all of the following are true:

  • You set up a revenue sharing rate plan for the API product.
  • Developers charge third parties for the use of the resources in the API product.
  • There is a minimum or maximum restriction on the amount developers can charge and you want to notify developers of the restriction.

 

The minimum and maximum prices are displayed in the details for the API package.

See also Creating an API package using the API.

Note: Once you create a package, you cannot delete it.

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}/monetization-packages

Header Parameters

Name Values Description
Content-Type
(required)

Request content type.

Request Body

{ "description": { "type": "string", "description": "Description of the API package." }, "displayName": { "type": "string", "description": "User-friendly display name for the API package." }, "name": { "type": "string", "description": "Name of the API package." }, "organization": { "properties": { "id": { "type": "string", "description": "ID of the organization." } } }, "product": { "type": "array", "description": "List of API products to include in the API package.", "items": { "properties": { "id": { "type": "string", "description": "ID of the API product." } } } }, "status": { "type": "string", "description": "Status indicator for the API package. Valid values include: CREATED, ACTIVE, INACTIVE. Note: This value is maintained but not currently used by the API package." } }

org_name Name of your organization. true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)