Method: purchases.voidedpurchases.list

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

HTTP request

GET https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/purchases/voidedpurchases

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

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

Query parameters

Parameters
pageSelection.maxResults

integer (uint32 format)

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

pageSelection.startIndex

integer (uint32 format)

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

pageSelection.token

string

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

startTime

string (int64 format)

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.

endTime

string (int64 format)

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.

type

integer

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for the voidedpurchases.list API.

JSON representation
{
  "pageInfo": {
    object (PageInfo)
  },
  "tokenPagination": {
    object (TokenPagination)
  },
  "voidedPurchases": [
    {
      object (VoidedPurchase)
    }
  ]
}
Fields
pageInfo

object (PageInfo)

General pagination information.

tokenPagination

object (TokenPagination)

Pagination information for token pagination.

voidedPurchases[]

object (VoidedPurchase)

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidpublisher

PageSelection

Type of the pageSelection request parameter that defines which and how many results a apks.list operation should return.

JSON representation
{
  "maxResults": integer,
  "startIndex": integer,
  "token": string
}
Fields
maxResults

integer (uint32 format)

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

startIndex

integer (uint32 format)

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

token

string

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