rateplans

Overview

Name	rateplans
Type	Resource
Id	google.apigee.rateplans

Fields

Name	Datatype	Description
name	string	Output only. Name of the rate plan.
description	string	Description of the rate plan.
apiproduct	string	Name of the API product that the rate plan is associated with.
billingPeriod	string	Frequency at which the customer will be billed.
consumptionPricingRates	array	API call volume ranges and the fees charged when the total number of API calls is within a given range. The method used to calculate the final fee depends on the selected pricing model. For example, if the pricing model is STAIRSTEP and the ranges are defined as follows: { "start": 1, "end": 100, "fee": 75 }, { "start": 101, "end": 200, "fee": 100 }, } Then the following fees would be charged based on the total number of API calls (assuming the currency selected is USD): 1 call costs $75 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.
consumptionPricingType	string	Pricing model used for consumption-based charges.
createdAt	string	Output only. Time that the rate plan was created in milliseconds since epoch.
currencyCode	string	Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard.
displayName	string	Display name of the rate plan.
endTime	string	Time when the rate plan will expire in milliseconds since epoch. Set to 0 or null to indicate that the rate plan should never expire.
fixedFeeFrequency	integer	Frequency at which the fixed fee is charged.
fixedRecurringFee	object	Represents an amount of money with its currency type.
lastModifiedAt	string	Output only. Time the rate plan was last modified in milliseconds since epoch.
paymentFundingModel	string	DEPRECATED: This field is no longer supported and will eventually be removed when Apigee Hybrid 1.5/1.6 is no longer supported. Instead, use the billingType field inside DeveloperMonetizationConfig resource. Flag that specifies the billing account type, prepaid or postpaid.
revenueShareRates	array	Details of the revenue sharing model.
revenueShareType	string	Method used to calculate the revenue that is shared with developers.
setupFee	object	Represents an amount of money with its currency type.
startTime	string	Time when the rate plan becomes active in milliseconds since epoch.
state	string	Current state of the rate plan (draft or published).

Methods

Name	Accessible by	Required Params	Description
organizations_apiproducts_rateplans_get	SELECT	apiproductsId, organizationsId, rateplansId	Gets the details of a rate plan.
organizations_apiproducts_rateplans_list	SELECT	apiproductsId, organizationsId	Lists all the rate plans for an API product.
organizations_apiproducts_rateplans_create	INSERT	apiproductsId, organizationsId	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.
organizations_apiproducts_rateplans_delete	DELETE	apiproductsId, organizationsId, rateplansId	Deletes a rate plan.
organizations_apiproducts_rateplans_update	EXEC	apiproductsId, organizationsId, rateplansId	Updates an existing rate plan.