Method: orders.refund

  • You can refund a user's subscription or in-app purchase order using a POST request to the specified URL.

  • The request requires packageName and orderId as path parameters.

  • An optional revoke query parameter can be used to terminate access to the purchased item and future payments for recurring subscriptions.

  • The request body should be empty, and a successful response will also have an empty body.

  • This operation requires the https://www.googleapis.com/auth/androidpublisher authorization scope.

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.

Sample

The following is a sample request:

curl \
  -X POST \
  'https://androidpublisher.googleapis.com/androidpublisher/v3/applications/com.example.app/orders/1234567890:refund?revoke=true' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [YOUR_ACCESS_TOKEN]'

Authorization scopes

Requires the following OAuth scope:

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