Class SubscriptionsResource.SuspendRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.Reseller.v1
Assembly: Google.Apis.Reseller.v1.dll
Syntax
public class SubscriptionsResource.SuspendRequest : ResellerBaseServiceRequest<Subscription>, IClientServiceRequest<Subscription>, IClientServiceRequest
Constructors
SuspendRequest(IClientService, string, string)
Constructs a new Suspend request.
Declaration
public SuspendRequest(IClientService service, string customerId, string subscriptionId)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | customerId | |
string | subscriptionId |
Properties
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.
Declaration
[RequestParameter("customerId", RequestParameterType.Path)]
public virtual string CustomerId { get; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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.
Declaration
[RequestParameter("subscriptionId", RequestParameterType.Path)]
public virtual string SubscriptionId { get; }
Property Value
Type | Description |
---|---|
string |
Methods
InitParameters()
Initializes Suspend parameter list.
Declaration
protected override void InitParameters()