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

Subscriptions

class Subscriptions extends Resource (View source)

The "subscriptions" collection of methods.

Typical usage is:

 $resellerService = new Google\Service\Reseller(...);
 $subscriptions = $resellerService->subscriptions;

Methods

Subscription
activate(string $customerId, string $subscriptionId, array $optParams = [])

Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription. (subscriptions.activate)

Subscription
changePlan(string $customerId, string $subscriptionId, ChangePlanRequest $postBody, array $optParams = [])

Updates 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. How a plan is updated differs depending on the plan and the products. For more information, see the description in manage subscriptions.

Subscription
changeRenewalSettings(string $customerId, string $subscriptionId, RenewalSettings $postBody, array $optParams = [])

Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in manage subscriptions.

Subscription
changeSeats(string $customerId, string $subscriptionId, Seats $postBody, array $optParams = [])

Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see Manage Subscriptions.

delete(string $customerId, string $subscriptionId, string $deletionType, array $optParams = [])

Cancels, suspends, or transfers a subscription to direct.

Subscription
get(string $customerId, string $subscriptionId, array $optParams = [])

Gets a specific subscription. The subscriptionId can be found using the Retrieve all reseller subscriptions method. For more information about retrieving a specific subscription, see the information descrived in manage subscriptions. (subscriptions.get)

Subscription
insert(string $customerId, Subscription $postBody, array $optParams = [])

Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the Order a new customer account method. For more information about creating a subscription for different payment plans, see manage subscriptions.\ If you did not order the customer's account using the customer insert method, use the customer's customerAuthToken when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the batch operation to transfer all of these subscriptions. For more information, see how to transfer subscriptions. (subscriptions.insert)

Subscriptions
listSubscriptions(array $optParams = [])

Lists 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. Optionally, this method can filter the response by a customerNamePrefix. For more information, see manage subscriptions.

Subscription
startPaidService(string $customerId, string $subscriptionId, array $optParams = [])

Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see manage subscriptions. (subscriptions.startPaidService)

Subscription
suspend(string $customerId, string $subscriptionId, array $optParams = [])

Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the ACTIVE state. For FLEXIBLE subscriptions, billing is paused. For ANNUAL_MONTHLY_PAY or ANNUAL_YEARLY_PAY subscriptions: Suspending the subscription does not change the renewal date that was originally committed to. A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation. We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled. (subscriptions.suspend)

Details

at line 57
Subscription activate(string $customerId, string $subscriptionId, array $optParams = [])

Activates a subscription previously suspended by the reseller. If you did not suspend the customer subscription and it is suspended for any other reason, such as for abuse or a pending ToS acceptance, this call will not reactivate the customer subscription. (subscriptions.activate)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 88
Subscription changePlan(string $customerId, string $subscriptionId, ChangePlanRequest $postBody, array $optParams = [])

Updates 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. How a plan is updated differs depending on the plan and the products. For more information, see the description in manage subscriptions.

(subscriptions.changePlan)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
ChangePlanRequest $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 117
Subscription changeRenewalSettings(string $customerId, string $subscriptionId, RenewalSettings $postBody, array $optParams = [])

Updates a user license's renewal settings. This is applicable for accounts with annual commitment plans only. For more information, see the description in manage subscriptions.

(subscriptions.changeRenewalSettings)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
RenewalSettings $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 146
Subscription changeSeats(string $customerId, string $subscriptionId, Seats $postBody, array $optParams = [])

Updates a subscription's user license settings. For more information about updating an annual commitment plan or a flexible plan subscription’s licenses, see Manage Subscriptions.

(subscriptions.changeSeats)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
Seats $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 172
delete(string $customerId, string $subscriptionId, string $deletionType, array $optParams = [])

Cancels, suspends, or transfers a subscription to direct.

(subscriptions.delete)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
string $deletionType

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

Optional parameters.

Exceptions

Exception

at line 201
Subscription get(string $customerId, string $subscriptionId, array $optParams = [])

Gets a specific subscription. The subscriptionId can be found using the Retrieve all reseller subscriptions method. For more information about retrieving a specific subscription, see the information descrived in manage subscriptions. (subscriptions.get)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 250
Subscription insert(string $customerId, Subscription $postBody, array $optParams = [])

Creates or transfer a subscription. Create a subscription for a customer's account that you ordered using the Order a new customer account method. For more information about creating a subscription for different payment plans, see manage subscriptions.\ If you did not order the customer's account using the customer insert method, use the customer's customerAuthToken when creating a subscription for that customer. If transferring a G Suite subscription with an associated Google Drive or Google Vault subscription, use the batch operation to transfer all of these subscriptions. For more information, see how to transfer subscriptions. (subscriptions.insert)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
Subscription $postBody
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 292
Subscriptions listSubscriptions(array $optParams = [])

Lists 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. Optionally, this method can filter the response by a customerNamePrefix. For more information, see manage subscriptions.

(subscriptions.listSubscriptions)

Parameters

array $optParams

Optional parameters.

Return Value

Subscriptions

Exceptions

Exception

at line 320
Subscription startPaidService(string $customerId, string $subscriptionId, array $optParams = [])

Immediately move a 30-day free trial subscription to a paid service subscription. This method is only applicable if a payment plan has already been set up for the 30-day trial subscription. For more information, see manage subscriptions. (subscriptions.startPaidService)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception

at line 353
Subscription suspend(string $customerId, string $subscriptionId, array $optParams = [])

Suspends an active subscription. You can use this method to suspend a paid subscription that is currently in the ACTIVE state. For FLEXIBLE subscriptions, billing is paused. For ANNUAL_MONTHLY_PAY or ANNUAL_YEARLY_PAY subscriptions: Suspending the subscription does not change the renewal date that was originally committed to. A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation. We strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled. (subscriptions.suspend)

Parameters

string $customerId

This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable.
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.
array $optParams

Optional parameters.

Return Value

Subscription

Exceptions

Exception