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.



10287
10288
10289
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10287

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) 


10199
10200
10201
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10199

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:



10205
10206
10207
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10205

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) 


10212
10213
10214
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10212

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:



10217
10218
10219
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10217

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:



10222
10223
10224
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10222

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) 


10228
10229
10230
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10228

def kind
  @kind
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:



10234
10235
10236
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10234

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) 


10243
10244
10245
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10243

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:



10248
10249
10250
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10248

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:



10253
10254
10255
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10253

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:



10258
10259
10260
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10258

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) 


10264
10265
10266
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10264

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) 


10270
10271
10272
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10270

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:



10275
10276
10277
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10275

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) 


10280
10281
10282
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10280

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:



10285
10286
10287
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10285

def test_purchase
  @test_purchase
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
 
# File 'lib/google/apis/androidpublisher_v3/classes.rb', line 10292

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