Class: Google::Apis::AndroidpublisherV3::AutoRenewingBasePlanType

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 a base plan that automatically renews at the end of its subscription period.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AutoRenewingBasePlanType

Returns a new instance of AutoRenewingBasePlanType.



890
891
892
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 890

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) 


841
842
843
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 841

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) 


848
849
850
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 848

def billing_period_duration
  @billing_period_duration
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) 


857
858
859
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 857

def grace_period_duration
  @grace_period_duration
end

#legacy_compatible ⇒ Boolean Also known as: legacy_compatible?

Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription. Corresponds to the JSON property legacyCompatible

Returns:

  • (Boolean) 


865
866
867
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 865

def legacy_compatible
  @legacy_compatible
end

#legacy_compatible_subscription_offer_id ⇒ String

Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string. Corresponds to the JSON property legacyCompatibleSubscriptionOfferId

Returns:

  • (String) 


875
876
877
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 875

def legacy_compatible_subscription_offer_id
  @legacy_compatible_subscription_offer_id
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) 


882
883
884
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 882

def proration_mode
  @proration_mode
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) 


888
889
890
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 888

def resubscribe_state
  @resubscribe_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



895
896
897
898
899
900
901
902
903
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 895

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)
  @grace_period_duration = args[:grace_period_duration] if args.key?(:grace_period_duration)
  @legacy_compatible = args[:legacy_compatible] if args.key?(:legacy_compatible)
  @legacy_compatible_subscription_offer_id = args[:legacy_compatible_subscription_offer_id] if args.key?(:legacy_compatible_subscription_offer_id)
  @proration_mode = args[:proration_mode] if args.key?(:proration_mode)
  @resubscribe_state = args[:resubscribe_state] if args.key?(:resubscribe_state)
end