Class: Google::Apis::AndroidpublisherV2::SubscriptionPurchase

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/androidpublisher_v2/classes.rb,
generated/google/apis/androidpublisher_v2/representations.rb,
generated/google/apis/androidpublisher_v2/representations.rb

Overview

A SubscriptionPurchase resource indicates the status of a user's subscription purchase.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SubscriptionPurchase

Returns a new instance of SubscriptionPurchase



1457
1458
1459
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1457

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

Instance Attribute Details

#auto_renewing ⇒ Boolean Also known as: auto_renewing?

Whether the subscription will automatically be renewed when it reaches its current expiry time. Corresponds to the JSON property autoRenewing

Returns:

  • (Boolean) 


1359
1360
1361
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1359

def auto_renewing
  @auto_renewing
end

#cancel_reason ⇒ Fixnum

The reason why a subscription was cancelled or is not auto-renewing. Possible values are:

  • User cancelled the subscription
  • Subscription was cancelled by the system, for example because of a billing problem
  • Subscription was replaced with a new subscription
  • Subscription was cancelled by the developer Corresponds to the JSON property cancelReason

Returns:

  • (Fixnum) 


1371
1372
1373
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1371

def cancel_reason
  @cancel_reason
end

#country_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 countryCode

Returns:

  • (String) 


1377
1378
1379
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1377

def country_code
  @country_code
end

#developer_payload ⇒ String

A developer-specified string that contains supplemental information about an order. Corresponds to the JSON property developerPayload

Returns:

  • (String) 


1383
1384
1385
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1383

def developer_payload
  @developer_payload
end

#expiry_time_millis ⇒ Fixnum

Time at which the subscription will expire, in milliseconds since the Epoch. Corresponds to the JSON property expiryTimeMillis

Returns:

  • (Fixnum) 


1388
1389
1390
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1388

def expiry_time_millis
  @expiry_time_millis
end

#kind ⇒ String

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

Returns:

  • (String) 


1394
1395
1396
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1394

def kind
  @kind
end

#linked_purchase_token ⇒ String

The purchase token of the originating purchase if this subscription is one of the following:

  • Re-signup of a canceled but non-lapsed subscription
  • Upgrade/downgrade from a previous subscription For example, suppose a user originally signs up and you receive purchase token X, then the user cancels and goes through the resignup flow (before their subscription lapses) and you receive purchase token Y, and finally the user upgrades their subscription and you receive purchase token Z. If you call this API with purchase token Z, this field will be set to Y. If you call this API with purchase token Y, this field will be set to X. If you call this API with purchase token X, this field will not be set. Corresponds to the JSON property linkedPurchaseToken

Returns:

  • (String) 


1409
1410
1411
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1409

def linked_purchase_token
  @linked_purchase_token
end

#order_id ⇒ String

The order id of the latest recurring order associated with the purchase of the subscription. Corresponds to the JSON property orderId

Returns:

  • (String) 


1415
1416
1417
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1415

def order_id
  @order_id
end

#payment_state ⇒ Fixnum

The payment state of the subscription. Possible values are:

  • Payment pending
  • Payment received
  • Free trial Corresponds to the JSON property paymentState

Returns:

  • (Fixnum) 


1423
1424
1425
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1423

def payment_state
  @payment_state
end

#price_amount_micros ⇒ Fixnum

Price of the subscription, not including tax. Price is expressed in micro- units, where 1,000,000 micro-units represents one unit of the currency. For example, if the subscription price is €1.99, price_amount_micros is 1990000. Corresponds to the JSON property priceAmountMicros

Returns:

  • (Fixnum) 


1430
1431
1432
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1430

def price_amount_micros
  @price_amount_micros
end

#price_currency_code ⇒ String

ISO 4217 currency code for the subscription price. For example, if the price is specified in British pounds sterling, price_currency_code is "GBP". Corresponds to the JSON property priceCurrencyCode

Returns:

  • (String) 


1436
1437
1438
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1436

def price_currency_code
  @price_currency_code
end

#purchase_type ⇒ Fixnum

The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are:

  • Test (i.e. purchased from a license testing account) Corresponds to the JSON property purchaseType

Returns:

  • (Fixnum) 


1444
1445
1446
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1444

def purchase_type
  @purchase_type
end

#start_time_millis ⇒ Fixnum

Time at which the subscription was granted, in milliseconds since the Epoch. Corresponds to the JSON property startTimeMillis

Returns:

  • (Fixnum) 


1449
1450
1451
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1449

def start_time_millis
  @start_time_millis
end

#user_cancellation_time_millis ⇒ Fixnum

The time at which the subscription was canceled by the user, in milliseconds since the epoch. Only present if cancelReason is 0. Corresponds to the JSON property userCancellationTimeMillis

Returns:

  • (Fixnum) 


1455
1456
1457
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1455

def user_cancellation_time_millis
  @user_cancellation_time_millis
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1462

def update!(**args)
  @auto_renewing = args[:auto_renewing] if args.key?(:auto_renewing)
  @cancel_reason = args[:cancel_reason] if args.key?(:cancel_reason)
  @country_code = args[:country_code] if args.key?(:country_code)
  @developer_payload = args[:developer_payload] if args.key?(:developer_payload)
  @expiry_time_millis = args[:expiry_time_millis] if args.key?(:expiry_time_millis)
  @kind = args[:kind] if args.key?(:kind)
  @linked_purchase_token = args[:linked_purchase_token] if args.key?(:linked_purchase_token)
  @order_id = args[:order_id] if args.key?(:order_id)
  @payment_state = args[:payment_state] if args.key?(:payment_state)
  @price_amount_micros = args[:price_amount_micros] if args.key?(:price_amount_micros)
  @price_currency_code = args[:price_currency_code] if args.key?(:price_currency_code)
  @purchase_type = args[:purchase_type] if args.key?(:purchase_type)
  @start_time_millis = args[:start_time_millis] if args.key?(:start_time_millis)
  @user_cancellation_time_millis = args[:user_cancellation_time_millis] if args.key?(:user_cancellation_time_millis)
end