Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigee/v1.RatePlan
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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
new RatePlan(name: string, args: RatePlanArgs, opts?: CustomResourceOptions);
@overload
def RatePlan(resource_name: str,
opts: Optional[ResourceOptions] = None,
apiproduct: Optional[str] = None,
apiproduct_id: Optional[str] = None,
billing_period: Optional[RatePlanBillingPeriod] = None,
consumption_pricing_rates: Optional[Sequence[GoogleCloudApigeeV1RateRangeArgs]] = None,
consumption_pricing_type: Optional[RatePlanConsumptionPricingType] = None,
currency_code: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
end_time: Optional[str] = None,
fixed_fee_frequency: Optional[int] = None,
fixed_recurring_fee: Optional[GoogleTypeMoneyArgs] = None,
organization_id: Optional[str] = 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)
@overload
def RatePlan(resource_name: str,
args: RatePlanArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args RatePlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args RatePlanArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RatePlanArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RatePlanArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The RatePlan resource accepts the following input properties:
- Apiproduct
Id string - Organization
Id string - Apiproduct string
Name of the API product that the rate plan is associated with.
- Billing
Period Pulumi.Google Native. Apigee. V1. Rate Plan Billing Period Frequency at which the customer will be billed.
- Consumption
Pricing List<Pulumi.Rates Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Rate Range> 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 isUSD
): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.- Consumption
Pricing Pulumi.Type Google Native. Apigee. V1. Rate Plan Consumption Pricing Type Pricing model used for consumption-based charges.
- Currency
Code 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.
- Display
Name string Display name of the rate plan.
- End
Time 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.- Fixed
Fee intFrequency Frequency at which the fixed fee is charged.
- Fixed
Recurring Pulumi.Fee Google Native. Apigee. V1. Inputs. Google Type Money 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 Pulumi.Model Google Native. Apigee. V1. Rate Plan Payment Funding Model 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or postpaid.- List<Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Revenue Share Range> Details of the revenue sharing model.
- Pulumi.
Google Native. Apigee. V1. Rate Plan Revenue Share Type Method used to calculate the revenue that is shared with developers.
- Setup
Fee Pulumi.Google Native. Apigee. V1. Inputs. Google Type Money Initial, one-time fee paid when purchasing the API product.
- Start
Time string Time when the rate plan becomes active in milliseconds since epoch.
- State
Pulumi.
Google Native. Apigee. V1. Rate Plan State Current state of the rate plan (draft or published).
- Apiproduct
Id string - Organization
Id string - Apiproduct string
Name of the API product that the rate plan is associated with.
- Billing
Period RatePlan Billing Period Frequency at which the customer will be billed.
- Consumption
Pricing []GoogleRates Cloud Apigee V1Rate Range Args 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 isUSD
): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.- Consumption
Pricing RateType Plan Consumption Pricing Type Pricing model used for consumption-based charges.
- Currency
Code 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.
- Display
Name string Display name of the rate plan.
- End
Time 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.- Fixed
Fee intFrequency Frequency at which the fixed fee is charged.
- Fixed
Recurring GoogleFee Type Money Args 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 RateModel Plan Payment Funding Model 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or postpaid.- []Google
Cloud Apigee V1Revenue Share Range Args Details of the revenue sharing model.
- Rate
Plan Revenue Share Type Method used to calculate the revenue that is shared with developers.
- Setup
Fee GoogleType Money Args Initial, one-time fee paid when purchasing the API product.
- Start
Time string Time when the rate plan becomes active in milliseconds since epoch.
- State
Rate
Plan State Enum Current state of the rate plan (draft or published).
- apiproduct
Id String - organization
Id String - apiproduct String
Name of the API product that the rate plan is associated with.
- billing
Period RatePlan Billing Period Frequency at which the customer will be billed.
- consumption
Pricing List<GoogleRates Cloud Apigee V1Rate Range> 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 isUSD
): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.- consumption
Pricing RateType Plan Consumption Pricing Type Pricing model used for consumption-based charges.
- currency
Code 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.
- display
Name String Display name of the rate plan.
- end
Time 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.- fixed
Fee IntegerFrequency Frequency at which the fixed fee is charged.
- fixed
Recurring GoogleFee Type Money 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 RateModel Plan Payment Funding Model 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or postpaid.- List<Google
Cloud Apigee V1Revenue Share Range> Details of the revenue sharing model.
- Rate
Plan Revenue Share Type Method used to calculate the revenue that is shared with developers.
- setup
Fee GoogleType Money Initial, one-time fee paid when purchasing the API product.
- start
Time String Time when the rate plan becomes active in milliseconds since epoch.
- state
Rate
Plan State Current state of the rate plan (draft or published).
- apiproduct
Id string - organization
Id string - apiproduct string
Name of the API product that the rate plan is associated with.
- billing
Period RatePlan Billing Period Frequency at which the customer will be billed.
- consumption
Pricing GoogleRates Cloud Apigee V1Rate Range[] 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 isUSD
): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.- consumption
Pricing RateType Plan Consumption Pricing Type Pricing model used for consumption-based charges.
- currency
Code 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.
- display
Name string Display name of the rate plan.
- end
Time 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.- fixed
Fee numberFrequency Frequency at which the fixed fee is charged.
- fixed
Recurring GoogleFee Type Money 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 RateModel Plan Payment Funding Model 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or postpaid.- Google
Cloud Apigee V1Revenue Share Range[] Details of the revenue sharing model.
- Rate
Plan Revenue Share Type Method used to calculate the revenue that is shared with developers.
- setup
Fee GoogleType Money Initial, one-time fee paid when purchasing the API product.
- start
Time string Time when the rate plan becomes active in milliseconds since epoch.
- state
Rate
Plan State Current state of the rate plan (draft or published).
- apiproduct_
id str - organization_
id str - apiproduct str
Name of the API product that the rate plan is associated with.
- billing_
period RatePlan Billing Period Frequency at which the customer will be billed.
- consumption_
pricing_ Sequence[Googlerates Cloud Apigee V1Rate Range Args] 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 isUSD
): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.- consumption_
pricing_ Ratetype Plan Consumption Pricing Type 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_ intfrequency Frequency at which the fixed fee is charged.
- fixed_
recurring_ Googlefee Type Money Args 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_ Ratemodel Plan Payment Funding Model 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or postpaid.- Sequence[Google
Cloud Apigee V1Revenue Share Range Args] Details of the revenue sharing model.
- Rate
Plan Revenue Share Type Method used to calculate the revenue that is shared with developers.
- setup_
fee GoogleType Money Args 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
Rate
Plan State Current state of the rate plan (draft or published).
- apiproduct
Id String - organization
Id String - apiproduct String
Name of the API product that the rate plan is associated with.
- billing
Period "BILLING_PERIOD_UNSPECIFIED" | "WEEKLY" | "MONTHLY" Frequency at which the customer will be billed.
- consumption
Pricing List<Property Map>Rates 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 isUSD
): * 1 call costs $75 * 50 calls cost $75 * 150 calls cost $100 The number of API calls cannot exceed 200.- consumption
Pricing "CONSUMPTION_PRICING_TYPE_UNSPECIFIED" | "FIXED_PER_UNIT" | "BANDED" | "TIERED" | "STAIRSTEP"Type Pricing model used for consumption-based charges.
- currency
Code 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.
- display
Name String Display name of the rate plan.
- end
Time 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.- fixed
Fee NumberFrequency Frequency at which the fixed fee is charged.
- fixed
Recurring Property MapFee 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 "PAYMENT_FUNDING_MODEL_UNSPECIFIED" | "PREPAID" | "POSTPAID"Model 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or 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 insideDeveloperMonetizationConfig
resource. Flag that specifies the billing account type, prepaid or postpaid.- List<Property Map>
Details of the revenue sharing model.
- "REVENUE_SHARE_TYPE_UNSPECIFIED" | "FIXED" | "VOLUME_BANDED"
Method used to calculate the revenue that is shared with developers.
- setup
Fee Property Map Initial, one-time fee paid when purchasing the API product.
- start
Time 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:
- Created
At string Time that the rate plan was created in milliseconds since epoch.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt Time the rate plan was last modified in milliseconds since epoch.
- Name string
Name of the rate plan.
- Created
At string Time that the rate plan was created in milliseconds since epoch.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt Time the rate plan was last modified in milliseconds since epoch.
- Name string
Name of the rate plan.
- created
At String Time that the rate plan was created in milliseconds since epoch.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringAt Time the rate plan was last modified in milliseconds since epoch.
- name String
Name of the rate plan.
- created
At string Time that the rate plan was created in milliseconds since epoch.
- id string
The provider-assigned unique ID for this managed resource.
- last
Modified stringAt 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_ strat Time the rate plan was last modified in milliseconds since epoch.
- name str
Name of the rate plan.
- created
At String Time that the rate plan was created in milliseconds since epoch.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringAt 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.
Google Native. Apigee. V1. Inputs. Google Type Money 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
Google
Type Money 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
Google
Type Money 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
Google
Type Money 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
Google
Type Money 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 string
Ending value of the range. Set to 0 or
null
for the last range of values.- Fee
Pulumi.
Google Native. Apigee. V1. Inputs. Google Type Money Response 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
Google
Type Money Response 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
Google
Type Money Response 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
Google
Type Money Response 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
Google
Type Money Response 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.
GoogleCloudApigeeV1RevenueShareRange, GoogleCloudApigeeV1RevenueShareRangeArgs
- End string
Ending value of the range. Set to 0 or
null
for the last range of values.- 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.- 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.- 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.- 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.- 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.- 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 string
Ending value of the range. Set to 0 or
null
for the last range of values.- 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.- 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.- 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.- 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.- 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.- 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.
GoogleTypeMoney, GoogleTypeMoneyArgs
- Currency
Code 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.- units str
The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- currency
Code 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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
- Currency
Code 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.- units str
The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
- currency
Code 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. Ifunits
is zero,nanos
can be positive, zero, or negative. Ifunits
is negative,nanos
must be negative or zero. For example $-1.75 is represented asunits
=-1 andnanos
=-750,000,000.- units String
The whole units of the amount. For example if
currencyCode
is"USD"
, then 1 unit is one US dollar.
RatePlanBillingPeriod, RatePlanBillingPeriodArgs
- Billing
Period Unspecified - BILLING_PERIOD_UNSPECIFIED
Billing period not specified.
- Weekly
- WEEKLY
Weekly billing period. Note: Not supported by Apigee at this time.
- Monthly
- MONTHLY
Monthly billing period.
- Rate
Plan Billing Period Billing Period Unspecified - BILLING_PERIOD_UNSPECIFIED
Billing period not specified.
- Rate
Plan Billing Period Weekly - WEEKLY
Weekly billing period. Note: Not supported by Apigee at this time.
- Rate
Plan Billing Period Monthly - MONTHLY
Monthly billing period.
- Billing
Period Unspecified - BILLING_PERIOD_UNSPECIFIED
Billing period not specified.
- Weekly
- WEEKLY
Weekly billing period. Note: Not supported by Apigee at this time.
- Monthly
- MONTHLY
Monthly billing period.
- Billing
Period Unspecified - BILLING_PERIOD_UNSPECIFIED
Billing period not specified.
- Weekly
- WEEKLY
Weekly billing period. Note: Not supported by Apigee at this time.
- Monthly
- MONTHLY
Monthly billing period.
- BILLING_PERIOD_UNSPECIFIED
- BILLING_PERIOD_UNSPECIFIED
Billing period not specified.
- WEEKLY
- WEEKLY
Weekly billing period. Note: Not supported by Apigee at this time.
- MONTHLY
- MONTHLY
Monthly billing period.
- "BILLING_PERIOD_UNSPECIFIED"
- BILLING_PERIOD_UNSPECIFIED
Billing period not specified.
- "WEEKLY"
- WEEKLY
Weekly billing period. Note: Not supported by Apigee at this time.
- "MONTHLY"
- MONTHLY
Monthly billing period.
RatePlanConsumptionPricingType, RatePlanConsumptionPricingTypeArgs
- Consumption
Pricing Type Unspecified - CONSUMPTION_PRICING_TYPE_UNSPECIFIED
Pricing model not specified. This is the default.
- Fixed
Per Unit - FIXED_PER_UNIT
Fixed rate charged for each API call.
- Banded
- BANDED
Variable 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
- TIERED
Note: Not supported by Apigee at this time.
- Stairstep
- STAIRSTEP
Note: Not supported by Apigee at this time.
- Rate
Plan Consumption Pricing Type Consumption Pricing Type Unspecified - CONSUMPTION_PRICING_TYPE_UNSPECIFIED
Pricing model not specified. This is the default.
- Rate
Plan Consumption Pricing Type Fixed Per Unit - FIXED_PER_UNIT
Fixed rate charged for each API call.
- Rate
Plan Consumption Pricing Type Banded - BANDED
Variable 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.
- Rate
Plan Consumption Pricing Type Tiered - TIERED
Note: Not supported by Apigee at this time.
- Rate
Plan Consumption Pricing Type Stairstep - STAIRSTEP
Note: Not supported by Apigee at this time.
- Consumption
Pricing Type Unspecified - CONSUMPTION_PRICING_TYPE_UNSPECIFIED
Pricing model not specified. This is the default.
- Fixed
Per Unit - FIXED_PER_UNIT
Fixed rate charged for each API call.
- Banded
- BANDED
Variable 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
- TIERED
Note: Not supported by Apigee at this time.
- Stairstep
- STAIRSTEP
Note: Not supported by Apigee at this time.
- Consumption
Pricing Type Unspecified - CONSUMPTION_PRICING_TYPE_UNSPECIFIED
Pricing model not specified. This is the default.
- Fixed
Per Unit - FIXED_PER_UNIT
Fixed rate charged for each API call.
- Banded
- BANDED
Variable 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
- TIERED
Note: Not supported by Apigee at this time.
- Stairstep
- STAIRSTEP
Note: Not supported by Apigee at this time.
- CONSUMPTION_PRICING_TYPE_UNSPECIFIED
- CONSUMPTION_PRICING_TYPE_UNSPECIFIED
Pricing model not specified. This is the default.
- FIXED_PER_UNIT
- FIXED_PER_UNIT
Fixed rate charged for each API call.
- BANDED
- BANDED
Variable 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
- TIERED
Note: Not supported by Apigee at this time.
- STAIRSTEP
- STAIRSTEP
Note: Not supported by Apigee at this time.
- "CONSUMPTION_PRICING_TYPE_UNSPECIFIED"
- CONSUMPTION_PRICING_TYPE_UNSPECIFIED
Pricing model not specified. This is the default.
- "FIXED_PER_UNIT"
- FIXED_PER_UNIT
Fixed rate charged for each API call.
- "BANDED"
- BANDED
Variable 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"
- TIERED
Note: Not supported by Apigee at this time.
- "STAIRSTEP"
- STAIRSTEP
Note: Not supported by Apigee at this time.
RatePlanPaymentFundingModel, RatePlanPaymentFundingModelArgs
- Payment
Funding Model Unspecified - PAYMENT_FUNDING_MODEL_UNSPECIFIED
Billing account type not specified.
- Prepaid
- PREPAID
Prepaid 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
- POSTPAID
Postpaid billing account type. Developer is billed through an invoice after using your API products.
- Rate
Plan Payment Funding Model Payment Funding Model Unspecified - PAYMENT_FUNDING_MODEL_UNSPECIFIED
Billing account type not specified.
- Rate
Plan Payment Funding Model Prepaid - PREPAID
Prepaid 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.
- Rate
Plan Payment Funding Model Postpaid - POSTPAID
Postpaid billing account type. Developer is billed through an invoice after using your API products.
- Payment
Funding Model Unspecified - PAYMENT_FUNDING_MODEL_UNSPECIFIED
Billing account type not specified.
- Prepaid
- PREPAID
Prepaid 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
- POSTPAID
Postpaid billing account type. Developer is billed through an invoice after using your API products.
- Payment
Funding Model Unspecified - PAYMENT_FUNDING_MODEL_UNSPECIFIED
Billing account type not specified.
- Prepaid
- PREPAID
Prepaid 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
- POSTPAID
Postpaid billing account type. Developer is billed through an invoice after using your API products.
- PAYMENT_FUNDING_MODEL_UNSPECIFIED
- PAYMENT_FUNDING_MODEL_UNSPECIFIED
Billing account type not specified.
- PREPAID
- PREPAID
Prepaid 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
- POSTPAID
Postpaid billing account type. Developer is billed through an invoice after using your API products.
- "PAYMENT_FUNDING_MODEL_UNSPECIFIED"
- PAYMENT_FUNDING_MODEL_UNSPECIFIED
Billing account type not specified.
- "PREPAID"
- PREPAID
Prepaid 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"
- POSTPAID
Postpaid billing account type. Developer is billed through an invoice after using your API products.
RatePlanRevenueShareType, RatePlanRevenueShareTypeArgs
- Revenue
Share Type Unspecified - REVENUE_SHARE_TYPE_UNSPECIFIED
Revenue share type is not specified.
- Fixed
- FIXED
Fixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
- Volume
Banded - VOLUME_BANDED
Amount 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.
- Rate
Plan Revenue Share Type Revenue Share Type Unspecified - REVENUE_SHARE_TYPE_UNSPECIFIED
Revenue share type is not specified.
- Rate
Plan Revenue Share Type Fixed - FIXED
Fixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
- Rate
Plan Revenue Share Type Volume Banded - VOLUME_BANDED
Amount 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_UNSPECIFIED
Revenue share type is not specified.
- Fixed
- FIXED
Fixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
- Volume
Banded - VOLUME_BANDED
Amount 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_UNSPECIFIED
Revenue share type is not specified.
- Fixed
- FIXED
Fixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
- Volume
Banded - VOLUME_BANDED
Amount 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_UNSPECIFIED
Revenue share type is not specified.
- FIXED
- FIXED
Fixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
- VOLUME_BANDED
- VOLUME_BANDED
Amount 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_UNSPECIFIED
Revenue share type is not specified.
- "FIXED"
- FIXED
Fixed percentage of the total revenue will be shared. The percentage to be shared can be configured by the API provider.
- "VOLUME_BANDED"
- VOLUME_BANDED
Amount 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
- State
Unspecified - STATE_UNSPECIFIED
State of the rate plan is not specified.
- Draft
- DRAFT
Rate plan is in draft mode and only visible to API providers.
- Published
- PUBLISHED
Rate plan is published and will become visible to developers for the configured duration (between
startTime
andendTime
).
- Rate
Plan State State Unspecified - STATE_UNSPECIFIED
State of the rate plan is not specified.
- Rate
Plan State Draft - DRAFT
Rate plan is in draft mode and only visible to API providers.
- Rate
Plan State Published - PUBLISHED
Rate plan is published and will become visible to developers for the configured duration (between
startTime
andendTime
).
- State
Unspecified - STATE_UNSPECIFIED
State of the rate plan is not specified.
- Draft
- DRAFT
Rate plan is in draft mode and only visible to API providers.
- Published
- PUBLISHED
Rate plan is published and will become visible to developers for the configured duration (between
startTime
andendTime
).
- State
Unspecified - STATE_UNSPECIFIED
State of the rate plan is not specified.
- Draft
- DRAFT
Rate plan is in draft mode and only visible to API providers.
- Published
- PUBLISHED
Rate plan is published and will become visible to developers for the configured duration (between
startTime
andendTime
).
- STATE_UNSPECIFIED
- STATE_UNSPECIFIED
State of the rate plan is not specified.
- DRAFT
- DRAFT
Rate plan is in draft mode and only visible to API providers.
- PUBLISHED
- PUBLISHED
Rate plan is published and will become visible to developers for the configured duration (between
startTime
andendTime
).
- "STATE_UNSPECIFIED"
- STATE_UNSPECIFIED
State of the rate plan is not specified.
- "DRAFT"
- DRAFT
Rate plan is in draft mode and only visible to API providers.
- "PUBLISHED"
- PUBLISHED
Rate plan is published and will become visible to developers for the configured duration (between
startTime
andendTime
).
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.