Class: Google::Apis::ResellerV1::ChangePlanRequest
- Inherits:
-
Object
- Object
- Google::Apis::ResellerV1::ChangePlanRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/reseller_v1/classes.rb,
generated/google/apis/reseller_v1/representations.rb,
generated/google/apis/reseller_v1/representations.rb
Overview
JSON template for the ChangePlan rpc request.
Instance Attribute Summary collapse
-
#deal_code ⇒ String
Google-issued code (100 char max) for discounted pricing on subscription plans.
-
#kind ⇒ String
Identifies the resource as a subscription change plan request.
-
#plan_name ⇒ String
The planName property is required.
-
#purchase_order_id ⇒ String
This is an optional property.
-
#seats ⇒ Google::Apis::ResellerV1::Seats
JSON template for subscription seats.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ChangePlanRequest
constructor
A new instance of ChangePlanRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ChangePlanRequest
Returns a new instance of ChangePlanRequest
149 150 151 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 149 def initialize(**args) update!(**args) end |
Instance Attribute Details
#deal_code ⇒ String
Google-issued code (100 char max) for discounted pricing on subscription plans.
Deal code must be included in changePlan request in order to receive
discounted rate. This property is optional. If a deal code has already been
added to a subscription, this property may be left empty and the existing
discounted rate will still apply (if not empty, only provide the deal code
that is already present on the subscription). If a deal code has never been
added to a subscription and this property is left blank, regular pricing will
apply.
Corresponds to the JSON property dealCode
116 117 118 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 116 def deal_code @deal_code end |
#kind ⇒ String
Identifies the resource as a subscription change plan request. Value:
subscriptions#changePlanRequest
Corresponds to the JSON property kind
122 123 124 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 122 def kind @kind end |
#plan_name ⇒ String
The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are:
- ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments
- ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments
- FLEXIBLE - The flexible plan
- TRIAL - The 30-day free trial plan
Corresponds to the JSON property
planName
134 135 136 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 134 def plan_name @plan_name end |
#purchase_order_id ⇒ String
This is an optional property. This purchase order (PO) information is for
resellers to use for their company tracking usage. If a purchaseOrderId value
is given it appears in the API responses and shows up in the invoice. The
property accepts up to 80 plain text characters.
Corresponds to the JSON property purchaseOrderId
142 143 144 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 142 def purchase_order_id @purchase_order_id end |
#seats ⇒ Google::Apis::ResellerV1::Seats
JSON template for subscription seats.
Corresponds to the JSON property seats
147 148 149 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 147 def seats @seats end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
154 155 156 157 158 159 160 |
# File 'generated/google/apis/reseller_v1/classes.rb', line 154 def update!(**args) @deal_code = args[:deal_code] if args.key?(:deal_code) @kind = args[:kind] if args.key?(:kind) @plan_name = args[:plan_name] if args.key?(:plan_name) @purchase_order_id = args[:purchase_order_id] if args.key?(:purchase_order_id) @seats = args[:seats] if args.key?(:seats) end |