Class: Google::Apis::PaymentsresellersubscriptionV1::GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/paymentsresellersubscription_v1/classes.rb,
lib/google/apis/paymentsresellersubscription_v1/representations.rb,
lib/google/apis/paymentsresellersubscription_v1/representations.rb

Overview

Request to cancel a subscription.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest

Returns a new instance of GoogleCloudPaymentsResellerSubscriptionV1CancelSubscriptionRequest.



71
72
73
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 71

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cancel_immediatelyBoolean Also known as: cancel_immediately?

Optional. If true, Google will cancel the subscription immediately, and may or may not (based on the contract) issue a prorated refund for the remainder of the billing cycle. Otherwise, Google defers the cancelation at renewal_time, and will not issue a refund. - YouTube subscriptions must use this option currently. However, the user will still have access to the subscription until the end of the billing cycle. Corresponds to the JSON property cancelImmediately

Returns:

  • (Boolean)


63
64
65
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 63

def cancel_immediately
  @cancel_immediately
end

#cancellation_reasonString

Specifies the reason for the cancellation. Corresponds to the JSON property cancellationReason

Returns:

  • (String)


69
70
71
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 69

def cancellation_reason
  @cancellation_reason
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



76
77
78
79
# File 'lib/google/apis/paymentsresellersubscription_v1/classes.rb', line 76

def update!(**args)
  @cancel_immediately = args[:cancel_immediately] if args.key?(:cancel_immediately)
  @cancellation_reason = args[:cancellation_reason] if args.key?(:cancellation_reason)
end