Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. RatePlan

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.RatePlan

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

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.

Create RatePlan Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new RatePlan(name: string, args: RatePlanArgs, opts?: CustomResourceOptions);
@overload
def RatePlan(resource_name: str,
             args: RatePlanArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def RatePlan(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             organization_id: Optional[str] = None,
             apiproduct_id: Optional[str] = None,
             end_time: Optional[str] = None,
             fixed_fee_frequency: Optional[int] = None,
             consumption_pricing_type: Optional[RatePlanConsumptionPricingType] = None,
             currency_code: Optional[str] = None,
             description: Optional[str] = None,
             display_name: Optional[str] = None,
             apiproduct: Optional[str] = None,
             consumption_pricing_rates: Optional[Sequence[GoogleCloudApigeeV1RateRangeArgs]] = None,
             fixed_recurring_fee: Optional[GoogleTypeMoneyArgs] = None,
             billing_period: Optional[RatePlanBillingPeriod] = None,
             payment_funding_model: Optional[RatePlanPaymentFundingModel] = None,
             revenue_share_rates: Optional[Sequence[GoogleCloudApigeeV1RevenueShareRangeArgs]] = None,
             revenue_share_type: Optional[RatePlanRevenueShareType] = None,
             setup_fee: Optional[GoogleTypeMoneyArgs] = None,
             start_time: Optional[str] = None,
             state: Optional[RatePlanState] = None)
func NewRatePlan(ctx *Context, name string, args RatePlanArgs, opts ...ResourceOption) (*RatePlan, error)
public RatePlan(string name, RatePlanArgs args, CustomResourceOptions? opts = null)
public RatePlan(String name, RatePlanArgs args)
public RatePlan(String name, RatePlanArgs args, CustomResourceOptions options)

type: google-native:apigee/v1:RatePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RatePlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RatePlanArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RatePlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RatePlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RatePlanArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var ratePlanResource = new GoogleNative.Apigee.V1.RatePlan("ratePlanResource", new()
{
    OrganizationId = "string",
    ApiproductId = "string",
    EndTime = "string",
    FixedFeeFrequency = 0,
    ConsumptionPricingType = GoogleNative.Apigee.V1.RatePlanConsumptionPricingType.ConsumptionPricingTypeUnspecified,
    CurrencyCode = "string",
    Description = "string",
    DisplayName = "string",
    Apiproduct = "string",
    ConsumptionPricingRates = new[]
    {
        new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1RateRangeArgs
        {
            End = "string",
            Fee = new GoogleNative.Apigee.V1.Inputs.GoogleTypeMoneyArgs
            {
                CurrencyCode = "string",
                Nanos = 0,
                Units = "string",
            },
            Start = "string",
        },
    },
    FixedRecurringFee = new GoogleNative.Apigee.V1.Inputs.GoogleTypeMoneyArgs
    {
        CurrencyCode = "string",
        Nanos = 0,
        Units = "string",
    },
    BillingPeriod = GoogleNative.Apigee.V1.RatePlanBillingPeriod.BillingPeriodUnspecified,
    RevenueShareRates = new[]
    {
        new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1RevenueShareRangeArgs
        {
            End = "string",
            SharePercentage = 0,
            Start = "string",
        },
    },
    RevenueShareType = GoogleNative.Apigee.V1.RatePlanRevenueShareType.RevenueShareTypeUnspecified,
    SetupFee = new GoogleNative.Apigee.V1.Inputs.GoogleTypeMoneyArgs
    {
        CurrencyCode = "string",
        Nanos = 0,
        Units = "string",
    },
    StartTime = "string",
    State = GoogleNative.Apigee.V1.RatePlanState.StateUnspecified,
});
Copy
example, err := apigee.NewRatePlan(ctx, "ratePlanResource", &apigee.RatePlanArgs{
	OrganizationId:         pulumi.String("string"),
	ApiproductId:           pulumi.String("string"),
	EndTime:                pulumi.String("string"),
	FixedFeeFrequency:      pulumi.Int(0),
	ConsumptionPricingType: apigee.RatePlanConsumptionPricingTypeConsumptionPricingTypeUnspecified,
	CurrencyCode:           pulumi.String("string"),
	Description:            pulumi.String("string"),
	DisplayName:            pulumi.String("string"),
	Apiproduct:             pulumi.String("string"),
	ConsumptionPricingRates: apigee.GoogleCloudApigeeV1RateRangeArray{
		&apigee.GoogleCloudApigeeV1RateRangeArgs{
			End: pulumi.String("string"),
			Fee: &apigee.GoogleTypeMoneyArgs{
				CurrencyCode: pulumi.String("string"),
				Nanos:        pulumi.Int(0),
				Units:        pulumi.String("string"),
			},
			Start: pulumi.String("string"),
		},
	},
	FixedRecurringFee: &apigee.GoogleTypeMoneyArgs{
		CurrencyCode: pulumi.String("string"),
		Nanos:        pulumi.Int(0),
		Units:        pulumi.String("string"),
	},
	BillingPeriod: apigee.RatePlanBillingPeriodBillingPeriodUnspecified,
	RevenueShareRates: apigee.GoogleCloudApigeeV1RevenueShareRangeArray{
		&apigee.GoogleCloudApigeeV1RevenueShareRangeArgs{
			End:             pulumi.String("string"),
			SharePercentage: pulumi.Float64(0),
			Start:           pulumi.String("string"),
		},
	},
	RevenueShareType: apigee.RatePlanRevenueShareTypeRevenueShareTypeUnspecified,
	SetupFee: &apigee.GoogleTypeMoneyArgs{
		CurrencyCode: pulumi.String("string"),
		Nanos:        pulumi.Int(0),
		Units:        pulumi.String("string"),
	},
	StartTime: pulumi.String("string"),
	State:     apigee.RatePlanStateStateUnspecified,
})
Copy
var ratePlanResource = new RatePlan("ratePlanResource", RatePlanArgs.builder()
    .organizationId("string")
    .apiproductId("string")
    .endTime("string")
    .fixedFeeFrequency(0)
    .consumptionPricingType("CONSUMPTION_PRICING_TYPE_UNSPECIFIED")
    .currencyCode("string")
    .description("string")
    .displayName("string")
    .apiproduct("string")
    .consumptionPricingRates(GoogleCloudApigeeV1RateRangeArgs.builder()
        .end("string")
        .fee(GoogleTypeMoneyArgs.builder()
            .currencyCode("string")
            .nanos(0)
            .units("string")
            .build())
        .start("string")
        .build())
    .fixedRecurringFee(GoogleTypeMoneyArgs.builder()
        .currencyCode("string")
        .nanos(0)
        .units("string")
        .build())
    .billingPeriod("BILLING_PERIOD_UNSPECIFIED")
    .revenueShareRates(GoogleCloudApigeeV1RevenueShareRangeArgs.builder()
        .end("string")
        .sharePercentage(0)
        .start("string")
        .build())
    .revenueShareType("REVENUE_SHARE_TYPE_UNSPECIFIED")
    .setupFee(GoogleTypeMoneyArgs.builder()
        .currencyCode("string")
        .nanos(0)
        .units("string")
        .build())
    .startTime("string")
    .state("STATE_UNSPECIFIED")
    .build());
Copy
rate_plan_resource = google_native.apigee.v1.RatePlan("ratePlanResource",
    organization_id="string",
    apiproduct_id="string",
    end_time="string",
    fixed_fee_frequency=0,
    consumption_pricing_type=google_native.apigee.v1.RatePlanConsumptionPricingType.CONSUMPTION_PRICING_TYPE_UNSPECIFIED,
    currency_code="string",
    description="string",
    display_name="string",
    apiproduct="string",
    consumption_pricing_rates=[{
        "end": "string",
        "fee": {
            "currency_code": "string",
            "nanos": 0,
            "units": "string",
        },
        "start": "string",
    }],
    fixed_recurring_fee={
        "currency_code": "string",
        "nanos": 0,
        "units": "string",
    },
    billing_period=google_native.apigee.v1.RatePlanBillingPeriod.BILLING_PERIOD_UNSPECIFIED,
    revenue_share_rates=[{
        "end": "string",
        "share_percentage": 0,
        "start": "string",
    }],
    revenue_share_type=google_native.apigee.v1.RatePlanRevenueShareType.REVENUE_SHARE_TYPE_UNSPECIFIED,
    setup_fee={
        "currency_code": "string",
        "nanos": 0,
        "units": "string",
    },
    start_time="string",
    state=google_native.apigee.v1.RatePlanState.STATE_UNSPECIFIED)
Copy
const ratePlanResource = new google_native.apigee.v1.RatePlan("ratePlanResource", {
    organizationId: "string",
    apiproductId: "string",
    endTime: "string",
    fixedFeeFrequency: 0,
    consumptionPricingType: google_native.apigee.v1.RatePlanConsumptionPricingType.ConsumptionPricingTypeUnspecified,
    currencyCode: "string",
    description: "string",
    displayName: "string",
    apiproduct: "string",
    consumptionPricingRates: [{
        end: "string",
        fee: {
            currencyCode: "string",
            nanos: 0,
            units: "string",
        },
        start: "string",
    }],
    fixedRecurringFee: {
        currencyCode: "string",
        nanos: 0,
        units: "string",
    },
    billingPeriod: google_native.apigee.v1.RatePlanBillingPeriod.BillingPeriodUnspecified,
    revenueShareRates: [{
        end: "string",
        sharePercentage: 0,
        start: "string",
    }],
    revenueShareType: google_native.apigee.v1.RatePlanRevenueShareType.RevenueShareTypeUnspecified,
    setupFee: {
        currencyCode: "string",
        nanos: 0,
        units: "string",
    },
    startTime: "string",
    state: google_native.apigee.v1.RatePlanState.StateUnspecified,
});
Copy
type: google-native:apigee/v1:RatePlan
properties:
    apiproduct: string
    apiproductId: string
    billingPeriod: BILLING_PERIOD_UNSPECIFIED
    consumptionPricingRates:
        - end: string
          fee:
            currencyCode: string
            nanos: 0
            units: string
          start: string
    consumptionPricingType: CONSUMPTION_PRICING_TYPE_UNSPECIFIED
    currencyCode: string
    description: string
    displayName: string
    endTime: string
    fixedFeeFrequency: 0
    fixedRecurringFee:
        currencyCode: string
        nanos: 0
        units: string
    organizationId: string
    revenueShareRates:
        - end: string
          sharePercentage: 0
          start: string
    revenueShareType: REVENUE_SHARE_TYPE_UNSPECIFIED
    setupFee:
        currencyCode: string
        nanos: 0
        units: string
    startTime: string
    state: STATE_UNSPECIFIED
Copy

RatePlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The RatePlan resource accepts the following input properties:

ApiproductId
This property is required.
Changes to this property will trigger replacement.
string
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
Apiproduct string
Name of the API product that the rate plan is associated with.
BillingPeriod Pulumi.GoogleNative.Apigee.V1.RatePlanBillingPeriod
Frequency at which the customer will be billed.
ConsumptionPricingRates List<Pulumi.GoogleNative.Apigee.V1.Inputs.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.
ConsumptionPricingType Pulumi.GoogleNative.Apigee.V1.RatePlanConsumptionPricingType
Pricing model used for consumption-based charges.
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.Inputs.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.
PaymentFundingModel Pulumi.GoogleNative.Apigee.V1.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.

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.Inputs.GoogleCloudApigeeV1RevenueShareRange>
Details of the revenue sharing model.
RevenueShareType Pulumi.GoogleNative.Apigee.V1.RatePlanRevenueShareType
Method used to calculate the revenue that is shared with developers.
SetupFee Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleTypeMoney
Initial, one-time fee paid when purchasing the API product.
StartTime string
Time when the rate plan becomes active in milliseconds since epoch.
State Pulumi.GoogleNative.Apigee.V1.RatePlanState
Current state of the rate plan (draft or published).
ApiproductId
This property is required.
Changes to this property will trigger replacement.
string
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
Apiproduct string
Name of the API product that the rate plan is associated with.
BillingPeriod RatePlanBillingPeriod
Frequency at which the customer will be billed.
ConsumptionPricingRates []GoogleCloudApigeeV1RateRangeArgs
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 RatePlanConsumptionPricingType
Pricing model used for consumption-based charges.
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 GoogleTypeMoneyArgs
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.
PaymentFundingModel 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.

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 []GoogleCloudApigeeV1RevenueShareRangeArgs
Details of the revenue sharing model.
RevenueShareType RatePlanRevenueShareType
Method used to calculate the revenue that is shared with developers.
SetupFee GoogleTypeMoneyArgs
Initial, one-time fee paid when purchasing the API product.
StartTime string
Time when the rate plan becomes active in milliseconds since epoch.
State RatePlanStateEnum
Current state of the rate plan (draft or published).
apiproductId
This property is required.
Changes to this property will trigger replacement.
String
organizationId
This property is required.
Changes to this property will trigger replacement.
String
apiproduct String
Name of the API product that the rate plan is associated with.
billingPeriod RatePlanBillingPeriod
Frequency at which the customer will be billed.
consumptionPricingRates 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.
consumptionPricingType RatePlanConsumptionPricingType
Pricing model used for consumption-based charges.
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 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.
paymentFundingModel 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.

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<GoogleCloudApigeeV1RevenueShareRange>
Details of the revenue sharing model.
revenueShareType RatePlanRevenueShareType
Method used to calculate the revenue that is shared with developers.
setupFee GoogleTypeMoney
Initial, one-time fee paid when purchasing the API product.
startTime String
Time when the rate plan becomes active in milliseconds since epoch.
state RatePlanState
Current state of the rate plan (draft or published).
apiproductId
This property is required.
Changes to this property will trigger replacement.
string
organizationId
This property is required.
Changes to this property will trigger replacement.
string
apiproduct string
Name of the API product that the rate plan is associated with.
billingPeriod RatePlanBillingPeriod
Frequency at which the customer will be billed.
consumptionPricingRates 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.
consumptionPricingType RatePlanConsumptionPricingType
Pricing model used for consumption-based charges.
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 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.
paymentFundingModel 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.

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 GoogleCloudApigeeV1RevenueShareRange[]
Details of the revenue sharing model.
revenueShareType RatePlanRevenueShareType
Method used to calculate the revenue that is shared with developers.
setupFee GoogleTypeMoney
Initial, one-time fee paid when purchasing the API product.
startTime string
Time when the rate plan becomes active in milliseconds since epoch.
state RatePlanState
Current state of the rate plan (draft or published).
apiproduct_id
This property is required.
Changes to this property will trigger replacement.
str
organization_id
This property is required.
Changes to this property will trigger replacement.
str
apiproduct str
Name of the API product that the rate plan is associated with.
billing_period RatePlanBillingPeriod
Frequency at which the customer will be billed.
consumption_pricing_rates Sequence[GoogleCloudApigeeV1RateRangeArgs]
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 RatePlanConsumptionPricingType
Pricing model used for consumption-based charges.
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 GoogleTypeMoneyArgs
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.
payment_funding_model 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.

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[GoogleCloudApigeeV1RevenueShareRangeArgs]
Details of the revenue sharing model.
revenue_share_type RatePlanRevenueShareType
Method used to calculate the revenue that is shared with developers.
setup_fee GoogleTypeMoneyArgs
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 RatePlanState
Current state of the rate plan (draft or published).
apiproductId
This property is required.
Changes to this property will trigger replacement.
String
organizationId
This property is required.
Changes to this property will trigger replacement.
String
apiproduct String
Name of the API product that the rate plan is associated with.
billingPeriod "BILLING_PERIOD_UNSPECIFIED" | "WEEKLY" | "MONTHLY"
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 "CONSUMPTION_PRICING_TYPE_UNSPECIFIED" | "FIXED_PER_UNIT" | "BANDED" | "TIERED" | "STAIRSTEP"
Pricing model used for consumption-based charges.
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.
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.

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 "REVENUE_SHARE_TYPE_UNSPECIFIED" | "FIXED" | "VOLUME_BANDED"
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 "STATE_UNSPECIFIED" | "DRAFT" | "PUBLISHED"
Current state of the rate plan (draft or published).

Outputs

All input properties are implicitly available as output properties. Additionally, the RatePlan resource produces the following output properties:

CreatedAt string
Time that the rate plan was created in milliseconds since epoch.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedAt string
Time the rate plan was last modified in milliseconds since epoch.
Name string
Name of the rate plan.
CreatedAt string
Time that the rate plan was created in milliseconds since epoch.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedAt string
Time the rate plan was last modified in milliseconds since epoch.
Name string
Name of the rate plan.
createdAt String
Time that the rate plan was created in milliseconds since epoch.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedAt String
Time the rate plan was last modified in milliseconds since epoch.
name String
Name of the rate plan.
createdAt string
Time that the rate plan was created in milliseconds since epoch.
id string
The provider-assigned unique ID for this managed resource.
lastModifiedAt string
Time the rate plan was last modified in milliseconds since epoch.
name string
Name of the rate plan.
created_at str
Time that the rate plan was created in milliseconds since epoch.
id str
The provider-assigned unique ID for this managed resource.
last_modified_at str
Time the rate plan was last modified in milliseconds since epoch.
name str
Name of the rate plan.
createdAt String
Time that the rate plan was created in milliseconds since epoch.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedAt String
Time the rate plan was last modified in milliseconds since epoch.
name String
Name of the rate plan.

Supporting Types

GoogleCloudApigeeV1RateRange
, GoogleCloudApigeeV1RateRangeArgs

End string
Ending value of the range. Set to 0 or null for the last range of values.
Fee Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleTypeMoney
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 GoogleTypeMoney
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 GoogleTypeMoney
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 GoogleTypeMoney
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 GoogleTypeMoney
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.

GoogleCloudApigeeV1RateRangeResponse
, GoogleCloudApigeeV1RateRangeResponseArgs

End This property is required. string
Ending value of the range. Set to 0 or null for the last range of values.
Fee This property is required. Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleTypeMoneyResponse
Fee to charge when total number of API calls falls within this range.
Start This property is required. string
Starting value of the range. Set to 0 or null for the initial range of values.
End This property is required. string
Ending value of the range. Set to 0 or null for the last range of values.
Fee This property is required. GoogleTypeMoneyResponse
Fee to charge when total number of API calls falls within this range.
Start This property is required. string
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. String
Ending value of the range. Set to 0 or null for the last range of values.
fee This property is required. GoogleTypeMoneyResponse
Fee to charge when total number of API calls falls within this range.
start This property is required. String
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. string
Ending value of the range. Set to 0 or null for the last range of values.
fee This property is required. GoogleTypeMoneyResponse
Fee to charge when total number of API calls falls within this range.
start This property is required. string
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. str
Ending value of the range. Set to 0 or null for the last range of values.
fee This property is required. GoogleTypeMoneyResponse
Fee to charge when total number of API calls falls within this range.
start This property is required. str
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. String
Ending value of the range. Set to 0 or null for the last range of values.
fee This property is required. Property Map
Fee to charge when total number of API calls falls within this range.
start This property is required. String
Starting value of the range. Set to 0 or null for the initial range of values.

GoogleCloudApigeeV1RevenueShareRange
, GoogleCloudApigeeV1RevenueShareRangeArgs

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.

GoogleCloudApigeeV1RevenueShareRangeResponse
, GoogleCloudApigeeV1RevenueShareRangeResponseArgs

End This property is required. string
Ending value of the range. Set to 0 or null for the last range of values.
SharePercentage This property is required. 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 This property is required. string
Starting value of the range. Set to 0 or null for the initial range of values.
End This property is required. string
Ending value of the range. Set to 0 or null for the last range of values.
SharePercentage This property is required. 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 This property is required. string
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. String
Ending value of the range. Set to 0 or null for the last range of values.
sharePercentage This property is required. 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 This property is required. String
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. string
Ending value of the range. Set to 0 or null for the last range of values.
sharePercentage This property is required. 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 This property is required. string
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. str
Ending value of the range. Set to 0 or null for the last range of values.
share_percentage This property is required. 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 This property is required. str
Starting value of the range. Set to 0 or null for the initial range of values.
end This property is required. String
Ending value of the range. Set to 0 or null for the last range of values.
sharePercentage This property is required. 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 This property is required. String
Starting value of the range. Set to 0 or null for the initial range of values.

GoogleTypeMoney
, GoogleTypeMoneyArgs

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.

GoogleTypeMoneyResponse
, GoogleTypeMoneyResponseArgs

CurrencyCode This property is required. string
The three-letter currency code defined in ISO 4217.
Nanos This property is required. 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 This property is required. string
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
CurrencyCode This property is required. string
The three-letter currency code defined in ISO 4217.
Nanos This property is required. 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 This property is required. string
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currencyCode This property is required. String
The three-letter currency code defined in ISO 4217.
nanos This property is required. 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 This property is required. String
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currencyCode This property is required. string
The three-letter currency code defined in ISO 4217.
nanos This property is required. 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 This property is required. string
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currency_code This property is required. str
The three-letter currency code defined in ISO 4217.
nanos This property is required. 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 This property is required. str
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.
currencyCode This property is required. String
The three-letter currency code defined in ISO 4217.
nanos This property is required. 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 This property is required. String
The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

RatePlanBillingPeriod
, RatePlanBillingPeriodArgs

BillingPeriodUnspecified
BILLING_PERIOD_UNSPECIFIEDBilling period not specified.
Weekly
WEEKLYWeekly billing period. Note: Not supported by Apigee at this time.
Monthly
MONTHLYMonthly billing period.
RatePlanBillingPeriodBillingPeriodUnspecified
BILLING_PERIOD_UNSPECIFIEDBilling period not specified.
RatePlanBillingPeriodWeekly
WEEKLYWeekly billing period. Note: Not supported by Apigee at this time.
RatePlanBillingPeriodMonthly
MONTHLYMonthly billing period.
BillingPeriodUnspecified
BILLING_PERIOD_UNSPECIFIEDBilling period not specified.
Weekly
WEEKLYWeekly billing period. Note: Not supported by Apigee at this time.
Monthly
MONTHLYMonthly billing period.
BillingPeriodUnspecified
BILLING_PERIOD_UNSPECIFIEDBilling period not specified.
Weekly
WEEKLYWeekly billing period. Note: Not supported by Apigee at this time.
Monthly
MONTHLYMonthly billing period.
BILLING_PERIOD_UNSPECIFIED
BILLING_PERIOD_UNSPECIFIEDBilling period not specified.
WEEKLY
WEEKLYWeekly billing period. Note: Not supported by Apigee at this time.
MONTHLY
MONTHLYMonthly billing period.
"BILLING_PERIOD_UNSPECIFIED"
BILLING_PERIOD_UNSPECIFIEDBilling period not specified.
"WEEKLY"
WEEKLYWeekly billing period. Note: Not supported by Apigee at this time.
"MONTHLY"
MONTHLYMonthly billing period.

RatePlanConsumptionPricingType
, RatePlanConsumptionPricingTypeArgs

ConsumptionPricingTypeUnspecified
CONSUMPTION_PRICING_TYPE_UNSPECIFIEDPricing model not specified. This is the default.
FixedPerUnit
FIXED_PER_UNITFixed rate charged for each API call.
Banded
BANDEDVariable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. Note: Not supported by Apigee at this time.
Tiered
TIEREDNote: Not supported by Apigee at this time.
Stairstep
STAIRSTEPNote: Not supported by Apigee at this time.
RatePlanConsumptionPricingTypeConsumptionPricingTypeUnspecified
CONSUMPTION_PRICING_TYPE_UNSPECIFIEDPricing model not specified. This is the default.
RatePlanConsumptionPricingTypeFixedPerUnit
FIXED_PER_UNITFixed rate charged for each API call.
RatePlanConsumptionPricingTypeBanded
BANDEDVariable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. Note: Not supported by Apigee at this time.
RatePlanConsumptionPricingTypeTiered
TIEREDNote: Not supported by Apigee at this time.
RatePlanConsumptionPricingTypeStairstep
STAIRSTEPNote: Not supported by Apigee at this time.
ConsumptionPricingTypeUnspecified
CONSUMPTION_PRICING_TYPE_UNSPECIFIEDPricing model not specified. This is the default.
FixedPerUnit
FIXED_PER_UNITFixed rate charged for each API call.
Banded
BANDEDVariable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. Note: Not supported by Apigee at this time.
Tiered
TIEREDNote: Not supported by Apigee at this time.
Stairstep
STAIRSTEPNote: Not supported by Apigee at this time.
ConsumptionPricingTypeUnspecified
CONSUMPTION_PRICING_TYPE_UNSPECIFIEDPricing model not specified. This is the default.
FixedPerUnit
FIXED_PER_UNITFixed rate charged for each API call.
Banded
BANDEDVariable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. Note: Not supported by Apigee at this time.
Tiered
TIEREDNote: Not supported by Apigee at this time.
Stairstep
STAIRSTEPNote: Not supported by Apigee at this time.
CONSUMPTION_PRICING_TYPE_UNSPECIFIED
CONSUMPTION_PRICING_TYPE_UNSPECIFIEDPricing model not specified. This is the default.
FIXED_PER_UNIT
FIXED_PER_UNITFixed rate charged for each API call.
BANDED
BANDEDVariable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. Note: Not supported by Apigee at this time.
TIERED
TIEREDNote: Not supported by Apigee at this time.
STAIRSTEP
STAIRSTEPNote: Not supported by Apigee at this time.
"CONSUMPTION_PRICING_TYPE_UNSPECIFIED"
CONSUMPTION_PRICING_TYPE_UNSPECIFIEDPricing model not specified. This is the default.
"FIXED_PER_UNIT"
FIXED_PER_UNITFixed rate charged for each API call.
"BANDED"
BANDEDVariable rate charged for each API call based on price tiers. Example: * 1-100 calls cost $2 per call * 101-200 calls cost $1.50 per call * 201-300 calls cost $1 per call * Total price for 50 calls: 50 x $2 = $100 * Total price for 150 calls: 100 x $2 + 50 x $1.5 = $275 * Total price for 250 calls: 100 x $2 + 100 x $1.5 + 50 x $1 = $400. Note: Not supported by Apigee at this time.
"TIERED"
TIEREDNote: Not supported by Apigee at this time.
"STAIRSTEP"
STAIRSTEPNote: Not supported by Apigee at this time.

RatePlanPaymentFundingModel
, RatePlanPaymentFundingModelArgs

PaymentFundingModelUnspecified
PAYMENT_FUNDING_MODEL_UNSPECIFIEDBilling account type not specified.
Prepaid
PREPAIDPrepaid billing account type. Developer pays in advance for the use of your API products. Funds are deducted from their prepaid account balance. Note: Not supported by Apigee at this time.
Postpaid
POSTPAIDPostpaid billing account type. Developer is billed through an invoice after using your API products.
RatePlanPaymentFundingModelPaymentFundingModelUnspecified
PAYMENT_FUNDING_MODEL_UNSPECIFIEDBilling account type not specified.
RatePlanPaymentFundingModelPrepaid
PREPAIDPrepaid billing account type. Developer pays in advance for the use of your API products. Funds are deducted from their prepaid account balance. Note: Not supported by Apigee at this time.
RatePlanPaymentFundingModelPostpaid
POSTPAIDPostpaid billing account type. Developer is billed through an invoice after using your API products.
PaymentFundingModelUnspecified
PAYMENT_FUNDING_MODEL_UNSPECIFIEDBilling account type not specified.
Prepaid
PREPAIDPrepaid billing account type. Developer pays in advance for the use of your API products. Funds are deducted from their prepaid account balance. Note: Not supported by Apigee at this time.
Postpaid
POSTPAIDPostpaid billing account type. Developer is billed through an invoice after using your API products.
PaymentFundingModelUnspecified
PAYMENT_FUNDING_MODEL_UNSPECIFIEDBilling account type not specified.
Prepaid
PREPAIDPrepaid billing account type. Developer pays in advance for the use of your API products. Funds are deducted from their prepaid account balance. Note: Not supported by Apigee at this time.
Postpaid
POSTPAIDPostpaid billing account type. Developer is billed through an invoice after using your API products.
PAYMENT_FUNDING_MODEL_UNSPECIFIED
PAYMENT_FUNDING_MODEL_UNSPECIFIEDBilling account type not specified.
PREPAID
PREPAIDPrepaid billing account type. Developer pays in advance for the use of your API products. Funds are deducted from their prepaid account balance. Note: Not supported by Apigee at this time.
POSTPAID
POSTPAIDPostpaid billing account type. Developer is billed through an invoice after using your API products.
"PAYMENT_FUNDING_MODEL_UNSPECIFIED"
PAYMENT_FUNDING_MODEL_UNSPECIFIEDBilling account type not specified.
"PREPAID"
PREPAIDPrepaid billing account type. Developer pays in advance for the use of your API products. Funds are deducted from their prepaid account balance. Note: Not supported by Apigee at this time.
"POSTPAID"
POSTPAIDPostpaid billing account type. Developer is billed through an invoice after using your API products.

RatePlanRevenueShareType
, RatePlanRevenueShareTypeArgs

RevenueShareTypeUnspecified
REVENUE_SHARE_TYPE_UNSPECIFIEDRevenue share type is not specified.
Fixed
FIXEDFixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
VolumeBanded
VOLUME_BANDEDAmount of revenue shared depends on the number of API calls. The API call volume ranges and the revenue share percentage for each volume can be configured by the API provider. Note: Not supported by Apigee at this time.
RatePlanRevenueShareTypeRevenueShareTypeUnspecified
REVENUE_SHARE_TYPE_UNSPECIFIEDRevenue share type is not specified.
RatePlanRevenueShareTypeFixed
FIXEDFixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
RatePlanRevenueShareTypeVolumeBanded
VOLUME_BANDEDAmount of revenue shared depends on the number of API calls. The API call volume ranges and the revenue share percentage for each volume can be configured by the API provider. Note: Not supported by Apigee at this time.
RevenueShareTypeUnspecified
REVENUE_SHARE_TYPE_UNSPECIFIEDRevenue share type is not specified.
Fixed
FIXEDFixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
VolumeBanded
VOLUME_BANDEDAmount of revenue shared depends on the number of API calls. The API call volume ranges and the revenue share percentage for each volume can be configured by the API provider. Note: Not supported by Apigee at this time.
RevenueShareTypeUnspecified
REVENUE_SHARE_TYPE_UNSPECIFIEDRevenue share type is not specified.
Fixed
FIXEDFixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
VolumeBanded
VOLUME_BANDEDAmount of revenue shared depends on the number of API calls. The API call volume ranges and the revenue share percentage for each volume can be configured by the API provider. Note: Not supported by Apigee at this time.
REVENUE_SHARE_TYPE_UNSPECIFIED
REVENUE_SHARE_TYPE_UNSPECIFIEDRevenue share type is not specified.
FIXED
FIXEDFixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
VOLUME_BANDED
VOLUME_BANDEDAmount of revenue shared depends on the number of API calls. The API call volume ranges and the revenue share percentage for each volume can be configured by the API provider. Note: Not supported by Apigee at this time.
"REVENUE_SHARE_TYPE_UNSPECIFIED"
REVENUE_SHARE_TYPE_UNSPECIFIEDRevenue share type is not specified.
"FIXED"
FIXEDFixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
"VOLUME_BANDED"
VOLUME_BANDEDAmount of revenue shared depends on the number of API calls. The API call volume ranges and the revenue share percentage for each volume can be configured by the API provider. Note: Not supported by Apigee at this time.

RatePlanState
, RatePlanStateArgs

StateUnspecified
STATE_UNSPECIFIEDState of the rate plan is not specified.
Draft
DRAFTRate plan is in draft mode and only visible to API providers.
Published
PUBLISHEDRate plan is published and will become visible to developers for the configured duration (between startTime and endTime).
RatePlanStateStateUnspecified
STATE_UNSPECIFIEDState of the rate plan is not specified.
RatePlanStateDraft
DRAFTRate plan is in draft mode and only visible to API providers.
RatePlanStatePublished
PUBLISHEDRate plan is published and will become visible to developers for the configured duration (between startTime and endTime).
StateUnspecified
STATE_UNSPECIFIEDState of the rate plan is not specified.
Draft
DRAFTRate plan is in draft mode and only visible to API providers.
Published
PUBLISHEDRate plan is published and will become visible to developers for the configured duration (between startTime and endTime).
StateUnspecified
STATE_UNSPECIFIEDState of the rate plan is not specified.
Draft
DRAFTRate plan is in draft mode and only visible to API providers.
Published
PUBLISHEDRate plan is published and will become visible to developers for the configured duration (between startTime and endTime).
STATE_UNSPECIFIED
STATE_UNSPECIFIEDState of the rate plan is not specified.
DRAFT
DRAFTRate plan is in draft mode and only visible to API providers.
PUBLISHED
PUBLISHEDRate plan is published and will become visible to developers for the configured duration (between startTime and endTime).
"STATE_UNSPECIFIED"
STATE_UNSPECIFIEDState of the rate plan is not specified.
"DRAFT"
DRAFTRate plan is in draft mode and only visible to API providers.
"PUBLISHED"
PUBLISHEDRate plan is published and will become visible to developers for the configured duration (between startTime and endTime).

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