Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

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.

post/v1/{+parent}/rateplans

Path parameters

parentstring required

Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct} If the API Product resource has the space attribute set, IAM permissions are checked against the Space resource path. To learn more, read the Apigee Spaces Overview.

Request body

state'STATE_UNSPECIFIED' | 'DRAFT' | 'PUBLISHED'

Current state of the rate plan (draft or published).

descriptionstring

Description of the rate plan.

currencyCodestring

Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard.

fixedFeeFrequencyinteger

Frequency at which the fixed fee is charged.

createdAtstring int64

Output only. Time that the rate plan was created in milliseconds since epoch.

lastModifiedAtstring int64

Output only. Time the rate plan was last modified in milliseconds since epoch.

billingPeriod'BILLING_PERIOD_UNSPECIFIED' | 'WEEKLY' | 'MONTHLY'

Frequency at which the customer will be billed.

namestring

Output only. Name of the rate plan.

apiproductstring

Name of the API product that the rate plan is associated with.

endTimestring int64

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.

startTimestring int64

Time when the rate plan becomes active in milliseconds since epoch.

displayNamestring

Display name of the rate plan.

revenueShareType'REVENUE_SHARE_TYPE_UNSPECIFIED' | 'FIXED' | 'VOLUME_BANDED'

Method used to calculate the revenue that is shared with developers.

consumptionPricingType'CONSUMPTION_PRICING_TYPE_UNSPECIFIED' | 'FIXED_PER_UNIT' | 'BANDED' | 'TIERED' | 'STAIRSTEP'

Pricing model used for consumption-based charges.

paymentFundingModel'PAYMENT_FUNDING_MODEL_UNSPECIFIED' | 'PREPAID' | 'POSTPAID'

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.

Response

Successful response