Google_Service_Reseller_Subscriptions_Resource Class Reference

The "subscriptions" collection of methods. More...

Inheritance diagram for Google_Service_Reseller_Subscriptions_Resource:

Public Member Functions
	activate ($customerId, $subscriptionId, $optParams=array())
	Activates a subscription previously suspended by the reseller (subscriptions.activate)
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	changePlan ($customerId, $subscriptionId, Google_Service_Reseller_ChangePlanRequest $postBody, $optParams=array())
	Changes the plan of a subscription (subscriptions.changePlan)
	changeRenewalSettings ($customerId, $subscriptionId, Google_Service_Reseller_RenewalSettings $postBody, $optParams=array())
	Changes the renewal settings of a subscription (subscriptions.changeRenewalSettings)
	changeSeats ($customerId, $subscriptionId, Google_Service_Reseller_Seats $postBody, $optParams=array())
	Changes the seats configuration of a subscription (subscriptions.changeSeats)
	delete ($customerId, $subscriptionId, $deletionType, $optParams=array())
	Cancels/Downgrades a subscription.
	get ($customerId, $subscriptionId, $optParams=array())
	Gets a subscription of the customer.
	insert ($customerId, Google_Service_Reseller_Subscription $postBody, $optParams=array())
	Creates/Transfers a subscription for the customer.
	listSubscriptions ($optParams=array())
	Lists subscriptions of a reseller, optionally filtered by a customer name prefix.
	startPaidService ($customerId, $subscriptionId, $optParams=array())
	Starts paid service of a trial subscription (subscriptions.startPaidService)
	suspend ($customerId, $subscriptionId, $optParams=array())
	Suspends an active subscription (subscriptions.suspend)

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "subscriptions" collection of methods.

Typical usage is: $resellerService = new Google_Service_Reseller(...); $subscriptions = $resellerService->subscriptions;

Member Function Documentation

activate()

Google_Service_Reseller_Subscriptions_Resource::activate	(		$customerId,
			$subscriptionId,
			$optParams = array() )

Activates a subscription previously suspended by the reseller (subscriptions.activate)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

changePlan()

Google_Service_Reseller_Subscriptions_Resource::changePlan	(		$customerId,
			$subscriptionId,
		Google_Service_Reseller_ChangePlanRequest	$postBody,
			$optParams = array() )

Changes the plan of a subscription (subscriptions.changePlan)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
Google_ChangePlanRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

changeRenewalSettings()

Google_Service_Reseller_Subscriptions_Resource::changeRenewalSettings	(		$customerId,
			$subscriptionId,
		Google_Service_Reseller_RenewalSettings	$postBody,
			$optParams = array() )

Changes the renewal settings of a subscription (subscriptions.changeRenewalSettings)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
Google_RenewalSettings	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

changeSeats()

Google_Service_Reseller_Subscriptions_Resource::changeSeats	(		$customerId,
			$subscriptionId,
		Google_Service_Reseller_Seats	$postBody,
			$optParams = array() )

Changes the seats configuration of a subscription (subscriptions.changeSeats)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
Google_Seats	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

delete()

Google_Service_Reseller_Subscriptions_Resource::delete	(		$customerId,
			$subscriptionId,
			$deletionType,
			$optParams = array() )

Cancels/Downgrades a subscription.

(subscriptions.delete)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
string	$deletionType	Whether the subscription is to be fully cancelled or downgraded
array	$optParams	Optional parameters.

get()

Google_Service_Reseller_Subscriptions_Resource::get	(		$customerId,
			$subscriptionId,
			$optParams = array() )

Gets a subscription of the customer.

(subscriptions.get)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

insert()

Google_Service_Reseller_Subscriptions_Resource::insert	(		$customerId,
		Google_Service_Reseller_Subscription	$postBody,
			$optParams = array() )

Creates/Transfers a subscription for the customer.

(subscriptions.insert)

Parameters

string	$customerId	Id of the Customer
Google_Subscription	$postBody
array	$optParams	Optional parameters.

@opt_param string customerAuthToken An auth token needed for transferring a subscription. Can be generated at https://www.google.com/a/cpanel/customer- domain/TransferToken. Optional.

Return values

Google_Service_Reseller_Subscription

listSubscriptions()

Google_Service_Reseller_Subscriptions_Resource::listSubscriptions

(

$optParams = array()

)

Lists subscriptions of a reseller, optionally filtered by a customer name prefix.

(subscriptions.listSubscriptions)

Parameters

array

$optParams

Optional parameters.

@opt_param string customerAuthToken An auth token needed if the customer is not a resold customer of this reseller. Can be generated at https://www.google.com/a/cpanel/customer-domain/TransferToken.Optional. @opt_param string pageToken Token to specify next page in the list @opt_param string customerId Id of the Customer @opt_param string maxResults Maximum number of results to return @opt_param string customerNamePrefix Prefix of the customer's domain name by which the subscriptions should be filtered. Optional

Return values

Google_Service_Reseller_Subscriptions

startPaidService()

Google_Service_Reseller_Subscriptions_Resource::startPaidService	(		$customerId,
			$subscriptionId,
			$optParams = array() )

Starts paid service of a trial subscription (subscriptions.startPaidService)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

suspend()

Google_Service_Reseller_Subscriptions_Resource::suspend	(		$customerId,
			$subscriptionId,
			$optParams = array() )

Suspends an active subscription (subscriptions.suspend)

Parameters

string	$customerId	Id of the Customer
string	$subscriptionId	Id of the subscription, which is unique for a customer
array	$optParams	Optional parameters.

Return values

Google_Service_Reseller_Subscription

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/Reseller.php