/androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}

GET

purchases

Checks the purchase and consumption status of an inapp item.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://androidpublisher.googleapis.com//androidpublisher/v3/applications//purchases/products//tokens/'

Response Example

{
    "acknowledgementState": 0,
    "consumptionState": 0,
    "developerPayload": "string",
    "kind": "string",
    "obfuscatedExternalAccountId": "string",
    "obfuscatedExternalProfileId": "string",
    "orderId": "string",
    "productId": "string",
    "purchaseState": 0,
    "purchaseTimeMillis": "string",
    "purchaseToken": "string",
    "purchaseType": 0,
    "quantity": 0,
    "regionCode": "string"
}

Request

Path Params

packageName

string

required

The package name of the application the inapp product was sold in (for example, 'com.some.thing').

productId

string

required

The inapp product SKU (for example, 'com.some.thing.inapp1').

token

string

required

The token provided to the user's device when the inapp product was purchased.

Responses

🟢200Successful response

application/json

Body

A ProductPurchase resource indicates the status of a user's inapp product purchase.

acknowledgementState

integer <int32>

optional

The acknowledgement state of the inapp product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged

consumptionState

integer <int32>

optional

The consumption state of the inapp product. Possible values are: 0. Yet to be consumed 1. Consumed

developerPayload

string

optional

A developer-specified string that contains supplemental information about an order.

kind

string

optional

This kind represents an inappPurchase object in the androidpublisher service.

obfuscatedExternalAccountId

string

optional

An obfuscated version of the id that is uniquely associated with the user's account in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made.

obfuscatedExternalProfileId

string

optional

An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made.

orderId

string

optional

The order id associated with the purchase of the inapp product.

productId

string

optional

The inapp product SKU. May not be present.

purchaseState

integer <int32>

optional

The purchase state of the order. Possible values are: 0. Purchased 1. Canceled 2. Pending

purchaseTimeMillis

string <int64>

optional

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

purchaseToken

string

optional

The purchase token generated to identify this purchase. May not be present.

purchaseType

integer <int32>

optional

The type of purchase of the inapp product. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: 0. Test (i.e. purchased from a license testing account) 1. Promo (i.e. purchased using a promo code) 2. Rewarded (i.e. from watching a video ad instead of paying)

quantity

integer <int32>

optional

The quantity associated with the purchase of the inapp product. If not present, the quantity is 1.

regionCode

string

optional

ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted.

Modified at 2022-09-11 20:51:56

/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}:archive

/androidpublisher/v3/applications/{packageName}/purchases/products/{productId}/tokens/{token}:acknowledge