Methods summary
public
Google_Service_Reseller_Subscription
|
#
activate( string $customerId, string $subscriptionId, array $optParams = array() )
Activates a subscription previously suspended by the reseller
(subscriptions.activate)
Activates a subscription previously suspended by the reseller
(subscriptions.activate)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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
$optParams Optional parameters. Returns
|
public
Google_Service_Reseller_Subscription
|
#
changePlan( string $customerId, string $subscriptionId, Google_Service_Reseller_ChangePlanRequest $postBody, array $optParams = array() )
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)
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)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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_ChangePlanRequest
$postBody- $optParams
array
$optParams Optional parameters. Returns
|
public
Google_Service_Reseller_Subscription
|
#
changeRenewalSettings( string $customerId, string $subscriptionId, Google_Service_Reseller_RenewalSettings $postBody, array $optParams = array() )
Update a user license's renewal settings. This is applicable for accounts
with annual commitment plans only. (subscriptions.changeRenewalSettings)
Update a user license's renewal settings. This is applicable for accounts
with annual commitment plans only. (subscriptions.changeRenewalSettings)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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_RenewalSettings
$postBody- $optParams
array
$optParams Optional parameters. Returns
|
public
Google_Service_Reseller_Subscription
|
#
changeSeats( string $customerId, string $subscriptionId, Google_Service_Reseller_Seats $postBody, array $optParams = array() )
Update a subscription's user license settings.
(subscriptions.changeSeats)
Update a subscription's user license settings.
(subscriptions.changeSeats)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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_Seats
$postBody- $optParams
array
$optParams Optional parameters. Returns
|
public
|
#
delete( string $customerId, string $subscriptionId, string $deletionType, array $optParams = array() )
Cancel, suspend or transfer a subscription to direct.
(subscriptions.delete)
Cancel, suspend or transfer a subscription to direct.
(subscriptions.delete)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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
$deletionType The deletionType query string enables the cancellation, downgrade,
or suspension of a subscription.- $optParams
array
$optParams Optional parameters.
|
public
Google_Service_Reseller_Subscription
|
#
get( string $customerId, string $subscriptionId, array $optParams = array() )
Get a specific subscription. (subscriptions.get)
Get a specific subscription. (subscriptions.get)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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
$optParams Optional parameters. Returns
|
public
Google_Service_Reseller_Subscription
|
#
insert( string $customerId, Google_Service_Reseller_Subscription $postBody, array $optParams = array() )
Create or transfer a subscription. (subscriptions.insert)
Create or transfer a subscription. (subscriptions.insert)
Parameters
- $customerId
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.- $postBody
Google_Subscription
$postBody- $optParams
array
$optParams Optional parameters. Returns
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.
|
public
Google_Service_Reseller_Subscriptions
|
#
listSubscriptions( array $optParams = array() )
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)
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)
Parameters
- $optParams
array
$optParams Optional parameters. Returns
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.
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.
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.
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.
string pageToken Token to specify next page in the list
|
public
Google_Service_Reseller_Subscription
|
#
startPaidService( string $customerId, string $subscriptionId, array $optParams = array() )
Immediately move a 30-day free trial subscription to a paid service
subscription. (subscriptions.startPaidService)
Immediately move a 30-day free trial subscription to a paid service
subscription. (subscriptions.startPaidService)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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
$optParams Optional parameters. Returns
|
public
Google_Service_Reseller_Subscription
|
#
suspend( string $customerId, string $subscriptionId, array $optParams = array() )
Suspends an active subscription. (subscriptions.suspend)
Suspends an active subscription. (subscriptions.suspend)
Parameters
- $customerId
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.- $subscriptionId
string
$subscriptionId 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
$optParams Optional parameters. Returns
|
Google_Service_Reseller_Subscriptions_Resource