Class SubscriptionsResource

The "subscriptions" collection of methods.

Inheritance

object

SubscriptionsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Reseller.v1

Assembly: Google.Apis.Reseller.v1.dll

Syntax

public class SubscriptionsResource

Constructors

SubscriptionsResource(IClientService)

Constructs a new resource.

Declaration

public SubscriptionsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Activate(string, string)

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.

Declaration

public virtual SubscriptionsResource.ActivateRequest Activate(string customerId, string subscriptionId)

Parameters

Type	Name	Description
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.

Returns

Type	Description
SubscriptionsResource.ActivateRequest

ChangePlan(ChangePlanRequest, string, string)

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.

Declaration

public virtual SubscriptionsResource.ChangePlanRequest ChangePlan(ChangePlanRequest body, string customerId, string subscriptionId)

Parameters

Type	Name	Description
ChangePlanRequest	body	The body of the request.
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.

Returns

Type	Description
SubscriptionsResource.ChangePlanRequest

ChangeRenewalSettings(RenewalSettings, string, string)

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.

Declaration

public virtual SubscriptionsResource.ChangeRenewalSettingsRequest ChangeRenewalSettings(RenewalSettings body, string customerId, string subscriptionId)

Parameters

Type	Name	Description
RenewalSettings	body	The body of the request.
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.

Returns

Type	Description
SubscriptionsResource.ChangeRenewalSettingsRequest

ChangeSeats(Seats, string, string)

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.

Declaration

public virtual SubscriptionsResource.ChangeSeatsRequest ChangeSeats(Seats body, string customerId, string subscriptionId)

Parameters

Type	Name	Description
Seats	body	The body of the request.
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.

Returns

Type	Description
SubscriptionsResource.ChangeSeatsRequest

Delete(string, string, DeletionTypeEnum)

Cancels, suspends, or transfers a subscription to direct.

Declaration

public virtual SubscriptionsResource.DeleteRequest Delete(string customerId, string subscriptionId, SubscriptionsResource.DeleteRequest.DeletionTypeEnum deletionType)

Parameters

Type	Name	Description
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.
SubscriptionsResource.DeleteRequest.DeletionTypeEnum	deletionType	The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.

Returns

Type	Description
SubscriptionsResource.DeleteRequest

Get(string, string)

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.

Declaration

public virtual SubscriptionsResource.GetRequest Get(string customerId, string subscriptionId)

Parameters

Type	Name	Description
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.

Returns

Type	Description
SubscriptionsResource.GetRequest

Insert(Subscription, string)

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.

Declaration

public virtual SubscriptionsResource.InsertRequest Insert(Subscription body, string customerId)

Parameters

Type	Name	Description
Subscription	body	The body of the request.
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.

Returns

Type	Description
SubscriptionsResource.InsertRequest

List()

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.

Declaration

public virtual SubscriptionsResource.ListRequest List()

Returns

Type	Description
SubscriptionsResource.ListRequest

StartPaidService(string, string)

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.

Declaration

public virtual SubscriptionsResource.StartPaidServiceRequest StartPaidService(string customerId, string subscriptionId)

Parameters

Type	Name	Description
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.

Returns

Type	Description
SubscriptionsResource.StartPaidServiceRequest

Suspend(string, string)

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.

Declaration

public virtual SubscriptionsResource.SuspendRequest Suspend(string customerId, string subscriptionId)

Parameters

Type	Name	Description
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.

Returns

Type	Description
SubscriptionsResource.SuspendRequest