RatePlan

class RatePlan : KotlinCustomResource

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. Auto-naming is currently not supported for this resource.

Properties

Link copied to clipboard
val apiproduct: Output<String>

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

Link copied to clipboard
val apiproductId: Output<String>
Link copied to clipboard
val billingPeriod: Output<String>

Frequency at which the customer will be billed.

Link copied to clipboard

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.

Link copied to clipboard

Pricing model used for consumption-based charges.

Link copied to clipboard
val createdAt: Output<String>

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

Link copied to clipboard
val currencyCode: Output<String>

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

Link copied to clipboard
val description: Output<String>

Description of the rate plan.

Link copied to clipboard
val displayName: Output<String>

Display name of the rate plan.

Link copied to clipboard
val endTime: Output<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.

Link copied to clipboard
val fixedFeeFrequency: Output<Int>

Frequency at which the fixed fee is charged.

Link copied to clipboard

Fixed amount that is charged at a defined interval and billed in advance of use of the API product. The fee will be prorated for the first billing period.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val lastModifiedAt: Output<String>

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

Link copied to clipboard
val name: Output<String>

Name of the rate plan.

Link copied to clipboard
val organizationId: Output<String>
Link copied to clipboard

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.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Details of the revenue sharing model.

Link copied to clipboard

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

Link copied to clipboard

Initial, one-time fee paid when purchasing the API product.

Link copied to clipboard
val startTime: Output<String>

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

Link copied to clipboard
val state: Output<String>

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

Link copied to clipboard
val urn: Output<String>