Class: Google::Apis::AndroidpublisherV3::InstallmentsBasePlanType

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

Overview

Represents an installments base plan where a user commits to a specified number of payments.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstallmentsBasePlanType

Returns a new instance of InstallmentsBasePlanType.



3331
3332
3333
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3331

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

Instance Attribute Details

#account_hold_duration ⇒ String

Optional. Account hold period of the subscription, specified exclusively in days and in ISO 8601 format. Acceptable values are P0D (zero days) to P30D ( 30days). If not specified, the default value is P30D (30 days). Corresponds to the JSON property accountHoldDuration

Returns:

  • (String) 


3288
3289
3290
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3288

def 
  @account_hold_duration
end

#billing_period_duration ⇒ String

Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created. Corresponds to the JSON property billingPeriodDuration

Returns:

  • (String) 


3295
3296
3297
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3295

def billing_period_duration
  @billing_period_duration
end

#committed_payments_count ⇒ Fixnum

Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created. Corresponds to the JSON property committedPaymentsCount

Returns:

  • (Fixnum) 


3301
3302
3303
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3301

def committed_payments_count
  @committed_payments_count
end

#grace_period_duration ⇒ String

Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration. Corresponds to the JSON property gracePeriodDuration

Returns:

  • (String) 


3309
3310
3311
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3309

def grace_period_duration
  @grace_period_duration
end

#proration_mode ⇒ String

The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE. Corresponds to the JSON property prorationMode

Returns:

  • (String) 


3316
3317
3318
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3316

def proration_mode
  @proration_mode
end

#renewal_type ⇒ String

Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created. Corresponds to the JSON property renewalType

Returns:

  • (String) 


3323
3324
3325
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3323

def renewal_type
  @renewal_type
end

#resubscribe_state ⇒ String

Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified. Corresponds to the JSON property resubscribeState

Returns:

  • (String) 


3329
3330
3331
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3329

def resubscribe_state
  @resubscribe_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3336
3337
3338
3339
3340
3341
3342
3343
3344
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3336

def update!(**args)
  @account_hold_duration = args[:account_hold_duration] if args.key?(:account_hold_duration)
  @billing_period_duration = args[:billing_period_duration] if args.key?(:billing_period_duration)
  @committed_payments_count = args[:committed_payments_count] if args.key?(:committed_payments_count)
  @grace_period_duration = args[:grace_period_duration] if args.key?(:grace_period_duration)
  @proration_mode = args[:proration_mode] if args.key?(:proration_mode)
  @renewal_type = args[:renewal_type] if args.key?(:renewal_type)
  @resubscribe_state = args[:resubscribe_state] if args.key?(:resubscribe_state)
end