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.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: apigee1 --scope <scope> organizations apiproducts-rateplans-create ...

Required Scalar Argument

  • <parent> (string)
    • Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudApigeeV1RatePlan:
  apiproduct: string
  billing-period: string
  consumption-pricing-type: string
  created-at: string
  currency-code: string
  description: string
  display-name: string
  end-time: string
  fixed-fee-frequency: integer
  fixed-recurring-fee:
    currency-code: string
    nanos: integer
    units: string
  last-modified-at: string
  name: string
  payment-funding-model: string
  revenue-share-type: string
  setup-fee:
    currency-code: string
    nanos: integer
    units: string
  start-time: string
  state: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . apiproduct=duo
    • Name of the API product that the rate plan is associated with.
  • billing-period=dolore
    • Frequency at which the customer will be billed.
  • consumption-pricing-type=et
    • Pricing model used for consumption-based charges.
  • created-at=voluptua.
    • Output only. Time that the rate plan was created in milliseconds since epoch.
  • currency-code=amet.
    • Currency to be used for billing. Consists of a three-letter code as defined by the ISO 4217 standard.
  • description=consetetur
    • Description of the rate plan.
  • display-name=diam
    • Display name of the rate plan.
  • end-time=dolor
    • 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=83
    • Frequency at which the fixed fee is charged.
  • fixed-recurring-fee currency-code=et
    • The three-letter currency code defined in ISO 4217.
  • nanos=6
    • 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=stet

    • The whole units of the amount. For example if currencyCode is &#34;USD&#34;, then 1 unit is one US dollar.

  • .. last-modified-at=dolor

    • Output only. Time the rate plan was last modified in milliseconds since epoch.
  • name=duo
    • Output only. Name of the rate plan.
  • payment-funding-model=vero
    • 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-type=vero
    • Method used to calculate the revenue that is shared with developers.
  • setup-fee currency-code=invidunt
    • The three-letter currency code defined in ISO 4217.
  • nanos=36
    • 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=vero

    • The whole units of the amount. For example if currencyCode is &#34;USD&#34;, then 1 unit is one US dollar.

  • .. start-time=elitr

    • Time when the rate plan becomes active in milliseconds since epoch.
  • state=lorem
    • Current state of the rate plan (draft or published).

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").