Method: monetization.onetimeproducts.purchaseOptions.offers.cancel

  • This page provides information on how to cancel a one-time product offer using an HTTP POST request.

  • Canceling an offer requires specifying the package name, product ID, purchase option ID, and the offer ID in the URL.

  • The request body can optionally include a latencyTolerance field to control update propagation.

  • A successful response will return an instance of OneTimeProductOffer.

  • The process requires the https://www.googleapis.com/auth/androidpublisher authorization scope.

Cancels a one-time product offer.

HTTP request

POST https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{packageName}/oneTimeProducts/{productId}/purchaseOptions/{purchaseOptionId}/offers/{offerId}:cancel

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
packageName

string

Required. The parent app (package name) of the offer to cancel.
productId

string

Required. The parent one-time product (ID) of the offer to cancel.
purchaseOptionId

string

Required. The parent purchase option (ID) of the offer to cancel.
offerId

string

Required. The offer ID of the offer to cancel.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "latencyTolerance": enum (ProductUpdateLatencyTolerance)
}
Fields
latencyTolerance

enum (ProductUpdateLatencyTolerance)

Optional. The latency tolerance for the propagation of this update. Defaults to latency-sensitive.

Response body

If successful, the response body contains an instance of OneTimeProductOffer.

Authorization scopes

Requires the following OAuth scope:

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