v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Lists all the rate plans for an API product.

get/v1/{+parent}/rateplans

Path parameters

parentstring required

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. If the API Product resource has the space attribute set, IAM permissions are checked against the Space resource path. To learn more, read the Apigee Spaces Overview.

Query parameters

countinteger

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.

expandboolean

Flag that specifies whether to expand the results. Set to true to get expanded details about each API. Defaults to false.

orderBystring

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.

startKeystring

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.

state'STATE_UNSPECIFIED' | 'DRAFT' | 'PUBLISHED'

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

Response

Successful response