Class: Google::Apis::AndroidpublisherV3::SubscriptionPurchaseV2

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

Indicates the status of a user's subscription purchase.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SubscriptionPurchaseV2

Returns a new instance of SubscriptionPurchaseV2.



3676
3677
3678
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3676

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

Instance Attribute Details

#acknowledgement_state ⇒ String

The acknowledgement state of the subscription. Corresponds to the JSON property acknowledgementState

Returns:

  • (String) 


3602
3603
3604
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3602

def acknowledgement_state
  @acknowledgement_state
end

#canceled_state_context ⇒ Google::Apis::AndroidpublisherV3::CanceledStateContext

Information specific to a subscription in canceled state. Corresponds to the JSON property canceledStateContext

Returns:



3607
3608
3609
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3607

def canceled_state_context
  @canceled_state_context
end

#external_account_identifiers ⇒ Google::Apis::AndroidpublisherV3::ExternalAccountIdentifiers

User account identifier in the third-party service. Corresponds to the JSON property externalAccountIdentifiers

Returns:



3612
3613
3614
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3612

def 
  @external_account_identifiers
end

#kind ⇒ String

This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service. Corresponds to the JSON property kind

Returns:

  • (String) 


3618
3619
3620
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3618

def kind
  @kind
end

#latest_order_id ⇒ String

The order id of the latest order associated with the purchase of the subscription. For autoRenewing subscription, this is the order id of signup order if it is not renewed yet, or the last recurring order id (success, pending, or declined order). For prepaid subscription, this is the order id associated with the queried purchase token. Corresponds to the JSON property latestOrderId

Returns:

  • (String) 


3627
3628
3629
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3627

def latest_order_id
  @latest_order_id
end

#line_items ⇒ Array<Google::Apis::AndroidpublisherV3::SubscriptionPurchaseLineItem>

Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan. Corresponds to the JSON property lineItems

Returns:



3633
3634
3635
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3633

def line_items
  @line_items
end

#linked_purchase_token ⇒ String

The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/ downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid.

  • Topup a prepaid subscription. Corresponds to the JSON property linkedPurchaseToken

Returns:

  • (String) 


3642
3643
3644
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3642

def linked_purchase_token
  @linked_purchase_token
end

#paused_state_context ⇒ Google::Apis::AndroidpublisherV3::PausedStateContext

Information specific to a subscription in paused state. Corresponds to the JSON property pausedStateContext

Returns:



3647
3648
3649
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3647

def paused_state_context
  @paused_state_context
end

#region_code ⇒ String

ISO 3166-1 alpha-2 billing country/region code of the user at the time the subscription was granted. Corresponds to the JSON property regionCode

Returns:

  • (String) 


3653
3654
3655
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3653

def region_code
  @region_code
end

#start_time ⇒ String

Time at which the subscription was granted. Not set for pending subscriptions ( subscription was created but awaiting payment during signup). Corresponds to the JSON property startTime

Returns:

  • (String) 


3659
3660
3661
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3659

def start_time
  @start_time
end

#subscribe_with_google_info ⇒ Google::Apis::AndroidpublisherV3::SubscribeWithGoogleInfo

Information associated with purchases made with 'Subscribe with Google'. Corresponds to the JSON property subscribeWithGoogleInfo

Returns:



3664
3665
3666
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3664

def subscribe_with_google_info
  @subscribe_with_google_info
end

#subscription_state ⇒ String

The current state of the subscription. Corresponds to the JSON property subscriptionState

Returns:

  • (String) 


3669
3670
3671
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3669

def subscription_state
  @subscription_state
end

#test_purchase ⇒ Google::Apis::AndroidpublisherV3::TestPurchase

Whether this subscription purchase is a test purchase. Corresponds to the JSON property testPurchase

Returns:



3674
3675
3676
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3674

def test_purchase
  @test_purchase
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 3681

def update!(**args)
  @acknowledgement_state = args[:acknowledgement_state] if args.key?(:acknowledgement_state)
  @canceled_state_context = args[:canceled_state_context] if args.key?(:canceled_state_context)
  @external_account_identifiers = args[:external_account_identifiers] if args.key?(:external_account_identifiers)
  @kind = args[:kind] if args.key?(:kind)
  @latest_order_id = args[:latest_order_id] if args.key?(:latest_order_id)
  @line_items = args[:line_items] if args.key?(:line_items)
  @linked_purchase_token = args[:linked_purchase_token] if args.key?(:linked_purchase_token)
  @paused_state_context = args[:paused_state_context] if args.key?(:paused_state_context)
  @region_code = args[:region_code] if args.key?(:region_code)
  @start_time = args[:start_time] if args.key?(:start_time)
  @subscribe_with_google_info = args[:subscribe_with_google_info] if args.key?(:subscribe_with_google_info)
  @subscription_state = args[:subscription_state] if args.key?(:subscription_state)
  @test_purchase = args[:test_purchase] if args.key?(:test_purchase)
end