Method: organizations.apiproducts.rateplans.create

Create a rate plan that is associated with an API product in an organization.

Using rate plans, API product owners can monetize their API products by configuring one or more of the following: - Billing frequency - Initial setup fees for using an API product - Payment funding model (postpaid only) - Fixed recurring or consumption-based charges for using an API product - Revenue sharing with developer partners

An API product can have multiple rate plans associated with it but only one rate plan can be active at any point of time.

**Note: From the developer's perspective, they purchase API products not rate plans.

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*/apiproducts/*}/rateplans

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.rateplans.create

Request body

The request body contains an instance of RatePlan.

Response body

If successful, the response body contains a newly created instance of RatePlan.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform