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.



786
787
788
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 786

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

Instance Attribute Details

#account_hold_durationString

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

Returns:

  • (String)


738
739
740
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 738

def 
  @account_hold_duration
end

#billing_period_durationString

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)


745
746
747
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 745

def billing_period_duration
  @billing_period_duration
end

#grace_period_durationString

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)


753
754
755
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 753

def grace_period_duration
  @grace_period_duration
end

#legacy_compatibleBoolean 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)


761
762
763
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 761

def legacy_compatible
  @legacy_compatible
end

#legacy_compatible_subscription_offer_idString

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)


771
772
773
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 771

def legacy_compatible_subscription_offer_id
  @legacy_compatible_subscription_offer_id
end

#proration_modeString

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)


778
779
780
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 778

def proration_mode
  @proration_mode
end

#resubscribe_stateString

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)


784
785
786
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 784

def resubscribe_state
  @resubscribe_state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



791
792
793
794
795
796
797
798
799
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 791

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