Method: orders.refund
Stay organized with collections
Save and categorize content based on your preferences.
Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.
HTTP request
POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/orders/{orderId}:refund
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
packageName |
string
The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').
|
orderId |
string
The order ID provided to the user when the subscription or in-app order was purchased.
|
Query parameters
| Parameters |
revoke |
boolean
Whether to revoke the purchased item. If set to true, access to the subscription or in-app item will be terminated immediately. If the item is a recurring subscription, all future payments will also be terminated. Consumed in-app items need to be handled by developer's app. (optional).
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidpublisher
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 2024-12-17 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 2024-12-17 UTC."],[[["This operation refunds a user's subscription or in-app purchase order, provided the order is less than 3 years old."],["It uses an HTTP POST request to the specified URL with path parameters for package name and order ID."],["An optional query parameter \"revoke\" can be included to immediately terminate access to the purchased item."],["The request body should be empty, and a successful response will also be empty."],["Authorization requires the `https://www.googleapis.com/auth/androidpublisher` OAuth scope."]]],["This document details how to refund a user's subscription or in-app purchase via a `POST` HTTP request. The request URL requires the application's `packageName` and the `orderId` as path parameters. An optional `revoke` query parameter determines if the purchased item should be immediately revoked. The request body must be empty, and a successful response also returns an empty body. Orders over 3 years old are ineligible for refunds. This action requires the `https://www.googleapis.com/auth/androidpublisher` authorization scope.\n"]]