REST Resource: purchases.voidedpurchases
Stay organized with collections
Save and categorize content based on your preferences.
Resource: VoidedPurchase
A VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.
| JSON representation |
{
"kind": string,
"purchaseToken": string,
"purchaseTimeMillis": string,
"voidedTimeMillis": string,
"orderId": string,
"voidedSource": integer,
"voidedReason": integer,
"voidedQuantity": integer
} |
| Fields |
kind |
string
This kind represents a voided purchase object in the androidpublisher service.
|
purchaseToken |
string
The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use orderId (available starting from version 3 of the API).
|
purchaseTimeMillis |
string (int64 format)
The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970).
|
voidedTimeMillis |
string (int64 format)
The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970).
|
orderId |
string
The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal.
|
voidedSource |
integer
The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google
|
voidedReason |
integer
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 8. Unacknowledged_purchase
|
voidedQuantity |
integer
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.
|
Methods |
|
|
Lists the purchases that were canceled, refunded or charged-back. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003e\u003ccode\u003eVoidedPurchase\u003c/code\u003e resource represents canceled, refunded, or charged-back purchases in Google Play.\u003c/p\u003e\n"],["\u003cp\u003eIncludes details like purchase time, voided time, reason, and initiator (user, developer, or Google).\u003c/p\u003e\n"],["\u003cp\u003eAccessible via the \u003ccode\u003epurchases.voidedpurchases.list\u003c/code\u003e method to retrieve a list of voided purchases.\u003c/p\u003e\n"],["\u003cp\u003eIdentifies purchases uniquely using \u003ccode\u003epurchaseToken\u003c/code\u003e (for older purchases) or \u003ccode\u003eorderId\u003c/code\u003e (for newer and subscription purchases).\u003c/p\u003e\n"],["\u003cp\u003eProvides \u003ccode\u003evoidedSource\u003c/code\u003e and \u003ccode\u003evoidedReason\u003c/code\u003e fields for understanding the context of the void action.\u003c/p\u003e\n"]]],["The document defines a `VoidedPurchase` resource, representing a canceled, refunded, or charged-back purchase. Key information includes the `purchaseToken`, `purchaseTimeMillis`, `voidedTimeMillis`, and `orderId`. It also specifies the `voidedSource` (user, developer, or Google) and `voidedReason`. `voidedQuantity` indicates the quantity in the case of a partial refund. The method `list` is provided to retrieve lists of these voided purchases. The data is represented in JSON format.\n"],null,["# REST Resource: purchases.voidedpurchases\n\n- [Resource: VoidedPurchase](#VoidedPurchase)\n - [JSON representation](#VoidedPurchase.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: VoidedPurchase\n------------------------\n\nA VoidedPurchase resource indicates a purchase that was either canceled/refunded/charged-back.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"purchaseToken\": string, \"purchaseTimeMillis\": string, \"voidedTimeMillis\": string, \"orderId\": string, \"voidedSource\": integer, \"voidedReason\": integer, \"voidedQuantity\": integer } ``` |\n\n| Fields ||\n|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` This kind represents a voided purchase object in the androidpublisher service. |\n| `purchaseToken` | `string` The token which uniquely identifies a one-time purchase or subscription. To uniquely identify subscription renewals use orderId (available starting from version 3 of the API). |\n| `purchaseTimeMillis` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The time at which the purchase was made, in milliseconds since the epoch (Jan 1, 1970). |\n| `voidedTimeMillis` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The time at which the purchase was canceled/refunded/charged-back, in milliseconds since the epoch (Jan 1, 1970). |\n| `orderId` | `string` The order id which uniquely identifies a one-time purchase, subscription purchase, or subscription renewal. |\n| `voidedSource` | `integer` The initiator of voided purchase, possible values are: 0. User 1. Developer 2. Google |\n| `voidedReason` | `integer` 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 8. Unacknowledged_purchase |\n| `voidedQuantity` | `integer` 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. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| ### [list](/android-publisher/api-ref/rest/v3/purchases.voidedpurchases/list) | Lists the purchases that were canceled, refunded or charged-back. |"]]