/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

GET

purchases

Lists the purchases that were canceled, refunded or charged-back.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "pageInfo": {
        "resultPerPage": 0,
        "startIndex": 0,
        "totalResults": 0
    },
    "tokenPagination": {
        "nextPageToken": "string",
        "previousPageToken": "string"
    },
    "voidedPurchases": [
        {
            "kind": "string",
            "orderId": "string",
            "purchaseTimeMillis": "string",
            "purchaseToken": "string",
            "voidedReason": 0,
            "voidedSource": 0,
            "voidedTimeMillis": "string"
        }
    ]
}

Request

Path Params

packageName

string

required

The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').

Query Params

endTime

string

optional

The time, in milliseconds since the Epoch, of the newest voided purchase that you want to see in the response. The value of this parameter cannot be greater than the current time and is ignored if a pagination token is set. Default value is current time. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

maxResults

integer

optional

Defines how many results the list operation should return. The default number depends on the resource collection.

startIndex

integer

optional

Defines the index of the first element to return. This can only be used if indexed paging is enabled.

startTime

string

optional

The time, in milliseconds since the Epoch, of the oldest voided purchase that you want to see in the response. The value of this parameter cannot be older than 30 days and is ignored if a pagination token is set. Default value is current time minus 30 days. Note: This filter is applied on the time at which the record is seen as voided by our systems and not the actual voided time returned in the response.

token

string

optional

Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.

type

integer

optional

The type of voided purchases that you want to see in the response. Possible values are: 0. Only voided in-app product purchases will be returned in the response. This is the default value. 1. Both voided in-app purchases and voided subscription purchases will be returned in the response. Note: Before requesting to receive voided subscription purchases, you must switch to use orderId in the response which uniquely identifies one-time purchases and subscriptions. Otherwise, you will receive multiple subscription orders with the same PurchaseToken, because subscription renewal orders share the same PurchaseToken.

Responses

🟢200Successful response

application/json

Body

Response for the voidedpurchases.list API.

pageInfo

object (PageInfo)

optional

General pagination information.

resultPerPage

integer <int32>

optional

Maximum number of results returned in one page. ! The number of results included in the API response.

startIndex

integer <int32>

optional

Index of the first result returned in the current page.

totalResults

integer <int32>

optional

Total number of results available on the backend ! The total number of results in the result set.

tokenPagination

object (TokenPagination)

optional

Pagination information for token pagination.

nextPageToken

string

optional

Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index.

previousPageToken

string

optional

voidedPurchases

array[object (VoidedPurchase) {7}]

optional

kind

string

optional

This kind represents a voided purchase object in the androidpublisher service.

orderId

string

optional

The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.

purchaseTimeMillis

string <int64>

optional

The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).

purchaseToken

string

optional

The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use order_id (available starting from version 3 of the API).

voidedReason

integer <int32>

optional

The reason why the purchase was voided, possible values are: 0. Other 1. Remorse 2. Not_received 3. Defective 4. Accidental_purchase 5. Fraud 6. Friendly_fraud 7. Chargeback

voidedSource

integer <int32>

optional

The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google

voidedTimeMillis

string <int64>

optional

The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).

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

/androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}

/androidpublisher/v3/applications/{packageName}/reviews