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.



9194
9195
9196
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9194

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) 


9096
9097
9098
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9096

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:



9102
9103
9104
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9102

def canceled_state_context
  @canceled_state_context
end

#etag ⇒ String

Entity tag representing the current state of the subscription. The developer will provide this etag for subscription actions. This etag is always present for auto-renewing and prepaid subscriptions. Corresponds to the JSON property etag

Returns:

  • (String) 


9109
9110
9111
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9109

def etag
  @etag
end

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

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

Returns:



9114
9115
9116
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9114

def 
  @external_account_identifiers
end

#in_grace_period_state_context ⇒ Google::Apis::AndroidpublisherV3::InGracePeriodStateContext

Additional context around subscriptions in IN_GRACE_PERIOD state. Corresponds to the JSON property inGracePeriodStateContext

Returns:



9119
9120
9121
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9119

def in_grace_period_state_context
  @in_grace_period_state_context
end

#kind ⇒ String

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

Returns:

  • (String) 


9125
9126
9127
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9125

def kind
  @kind
end

#latest_order_id ⇒ String

Deprecated: Use line_items.latest_successful_order_id instead. 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) 


9135
9136
9137
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9135

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:



9141
9142
9143
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9141

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) 


9150
9151
9152
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9150

def linked_purchase_token
  @linked_purchase_token
end

#on_hold_state_context ⇒ Google::Apis::AndroidpublisherV3::OnHoldStateContext

Additional context around subscriptions in ON_HOLD state. Corresponds to the JSON property onHoldStateContext

Returns:



9155
9156
9157
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9155

def on_hold_state_context
  @on_hold_state_context
end

#out_of_app_purchase_context ⇒ Google::Apis::AndroidpublisherV3::OutOfAppPurchaseContext

Information specific to an out of app purchase. Corresponds to the JSON property outOfAppPurchaseContext

Returns:



9160
9161
9162
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9160

def out_of_app_purchase_context
  @out_of_app_purchase_context
end

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

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

Returns:



9165
9166
9167
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9165

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) 


9171
9172
9173
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9171

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) 


9177
9178
9179
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9177

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:



9182
9183
9184
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9182

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) 


9187
9188
9189
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9187

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:



9192
9193
9194
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9192

def test_purchase
  @test_purchase
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 9199

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)
  @etag = args[:etag] if args.key?(:etag)
  @external_account_identifiers = args[:external_account_identifiers] if args.key?(:external_account_identifiers)
  @in_grace_period_state_context = args[:in_grace_period_state_context] if args.key?(:in_grace_period_state_context)
  @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)
  @on_hold_state_context = args[:on_hold_state_context] if args.key?(:on_hold_state_context)
  @out_of_app_purchase_context = args[:out_of_app_purchase_context] if args.key?(:out_of_app_purchase_context)
  @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