Google Play Android Developer API . purchases . voidedpurchases

close()

Close httplib2 connections.

list(packageName, endTime=None, includeQuantityBasedPartialRefund=None, maxResults=None, startIndex=None, startTime=None, token=None, type=None, x__xgafv=None)

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

Args:
  packageName: string, The package name of the application for which voided purchases need to be returned (for example, 'com.some.thing'). (required)
  endTime: string, 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.
  includeQuantityBasedPartialRefund: boolean, Optional. Whether to include voided purchases of quantity-based partial refunds, which are applicable only to multi-quantity purchases. If true, additional voided purchases may be returned with voidedQuantity that indicates the refund quantity of a quantity-based partial refund. The default value is false.
  maxResults: integer, Defines how many results the list operation should return. The default number depends on the resource collection.
  startIndex: integer, Defines the index of the first element to return. This can only be used if indexed paging is enabled.
  startTime: string, 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, Defines the token of the page to return, usually taken from TokenPagination. This can only be used if token paging is enabled.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for the voidedpurchases.list API.
  "pageInfo": { # Information about the current page. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. # General pagination information.
    "resultPerPage": 42, # Maximum number of results returned in one page. ! The number of results included in the API response.
    "startIndex": 42, # Index of the first result returned in the current page.
    "totalResults": 42, # Total number of results available on the backend ! The total number of results in the result set.
  },
  "tokenPagination": { # Pagination information returned by a List operation when token pagination is enabled. List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned. When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either next_page_token or previous_page_token to access another page. # Pagination information for token pagination.
    "nextPageToken": "A String", # Tokens to pass to the standard list field 'page_token'. Whenever available, tokens are preferred over manipulating start_index.
    "previousPageToken": "A String",
  },
  "voidedPurchases": [
    { # A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
      "kind": "A String", # This kind represents a voided purchase object in the androidpublisher service.
      "orderId": "A String", # The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.
      "purchaseTimeMillis": "A String", # The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
      "purchaseToken": "A 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).
      "voidedQuantity": 42, # The voided quantity as the result of a quantity-based partial refund. Voided purchases of quantity-based partial refunds may only be returned when includeQuantityBasedPartialRefund is set to true.
      "voidedReason": 42, # 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": 42, # The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google
      "voidedTimeMillis": "A String", # The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
    },
  ],
}