Purchases.voidedpurchases: list

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

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
packageName string The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing').
Optional query parameters
endTime long 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 unsigned integer The maximum number of voided purchases that appear in the response. By default, this value is 1000. Note that the maximum value for this parameter is also 1000. 
startTime long 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 A continuation token from a previous response, allowing you to view more results.
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.

Authorization

This request requires authorization with the following scope:

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

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{
  "tokenPagination": {
    "nextPageToken": string
  },
  "voidedPurchases": [
    {
      "kind": "androidpublisher#voidedPurchase",
      "purchaseToken": string,
      "purchaseTimeMillis": long,
      "voidedTimeMillis": long,
      "orderId": string,
      "voidedSource": integer,
      "voidedReason": integer
    }
  ]
}
Property name Value Description Notes
tokenPagination nested object
tokenPagination.nextPageToken string Pagination token that can be passed as token parameter for the next request to continue reading more results.
voidedPurchases[] list
voidedPurchases[].kind string This kind represents a voided purchase object in the androidpublisher service.
voidedPurchases[].purchaseToken string 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).
voidedPurchases[].purchaseTimeMillis long The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
voidedPurchases[].voidedTimeMillis long The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
voidedPurchases[].orderId string The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.
voidedPurchases[].voidedSource integer The initiator of voided purchase, possible values are:
  1. User
  2. Developer
  3. Google
voidedPurchases[].voidedReason integer The reason why the purchase was voided, possible values are:
  1. Other
  2. Remorse
  3. Not_received
  4. Defective
  5. Accidental_purchase
  6. Fraud
  7. Friendly_fraud
  8. Chargeback