Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.apigee/v1.getRatePlan

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

Using getRatePlan

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRatePlan(args: GetRatePlanArgs, opts?: InvokeOptions): Promise<GetRatePlanResult>
function getRatePlanOutput(args: GetRatePlanOutputArgs, opts?: InvokeOptions): Output<GetRatePlanResult>

def get_rate_plan(apiproduct_id: Optional[str] = None,
                  organization_id: Optional[str] = None,
                  rateplan_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetRatePlanResult
def get_rate_plan_output(apiproduct_id: Optional[pulumi.Input[str]] = None,
                  organization_id: Optional[pulumi.Input[str]] = None,
                  rateplan_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetRatePlanResult]

func LookupRatePlan(ctx *Context, args *LookupRatePlanArgs, opts ...InvokeOption) (*LookupRatePlanResult, error)
func LookupRatePlanOutput(ctx *Context, args *LookupRatePlanOutputArgs, opts ...InvokeOption) LookupRatePlanResultOutput

> Note: This function is named LookupRatePlan in the Go SDK.

public static class GetRatePlan 
{
    public static Task<GetRatePlanResult> InvokeAsync(GetRatePlanArgs args, InvokeOptions? opts = null)
    public static Output<GetRatePlanResult> Invoke(GetRatePlanInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRatePlanResult> getRatePlan(GetRatePlanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:apigee/v1:getRatePlan
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiproductId string
OrganizationId string
RateplanId string

ApiproductId string
OrganizationId string
RateplanId string

apiproductId String
organizationId String
rateplanId String

apiproductId string
organizationId string
rateplanId string

apiproduct_id str
organization_id str
rateplan_id str

apiproductId String
organizationId String
rateplanId String

getRatePlan Result

The following output properties are available:

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 List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1RateRangeResponse>: 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: 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.
Description string: Description of the rate plan.
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 int: Frequency at which the fixed fee is charged.
FixedRecurringFee Pulumi.GoogleNative.Apigee.V1.Outputs.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.
LastModifiedAt string: Time the rate plan was last modified in milliseconds since epoch.
Name string: Name of the rate plan.
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.
Deprecated: 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 List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1RevenueShareRangeResponse>: Details of the revenue sharing model.
RevenueShareType string: Method used to calculate the revenue that is shared with developers.
SetupFee Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleTypeMoneyResponse: Initial, one-time fee paid when purchasing the API product.
StartTime string: Time when the rate plan becomes active in milliseconds since epoch.
State string: Current state of the rate plan (draft or published).

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 []GoogleCloudApigeeV1RateRangeResponse: 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: 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.
Description string: Description of the rate plan.
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 int: Frequency at which the fixed fee is charged.
FixedRecurringFee 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.
LastModifiedAt string: Time the rate plan was last modified in milliseconds since epoch.
Name string: Name of the rate plan.
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.
Deprecated: 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 []GoogleCloudApigeeV1RevenueShareRangeResponse: Details of the revenue sharing model.
RevenueShareType string: Method used to calculate the revenue that is shared with developers.
SetupFee GoogleTypeMoneyResponse: Initial, one-time fee paid when purchasing the API product.
StartTime string: Time when the rate plan becomes active in milliseconds since epoch.
State string: Current state of the rate plan (draft or published).

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 List<GoogleCloudApigeeV1RateRangeResponse>: 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: 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.
description String: Description of the rate plan.
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 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.
lastModifiedAt String: Time the rate plan was last modified in milliseconds since epoch.
name String: Name of the rate plan.
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.
Deprecated: 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 List<GoogleCloudApigeeV1RevenueShareRangeResponse>: Details of the revenue sharing model.
revenueShareType String: Method used to calculate the revenue that is shared with developers.
setupFee GoogleTypeMoneyResponse: Initial, one-time fee paid when purchasing the API product.
startTime String: Time when the rate plan becomes active in milliseconds since epoch.
state String: Current state of the rate plan (draft or published).

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 GoogleCloudApigeeV1RateRangeResponse[]: 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: 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.
description string: Description of the rate plan.
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 number: Frequency at which the fixed fee is charged.
fixedRecurringFee 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.
lastModifiedAt string: Time the rate plan was last modified in milliseconds since epoch.
name string: Name of the rate plan.
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.
Deprecated: 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 GoogleCloudApigeeV1RevenueShareRangeResponse[]: Details of the revenue sharing model.
revenueShareType string: Method used to calculate the revenue that is shared with developers.
setupFee GoogleTypeMoneyResponse: Initial, one-time fee paid when purchasing the API product.
startTime string: Time when the rate plan becomes active in milliseconds since epoch.
state string: Current state of the rate plan (draft or published).

apiproduct str: Name of the API product that the rate plan is associated with.
billing_period str: Frequency at which the customer will be billed.
consumption_pricing_rates Sequence[GoogleCloudApigeeV1RateRangeResponse]: 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.
consumption_pricing_type str: Pricing model used for consumption-based charges.
created_at str: Time that the rate plan was created in milliseconds since epoch.
currency_code str: Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard.
description str: Description of the rate plan.
display_name str: Display name of the rate plan.
end_time str: 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.
fixed_fee_frequency int: Frequency at which the fixed fee is charged.
fixed_recurring_fee 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.
last_modified_at str: Time the rate plan was last modified in milliseconds since epoch.
name str: Name of the rate plan.
payment_funding_model str: 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.
Deprecated: 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.
revenue_share_rates Sequence[GoogleCloudApigeeV1RevenueShareRangeResponse]: Details of the revenue sharing model.
revenue_share_type str: Method used to calculate the revenue that is shared with developers.
setup_fee GoogleTypeMoneyResponse: Initial, one-time fee paid when purchasing the API product.
start_time str: Time when the rate plan becomes active in milliseconds since epoch.
state str: Current state of the rate plan (draft or published).

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 List<Property Map>: 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: 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.
description String: Description of the rate plan.
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 Number: Frequency at which the fixed fee is charged.
fixedRecurringFee Property Map: 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.
lastModifiedAt String: Time the rate plan was last modified in milliseconds since epoch.
name String: Name of the rate plan.
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.
Deprecated: 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 List<Property Map>: Details of the revenue sharing model.
revenueShareType String: Method used to calculate the revenue that is shared with developers.
setupFee Property Map: Initial, one-time fee paid when purchasing the API product.
startTime String: Time when the rate plan becomes active in milliseconds since epoch.
state String: Current state of the rate plan (draft or published).

Supporting Types

GoogleCloudApigeeV1RateRangeResponse

End string: Ending value of the range. Set to 0 or null for the last range of values.
Fee Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleTypeMoneyResponse: Fee to charge when total number of API calls falls within this range.
Start string: Starting value of the range. Set to 0 or null for the initial range of values.

End string: Ending value of the range. Set to 0 or null for the last range of values.
Fee GoogleTypeMoneyResponse: Fee to charge when total number of API calls falls within this range.
Start string: Starting value of the range. Set to 0 or null for the initial range of values.

end String: Ending value of the range. Set to 0 or null for the last range of values.
fee GoogleTypeMoneyResponse: Fee to charge when total number of API calls falls within this range.
start String: Starting value of the range. Set to 0 or null for the initial range of values.

end string: Ending value of the range. Set to 0 or null for the last range of values.
fee GoogleTypeMoneyResponse: Fee to charge when total number of API calls falls within this range.
start string: Starting value of the range. Set to 0 or null for the initial range of values.

end str: Ending value of the range. Set to 0 or null for the last range of values.
fee GoogleTypeMoneyResponse: Fee to charge when total number of API calls falls within this range.
start str: Starting value of the range. Set to 0 or null for the initial range of values.

end String: Ending value of the range. Set to 0 or null for the last range of values.
fee Property Map: Fee to charge when total number of API calls falls within this range.
start String: Starting value of the range. Set to 0 or null for the initial range of values.

GoogleCloudApigeeV1RevenueShareRangeResponse

End string: Ending value of the range. Set to 0 or null for the last range of values.
SharePercentage double: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point.
Start string: Starting value of the range. Set to 0 or null for the initial range of values.

End string: Ending value of the range. Set to 0 or null for the last range of values.
SharePercentage float64: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point.
Start string: Starting value of the range. Set to 0 or null for the initial range of values.

end String: Ending value of the range. Set to 0 or null for the last range of values.
sharePercentage Double: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point.
start String: Starting value of the range. Set to 0 or null for the initial range of values.

end string: Ending value of the range. Set to 0 or null for the last range of values.
sharePercentage number: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point.
start string: Starting value of the range. Set to 0 or null for the initial range of values.

end str: Ending value of the range. Set to 0 or null for the last range of values.
share_percentage float: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point.
start str: Starting value of the range. Set to 0 or null for the initial range of values.

end String: Ending value of the range. Set to 0 or null for the last range of values.
sharePercentage Number: Percentage of the revenue to be shared with the developer. For example, to share 21 percent of the total revenue with the developer, set this value to 21. Specify a decimal number with a maximum of two digits following the decimal point.
start String: Starting value of the range. Set to 0 or null for the initial range of values.

GoogleTypeMoneyResponse

CurrencyCode string: The three-letter currency code defined in ISO 4217.
Nanos int: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
Units string: The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

CurrencyCode string: The three-letter currency code defined in ISO 4217.
Nanos int: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
Units string: The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currencyCode String: The three-letter currency code defined in ISO 4217.
nanos Integer: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units String: The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currencyCode string: The three-letter currency code defined in ISO 4217.
nanos number: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units string: The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currency_code str: The three-letter currency code defined in ISO 4217.
nanos int: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units str: The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currencyCode String: The three-letter currency code defined in ISO 4217.
nanos Number: Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.
units String: The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.apigee/v1.getRatePlan

On this page

On this page

Using getRatePlan

getRatePlan Result

Supporting Types

GoogleCloudApigeeV1RateRangeResponse

GoogleCloudApigeeV1RevenueShareRangeResponse

GoogleTypeMoneyResponse

Package Details

On this page

On this page