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.



6148
6149
6150
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6148

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) 


6073
6074
6075
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6073

def acknowledgement_state
  @acknowledgement_state
end

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

Information specific to a subscription in the SUBSCRIPTION_STATE_CANCELED or SUBSCRIPTION_STATE_EXPIRED state. Corresponds to the JSON property canceledStateContext

Returns:



6079
6080
6081
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6079

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:



6084
6085
6086
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6084

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) 


6090
6091
6092
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6090

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) 


6099
6100
6101
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6099

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:



6105
6106
6107
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6105

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) 


6114
6115
6116
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6114

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:



6119
6120
6121
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6119

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) 


6125
6126
6127
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6125

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) 


6131
6132
6133
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6131

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:



6136
6137
6138
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6136

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) 


6141
6142
6143
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6141

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:



6146
6147
6148
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6146

def test_purchase
  @test_purchase
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 6153

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