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.



4774
4775
4776
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4774

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

Instance Attribute Details

#account_hold_duration ⇒ String

Optional. Custom account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. An empty field represents a recommended account hold, calculated as 60 days minus grace period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive. Corresponds to the JSON property accountHoldDuration

Returns:

  • (String) 


4730
4731
4732
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4730

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) 


4737
4738
4739
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4737

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) 


4743
4744
4745
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4743

def committed_payments_count
  @committed_payments_count
end

#grace_period_duration ⇒ String

Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive. Corresponds to the JSON property gracePeriodDuration

Returns:

  • (String) 


4752
4753
4754
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4752

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) 


4759
4760
4761
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4759

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) 


4766
4767
4768
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4766

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) 


4772
4773
4774
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4772

def resubscribe_state
  @resubscribe_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4779
4780
4781
4782
4783
4784
4785
4786
4787
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 4779

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