Purchase

public class Purchase
extends Object

java.lang.Object
   ↳ com.android.billingclient.api.Purchase

Represents an in-app billing purchase.

Summary

Nested classes

@interface Purchase.PurchaseState

Possible purchase states. 

Public constructors

Purchase(String jsonPurchaseInfo, String signature)

Public methods

boolean equals(Object o)
AccountIdentifiers getAccountIdentifiers()

Returns account identifiers that were provided when the purchase was made.

String getDeveloperPayload()

Returns the payload specified when the purchase was acknowledged or consumed.

String getOrderId()

Returns a unique order identifier for the transaction.

String getOriginalJson()

Returns a String in JSON format that contains details about the purchase order.

String getPackageName()

Returns the application package from which the purchase originated.

List<String> getProducts()

Returns the product Ids. Included in documentation by the annotations: @Annotations.ProductDetails

int getPurchaseState()

Returns one of Purchase.PurchaseState indicating the state of the purchase.

long getPurchaseTime()

Returns the time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).

String getPurchaseToken()

Returns a token that uniquely identifies a purchase for a given item and user pair.

int getQuantity()

Returns the quantity of the purchased product.

String getSignature()

Returns String containing the signature of the purchase data that was signed with the private key of the developer.

ArrayList<String> getSkus()

This method is deprecated. Use getProducts() instead.

int hashCode()
boolean isAcknowledged()

Indicates whether the purchase has been acknowledged.

boolean isAutoRenewing()

Indicates whether the subscription renews automatically.

String toString()

Inherited methods

Public constructors

Purchase

public Purchase (String jsonPurchaseInfo, 
                String signature)

Parameters
jsonPurchaseInfo String

signature String

Throws
JSONException

Public methods

equals

public boolean equals (Object o)

Parameters
o Object

Returns
boolean

getAccountIdentifiers

public AccountIdentifiers getAccountIdentifiers ()

Returns account identifiers that were provided when the purchase was made.

Returns
AccountIdentifiers

getDeveloperPayload

public String getDeveloperPayload ()

Returns the payload specified when the purchase was acknowledged or consumed.

Returns
String

getOrderId

public String getOrderId ()

Returns a unique order identifier for the transaction. This identifier corresponds to the Google order ID.

For subscription renewals, this method returns the order ID of the initial order. For example, instead of GPA.1234-5678-9012-34567..0 indicating the first renewal order, GPA.1234-5678-9012-34567 will be returned.

Returns
String

getOriginalJson

public String getOriginalJson ()

Returns a String in JSON format that contains details about the purchase order.

Returns
String

getPackageName

public String getPackageName ()

Returns the application package from which the purchase originated.

Returns
String

getProducts

public List<String> getProducts ()
Included in documentation by the annotations: @Annotations.ProductDetails

Returns the product Ids.

Returns
List<String>

getPurchaseState

public int getPurchaseState ()

Returns one of Purchase.PurchaseState indicating the state of the purchase.

Returns
int

getPurchaseTime

public long getPurchaseTime ()

Returns the time the product was purchased, in milliseconds since the epoch (Jan 1, 1970).

For subscriptions, this is the subscription signup time. It won't change after renewal.

Returns
long

getPurchaseToken

public String getPurchaseToken ()

Returns a token that uniquely identifies a purchase for a given item and user pair.

Returns
String

getQuantity

public int getQuantity ()

Returns the quantity of the purchased product.

Always returns 1 for BillingClient.SkuType.SUBS items; could be greater than 1 for BillingClient.SkuType.INAPP items.

Returns
int

getSignature

public String getSignature ()

Returns String containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme.

Returns
String

getSkus

public ArrayList<String> getSkus ()

This method is deprecated.
Use getProducts() instead.

Returns the product Ids.

Returns
ArrayList<String>

hashCode

public int hashCode ()

Returns
int

See also:

isAcknowledged

public boolean isAcknowledged ()

Indicates whether the purchase has been acknowledged.

Returns
boolean

isAutoRenewing

public boolean isAutoRenewing ()

Indicates whether the subscription renews automatically. If true, the subscription is active, and will automatically renew on the next billing date. If false, indicates that the user has canceled the subscription. The user has access to subscription content until the next billing date and will lose access at that time unless they re-enable automatic renewal (or manually renew, as described in Manual Renewal). If you offer a grace period, this value remains set to true for all subscriptions, as long as the grace period has not lapsed. The next billing date is extended dynamically every day until the end of the grace period or until the user fixes their payment method.

Returns
boolean

toString

public String toString ()

Returns
String