Lists all the rate plans for an API product.


You will need authorization for the scope to make a valid call.

If unset, the scope for this method defaults to You can set the scope for this method like this: apigee1 --scope <scope> organizations apiproducts-rateplans-list ...

Required Scalar Argument

  • <parent> (string)
    • Required. Name of the API product. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct} Use organizations/{org}/apiproducts/- to return rate plans for all API products within the organization.

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 Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p count=integer

    • Number of rate plans to return in the API call. Use with the startKey parameter to provide more targeted filtering. The maximum limit is 1000. Defaults to 100.
  • -p expand=boolean

    • Flag that specifies whether to expand the results. Set to true to get expanded details about each API. Defaults to false.
  • -p order-by=string

    • Name of the attribute used for sorting. Valid values include: * name: Name of the rate plan. * state: State of the rate plan (DRAFT, PUBLISHED). * startTime: Time when the rate plan becomes active. * endTime: Time when the rate plan expires. Note: Not supported by Apigee at this time.
  • -p start-key=string

    • Name of the rate plan from which to start displaying the list of rate plans. If omitted, the list starts from the first item. For example, to view the rate plans from 51-150, set the value of startKey to the name of the 51st rate plan and set the value of count to 100.
  • -p state=string

    • State of the rate plans (DRAFT, PUBLISHED) that you want to display.

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").