1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Apigee
  7. \
  8. Resource
  9. \
  10. OrganizationsApiproductsRateplans

OrganizationsApiproductsRateplans

class OrganizationsApiproductsRateplans extends Resource (View source)

The "rateplans" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $rateplans = $apigeeService->organizations_apiproducts_rateplans;

Methods

GoogleCloudApigeeV1RatePlan
create(string $parent, GoogleCloudApigeeV1RatePlan $postBody, array $optParams = [])

Create a rate plan that is associated with an API product in an organization.

GoogleCloudApigeeV1RatePlan
delete(string $name, array $optParams = [])

Deletes a rate plan. (rateplans.delete)

GoogleCloudApigeeV1RatePlan
get(string $name, array $optParams = [])

Gets the details of a rate plan. (rateplans.get)

GoogleCloudApigeeV1ListRatePlansResponse
listOrganizationsApiproductsRateplans(string $parent, array $optParams = [])

Lists all the rate plans for an API product.

GoogleCloudApigeeV1RatePlan
update(string $name, GoogleCloudApigeeV1RatePlan $postBody, array $optParams = [])

Updates an existing rate plan. (rateplans.update)

Details

at line 52
GoogleCloudApigeeV1RatePlan create(string $parent, GoogleCloudApigeeV1RatePlan $postBody, array $optParams = [])

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. (rateplans.create)

Parameters

string $parent

Required. Name of the API product that is associated with the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}
GoogleCloudApigeeV1RatePlan $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1RatePlan

Exceptions

Exception

at line 68
GoogleCloudApigeeV1RatePlan delete(string $name, array $optParams = [])

Deletes a rate plan. (rateplans.delete)

Parameters

string $name

Required. ID of the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1RatePlan

Exceptions

Exception

at line 84
GoogleCloudApigeeV1RatePlan get(string $name, array $optParams = [])

Gets the details of a rate plan. (rateplans.get)

Parameters

string $name

Required. Name of the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1RatePlan

Exceptions

Exception

at line 120
GoogleCloudApigeeV1ListRatePlansResponse listOrganizationsApiproductsRateplans(string $parent, array $optParams = [])

Lists all the rate plans for an API product.

(rateplans.listOrganizationsApiproductsRateplans)

Parameters

string $parent

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.
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListRatePlansResponse

Exceptions

Exception

at line 137
GoogleCloudApigeeV1RatePlan update(string $name, GoogleCloudApigeeV1RatePlan $postBody, array $optParams = [])

Updates an existing rate plan. (rateplans.update)

Parameters

string $name

Required. Name of the rate plan. Use the following structure in your request: organizations/{org}/apiproducts/{apiproduct}/rateplans/{rateplan}
GoogleCloudApigeeV1RatePlan $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1RatePlan

Exceptions

Exception