- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists all the rate plans for an API product.
HTTP request
GET https://apigee.googleapis.com/v1/{parent=organizations/*/apiproducts/*}/rateplans
The URL uses gRPC Transcoding syntax.
Path parameters
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.
Authorization requires the following IAM
permission on the specified resource parent
:
-
apigee.rateplans.list
Query parameters
orderBy
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.
startKey
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.
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.
state
enum (
State
)
State of the rate plans ( DRAFT
, PUBLISHED
) that you want to display.
Request body
The request body must be empty.
Response body
Response for [rateplans.list][RatePlan.ListRatePlans].
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"ratePlans"
:
[
{
object (
|
Fields | |
---|---|
ratePlans[]
|
List of rate plans in an organization. |
nextStartKey
|
Value that can be sent as |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform