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



1524
1525
1526
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1524

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) 


1390
1391
1392
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1390

def auto_renewing
  @auto_renewing
end

#cancel_reason ⇒ Fixnum

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

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

Returns:

  • (Fixnum) 


1402
1403
1404
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1402

def cancel_reason
  @cancel_reason
end

#cancel_survey_result ⇒ Google::Apis::AndroidpublisherV2::SubscriptionCancelSurveyResult

Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). Corresponds to the JSON property cancelSurveyResult

Returns:



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

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


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

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) 


1420
1421
1422
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1420

def developer_payload
  @developer_payload
end

#email_address ⇒ String

The email address of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. Corresponds to the JSON property emailAddress

Returns:

  • (String) 


1426
1427
1428
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1426

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


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

def expiry_time_millis
  @expiry_time_millis
end

#family_name ⇒ String

The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. Corresponds to the JSON property familyName

Returns:

  • (String) 


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

def family_name
  @family_name
end

#given_name ⇒ String

The given name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. Corresponds to the JSON property givenName

Returns:

  • (String) 


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

def given_name
  @given_name
end

#kind ⇒ String

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

Returns:

  • (String) 


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

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) 


1464
1465
1466
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1464

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) 


1470
1471
1472
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1470

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) 


1478
1479
1480
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1478

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) 


1485
1486
1487
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1485

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) 


1491
1492
1493
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1491

def price_currency_code
  @price_currency_code
end

#profile_id ⇒ String

The profile id of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. Corresponds to the JSON property profileId

Returns:

  • (String) 


1497
1498
1499
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1497

def profile_id
  @profile_id
end

#profile_name ⇒ String

The profile name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. Corresponds to the JSON property profileName

Returns:

  • (String) 


1503
1504
1505
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1503

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


1511
1512
1513
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1511

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) 


1516
1517
1518
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1516

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) 


1522
1523
1524
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1522

def user_cancellation_time_millis
  @user_cancellation_time_millis
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
 
# File 'generated/google/apis/androidpublisher_v2/classes.rb', line 1529

def update!(**args)
  @auto_renewing = args[:auto_renewing] if args.key?(:auto_renewing)
  @cancel_reason = args[:cancel_reason] if args.key?(:cancel_reason)
  @cancel_survey_result = args[:cancel_survey_result] if args.key?(:cancel_survey_result)
  @country_code = args[:country_code] if args.key?(:country_code)
  @developer_payload = args[:developer_payload] if args.key?(:developer_payload)
  @email_address = args[:email_address] if args.key?(:email_address)
  @expiry_time_millis = args[:expiry_time_millis] if args.key?(:expiry_time_millis)
  @family_name = args[:family_name] if args.key?(:family_name)
  @given_name = args[:given_name] if args.key?(:given_name)
  @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)
  @profile_id = args[:profile_id] if args.key?(:profile_id)
  @profile_name = args[:profile_name] if args.key?(:profile_name)
  @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