RatePlan class

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.

Constructors

RatePlan(String name, {RatePlanArgs? args, CustomResourceOptions? options})

Creates a new RatePlan. name The Pulumi resource name. args Arguments used to configure this RatePlan. The set of arguments for RatePlan. options Resource options controlling this resource's behavior.

Properties

apiproduct ↔ Output<String>

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

late, final

apiproductId ↔ Output<String>

late, final

billingPeriod ↔ Output<String>

Frequency at which the customer will be billed.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

consumptionPricingRates ↔ Output<List<Map<String, dynamic>>>

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.

late, final

consumptionPricingType ↔ Output<String>

Pricing model used for consumption-based charges.

late, final

createdAt ↔ Output<String>

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

late, final

currencyCode ↔ Output<String>

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

late, final

description ↔ Output<String>

Description of the rate plan.

late, final

displayName ↔ Output<String>

Display name of the rate plan.

late, final

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.

late, final

fixedFeeFrequency ↔ Output<int>

Frequency at which the fixed fee is charged.

late, final

fixedRecurringFee ↔ Output<GoogleTypeMoneyResponse>

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

lastModifiedAt ↔ Output<String>

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

late, final

name ↔ Output<String>

Name of the rate plan.

late, final

organizationId ↔ Output<String>

late, final

paymentFundingModel ↔ Output<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.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

revenueShareRates ↔ Output<List<Map<String, dynamic>>>

Details of the revenue sharing model.

late, final

revenueShareType ↔ Output<String>

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

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setupFee ↔ Output<GoogleTypeMoneyResponse>

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

late, final

startTime ↔ Output<String>

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

late, final

state ↔ Output<String>

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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited