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.

Update a rate plan accepted by a developer

Resource Summary

Security

Content Type

application/json

Category

Rate plans,

Updatearateplanacceptedbyadeveloper

PUT

Update a rate plan accepted by a developer

Update a rate plan that has been accepted by a developer. Specifically, you can perform the following tasks:

Resource URL

https://api.enterprise.apigee.com/v1/mint /organizations/{org_name}/developers/{developer_id}/developer-rateplans/{plan_id}

Header Parameters

Name Values Description
Content-Type
(required)

Request content type

Request Body

{ "developer": { "properties": { "id": { "type": "string", "description": "ID of the developer or company accepting the rate plan." } } }, "endDate": { "type": "string", "description": "Date and time that the rate plan ends in UTC. The rate plan will be in effect until the end of the day on the date specified. If you want to expire a rate plan on December 1, 2016, for example, you should set the endDate value to 2016-11-30. In this case, the rate plan will expire at the end of the day on November 30, 2016; all requests on December 1, 2016 will be blocked. Note: When viewing the rate plan using the API, the endDate time stamp is specified as YYYY-MM-DD 00:00:00, which may be misleading." }, "quotaTarget": { "type": "integer", "description": "Target number of transactions allowed for the app developer. You can configure if and when notifications are sent based on what percentage of the target number has been reached, such as 90%, 100%, or 150%. Additional transactions are not blocked after the target number is reached. Set this value to a positive integer value or 0 to disable notifications for an app developer. Note: This property is valid for adjustable notification rate plans only. " }, "ratePlan": { "properties": { "id": { "type": "string", "description": "ID of the rate plan to accept." } } }, "startDate": { "type": "string", "description": "Date when the rate plan starts in UTC. Use the following format: YYYY-MM-DD HH:mm:ss. If you do not specify a timestamp (not recommended), 00:00:00 (midnight) is used by default. " }, "suppressWarning": { "type": "boolean", "description": "Flag that specifies whether to suppress the error if the developer attempts to accept a rate plan that overlaps another accepted rate plan. If set to true, monetization terminates all accepted rate plans that the developer has to API packages that contain the conflicting API products. It then accepts a new API package for the developer." }, "waveTerminationCharge": { "type": "boolean", "description": "Flag that specifies whether termination fees are waved when an active rate plan is terminated as part of activitating a new rate plan." } }

org_name Name of your organization. true

developer_id ID of the developer. true

plan_id Rate plan ID. 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?)