GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan (google_api_apigee v0.33.0) View Source

Rate plan details.

Attributes

  • apiproduct (type: String.t, default: nil) - Name of the API product that the rate plan is associated with.
  • billingPeriod (type: String.t, default: nil) - Frequency at which the customer will be billed.
  • consumptionPricingRates (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RateRange.t), default: nil) - 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 (type: String.t, default: nil) - Pricing model used for consumption-based charges.
  • createdAt (type: String.t, default: nil) - Output only. Time that the rate plan was created in milliseconds since epoch.
  • currencyCode (type: String.t, default: nil) - Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard.
  • description (type: String.t, default: nil) - Description of the rate plan.
  • displayName (type: String.t, default: nil) - Display name of the rate plan.
  • endTime (type: String.t, default: nil) - 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 (type: integer(), default: nil) - Frequency at which the fixed fee is charged.
  • fixedRecurringFee (type: GoogleApi.Apigee.V1.Model.GoogleTypeMoney.t, default: nil) - Fixed amount that is charged at a defined interval and billed in advance of use of the API product. The fee will be prorated for the first billing period.
  • lastModifiedAt (type: String.t, default: nil) - Output only. Time the rate plan was last modified in milliseconds since epoch.
  • name (type: String.t, default: nil) - Output only. Name of the rate plan.
  • paymentFundingModel (type: String.t, default: nil) - Flag that specifies the billing account type, prepaid or postpaid.
  • revenueShareRates (type: list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RevenueShareRange.t), default: nil) - Details of the revenue sharing model.
  • revenueShareType (type: String.t, default: nil) - Method used to calculate the revenue that is shared with developers.
  • setupFee (type: GoogleApi.Apigee.V1.Model.GoogleTypeMoney.t, default: nil) - Initial, one-time fee paid when purchasing the API product.
  • startTime (type: String.t, default: nil) - Time when the rate plan becomes active in milliseconds since epoch.
  • state (type: String.t, default: nil) - Current state of the rate plan (draft or published).

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RatePlan{
  apiproduct: String.t() | nil,
  billingPeriod: String.t() | nil,
  consumptionPricingRates:
    [GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RateRange.t()] | nil,
  consumptionPricingType: String.t() | nil,
  createdAt: String.t() | nil,
  currencyCode: String.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  endTime: String.t() | nil,
  fixedFeeFrequency: integer() | nil,
  fixedRecurringFee: GoogleApi.Apigee.V1.Model.GoogleTypeMoney.t() | nil,
  lastModifiedAt: String.t() | nil,
  name: String.t() | nil,
  paymentFundingModel: String.t() | nil,
  revenueShareRates:
    [GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1RevenueShareRange.t()] | nil,
  revenueShareType: String.t() | nil,
  setupFee: GoogleApi.Apigee.V1.Model.GoogleTypeMoney.t() | nil,
  startTime: String.t() | nil,
  state: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.