Documentation

Google_Service_Reseller_Resource_Subscriptions extends Google_Service_Resource
in package

The "subscriptions" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
activate()  : Google_Service_Reseller_Subscription
Activates a subscription previously suspended by the reseller (subscriptions.activate)
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
changePlan()  : Google_Service_Reseller_Subscription
Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. (subscriptions.changePlan)
changeRenewalSettings()  : Google_Service_Reseller_Subscription
Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. (subscriptions.changeRenewalSettings)
changeSeats()  : Google_Service_Reseller_Subscription
Update a subscription's user license settings. (subscriptions.changeSeats)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
delete()  : mixed
Cancel, suspend, or transfer a subscription to direct. (subscriptions.delete)
get()  : Google_Service_Reseller_Subscription
Get a specific subscription. (subscriptions.get)
insert()  : Google_Service_Reseller_Subscription
Create or transfer a subscription. (subscriptions.insert)
listSubscriptions()  : Google_Service_Reseller_Subscriptions
List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. (subscriptions.listSubscriptions)
startPaidService()  : Google_Service_Reseller_Subscription
Immediately move a 30-day free trial subscription to a paid service subscription. (subscriptions.startPaidService)
suspend()  : Google_Service_Reseller_Subscription
Suspends an active subscription. (subscriptions.suspend)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

activate()

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

public activate(string $customerId, string $subscriptionId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

changePlan()

Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. (subscriptions.changePlan)

public changePlan(string $customerId, string $subscriptionId, Google_Service_Reseller_ChangePlanRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$postBody : Google_Service_Reseller_ChangePlanRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

changeRenewalSettings()

Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. (subscriptions.changeRenewalSettings)

public changeRenewalSettings(string $customerId, string $subscriptionId, Google_Service_Reseller_RenewalSettings $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$postBody : Google_Service_Reseller_RenewalSettings
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

changeSeats()

Update a subscription's user license settings. (subscriptions.changeSeats)

public changeSeats(string $customerId, string $subscriptionId, Google_Service_Reseller_Seats $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$postBody : Google_Service_Reseller_Seats
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

delete()

Cancel, suspend, or transfer a subscription to direct. (subscriptions.delete)

public delete(string $customerId, string $subscriptionId, string $deletionType[, array<string|int, mixed> $optParams = array() ]) : mixed
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$deletionType : string

The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
mixed —

get()

Get a specific subscription. (subscriptions.get)

public get(string $customerId, string $subscriptionId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

insert()

Create or transfer a subscription. (subscriptions.insert)

public insert(string $customerId, Google_Service_Reseller_Subscription $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$postBody : Google_Service_Reseller_Subscription
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string customerAuthToken The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.

Return values
Google_Service_Reseller_Subscription —

listSubscriptions()

List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. (subscriptions.listSubscriptions)

public listSubscriptions([array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscriptions
Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string maxResults When retrieving a large list, the maxResults is the maximum number of results per page. The nextPageToken value takes you to the next page. The default is 20.

opt_param

string customerAuthToken The customerAuthToken query string is required when creating a resold account that transfers a direct customer's subscription or transfers another reseller customer's subscription to your reseller management. This is a hexadecimal authentication token needed to complete the subscription transfer. For more information, see the administrator help center.

opt_param

string customerNamePrefix When retrieving all of your subscriptions and filtering for specific customers, you can enter a prefix for a customer name. Using an example customer group that includes exam.com, example20.com and example.com: - exa -- Returns all customer names that start with 'exa' which could include exam.com, example20.com, and example.com. A name prefix is similar to using a regular expression's asterisk, exa*. - example -- Returns example20.com and example.com.

opt_param

string customerId Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

opt_param

string pageToken Token to specify next page in the list

Return values
Google_Service_Reseller_Subscriptions —

startPaidService()

Immediately move a 30-day free trial subscription to a paid service subscription. (subscriptions.startPaidService)

public startPaidService(string $customerId, string $subscriptionId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

suspend()

Suspends an active subscription. (subscriptions.suspend)

public suspend(string $customerId, string $subscriptionId[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Reseller_Subscription
Parameters
$customerId : string

Either the customer's primary domain name or the customer's unique identifier. If using the domain name, we do not recommend using a customerId as a key for persistent data. If the domain name for a customerId is changed, the Google system automatically updates.

$subscriptionId : string

This is a required property. The subscriptionId is the subscription identifier and is unique for each customer. Since a subscriptionId changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the subscriptionId can be found using the retrieve all reseller subscriptions method.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Reseller_Subscription —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results