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

OrganizationsDevelopersSubscriptions

class OrganizationsDevelopersSubscriptions extends Resource (View source)

The "subscriptions" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $subscriptions = $apigeeService->organizations_developers_subscriptions;

Methods

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

Creates a subscription to an API product. (subscriptions.create)

GoogleCloudApigeeV1DeveloperSubscription
expire(string $name, GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest $postBody, array $optParams = [])

Expires an API product subscription immediately. (subscriptions.expire)

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

Gets details for an API product subscription. (subscriptions.get)

GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse
listOrganizationsDevelopersSubscriptions(string $parent, array $optParams = [])

Lists all API product subscriptions for a developer.

Details

at line 45
GoogleCloudApigeeV1DeveloperSubscription create(string $parent, GoogleCloudApigeeV1DeveloperSubscription $postBody, array $optParams = [])

Creates a subscription to an API product. (subscriptions.create)

Parameters

string $parent

Required. Email address of the developer that is purchasing a subscription to the API product. Use the following structure in your request: organizations/{org}/developers/{developer_email}
GoogleCloudApigeeV1DeveloperSubscription $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperSubscription

Exceptions

Exception

at line 62
GoogleCloudApigeeV1DeveloperSubscription expire(string $name, GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest $postBody, array $optParams = [])

Expires an API product subscription immediately. (subscriptions.expire)

Parameters

string $name

Required. Name of the API product subscription. Use the following structure in your request: organizations/{org}/developers/{develop er_email}/subscriptions/{subscription}
GoogleCloudApigeeV1ExpireDeveloperSubscriptionRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperSubscription

Exceptions

Exception

at line 78
GoogleCloudApigeeV1DeveloperSubscription get(string $name, array $optParams = [])

Gets details for an API product subscription. (subscriptions.get)

Parameters

string $name

Required. Name of the API product subscription. Use the following structure in your request: organizations/{org}/developers/{develop er_email}/subscriptions/{subscription}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperSubscription

Exceptions

Exception

at line 104
GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse listOrganizationsDevelopersSubscriptions(string $parent, array $optParams = [])

Lists all API product subscriptions for a developer.

(subscriptions.listOrganizationsDevelopersSubscriptions)

Parameters

string $parent

Required. Email address of the developer. Use the following structure in your request: organizations/{org}/developers/{developer_email}
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListDeveloperSubscriptionsResponse

Exceptions

Exception