Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource Class Reference

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

Inheritance diagram for Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	cancel ($packageName, $subscriptionId, $token, $optParams=array())
	Cancels a user's subscription purchase.
	defer ($packageName, $subscriptionId, $token, Google_Service_AndroidPublisher_SubscriptionPurchasesDeferRequest $postBody, $optParams=array())
	Defers a user's subscription purchase until a specified future expiration time.
	get ($packageName, $subscriptionId, $token, $optParams=array())
	Checks whether a user's subscription purchase is valid and returns its expiry time.
	refund ($packageName, $subscriptionId, $token, $optParams=array())
	Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.
	revoke ($packageName, $subscriptionId, $token, $optParams=array())
	Refunds and immediately revokes a user's subscription purchase.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "subscriptions" collection of methods.

Typical usage is: $androidpublisherService = new Google_Service_AndroidPublisher(...); $subscriptions = $androidpublisherService->subscriptions;

Member Function Documentation

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

cancel()

Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource::cancel	(		$packageName,
			$subscriptionId,
			$token,
			$optParams = array() )

Cancels a user's subscription purchase.

The subscription remains valid until its expiration time. (subscriptions.cancel)

Parameters

string	$packageName	The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
string	$subscriptionId	The purchased subscription ID (for example, 'monthly001').
string	$token	The token provided to the user's device when the subscription was purchased.
array	$optParams	Optional parameters.

defer()

Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource::defer	(		$packageName,
			$subscriptionId,
			$token,
		Google_Service_AndroidPublisher_SubscriptionPurchasesDeferRequest	$postBody,
			$optParams = array() )

Defers a user's subscription purchase until a specified future expiration time.

(subscriptions.defer)

Parameters

string	$packageName	The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
string	$subscriptionId	The purchased subscription ID (for example, 'monthly001').
string	$token	The token provided to the user's device when the subscription was purchased.
Google_SubscriptionPurchasesDeferRequest	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_AndroidPublisher_SubscriptionPurchasesDeferResponse

get()

Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource::get	(		$packageName,
			$subscriptionId,
			$token,
			$optParams = array() )

Checks whether a user's subscription purchase is valid and returns its expiry time.

(subscriptions.get)

Parameters

string	$packageName	The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
string	$subscriptionId	The purchased subscription ID (for example, 'monthly001').
string	$token	The token provided to the user's device when the subscription was purchased.
array	$optParams	Optional parameters.

Return values

Google_Service_AndroidPublisher_SubscriptionPurchase

refund()

Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource::refund	(		$packageName,
			$subscriptionId,
			$token,
			$optParams = array() )

Refunds a user's subscription purchase, but the subscription remains valid until its expiration time and it will continue to recur.

(subscriptions.refund)

Parameters

string	$packageName	The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
string	$subscriptionId	The purchased subscription ID (for example, 'monthly001').
string	$token	The token provided to the user's device when the subscription was purchased.
array	$optParams	Optional parameters.

revoke()

Google_Service_AndroidPublisher_PurchasesSubscriptions_Resource::revoke	(		$packageName,
			$subscriptionId,
			$token,
			$optParams = array() )

Refunds and immediately revokes a user's subscription purchase.

Access to the subscription will be terminated immediately and it will stop recurring. (subscriptions.revoke)

Parameters

string	$packageName	The package name of the application for which this subscription was purchased (for example, 'com.some.thing').
string	$subscriptionId	The purchased subscription ID (for example, 'monthly001').
string	$token	The token provided to the user's device when the subscription was purchased.
array	$optParams	Optional parameters.

---

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

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