RatePlanArgs class

The set of arguments for RatePlan. The set of arguments for RatePlan.

Constructors

RatePlanArgs({Input<String>? apiproduct, required Input<String> apiproductId, Input<RatePlanBillingPeriod>? billingPeriod, Input<List<GoogleCloudApigeeV1RateRange>>? consumptionPricingRates, Input<RatePlanConsumptionPricingType>? consumptionPricingType, Input<String>? currencyCode, Input<String>? description, Input<String>? displayName, Input<String>? endTime, Input<int>? fixedFeeFrequency, Input<GoogleTypeMoney>? fixedRecurringFee, required Input<String> organizationId, Input<RatePlanPaymentFundingModel>? paymentFundingModel, Input<List<GoogleCloudApigeeV1RevenueShareRange>>? revenueShareRates, Input<RatePlanRevenueShareType>? revenueShareType, Input<GoogleTypeMoney>? setupFee, Input<String>? startTime, Input<RatePlanState>? state})
Creates a new RatePlanArgs. apiproduct Name of the API product that the rate plan is associated with. apiproductId Required. billingPeriod Frequency at which the customer will be billed. consumptionPricingRates 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 Pricing model used for consumption-based charges. currencyCode Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard. description Description of the rate plan. displayName Display name of the rate plan. endTime 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 Frequency at which the fixed fee is charged. fixedRecurringFee 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. organizationId Required. paymentFundingModel 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 Details of the revenue sharing model. revenueShareType Method used to calculate the revenue that is shared with developers. setupFee Initial, one-time fee paid when purchasing the API product. startTime Time when the rate plan becomes active in milliseconds since epoch. state Current state of the rate plan (draft or published).
const
RatePlanArgs.fromMap(Map<String, dynamic> map)
factory

Properties

apiproduct → Input<String>?
Name of the API product that the rate plan is associated with.
final
apiproductId → Input<String>
final
billingPeriod → Input<RatePlanBillingPeriod>?
Frequency at which the customer will be billed.
final
consumptionPricingRates → Input<List<GoogleCloudApigeeV1RateRange>>?
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.
final
consumptionPricingType → Input<RatePlanConsumptionPricingType>?
Pricing model used for consumption-based charges.
final
currencyCode → Input<String>?
Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard.
final
description → Input<String>?
Description of the rate plan.
final
displayName → Input<String>?
Display name of the rate plan.
final
endTime → Input<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.
final
fixedFeeFrequency → Input<int>?
Frequency at which the fixed fee is charged.
final
fixedRecurringFee → Input<GoogleTypeMoney>?
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.
final
hashCode → int
The hash code for this object.
no setterinherited
organizationId → Input<String>
final
paymentFundingModel → Input<RatePlanPaymentFundingModel>?
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.
final
revenueShareRates → Input<List<GoogleCloudApigeeV1RevenueShareRange>>?
Details of the revenue sharing model.
final
revenueShareType → Input<RatePlanRevenueShareType>?
Method used to calculate the revenue that is shared with developers.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
setupFee → Input<GoogleTypeMoney>?
Initial, one-time fee paid when purchasing the API product.
final
startTime → Input<String>?
Time when the rate plan becomes active in milliseconds since epoch.
final
state → Input<RatePlanState>?
Current state of the rate plan (draft or published).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited