Method: monetization.subscriptions.basePlans.offers.patch

  • This document outlines how to update an existing subscription offer using a PATCH HTTP request.

  • The request requires specific path parameters to identify the subscription offer, including package name, product ID, base plan ID, and offer ID.

  • Query parameters like updateMask and regionsVersion are required, while allowMissing and latencyTolerance are optional.

  • The request body must include a SubscriptionOffer object, and a successful response will also return a SubscriptionOffer object.

  • Authorization is required using the https://www.googleapis.com/auth/androidpublisher OAuth scope.

Updates an existing subscription offer.

HTTP request

PATCH https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{subscriptionOffer.packageName}/subscriptions/{subscriptionOffer.productId}/basePlans/{subscriptionOffer.basePlanId}/offers/{subscriptionOffer.offerId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
subscriptionOffer.packageName

string

Required. Immutable. The package name of the app the parent subscription belongs to.
subscriptionOffer.productId

string

Required. Immutable. The ID of the parent subscription this offer belongs to.
subscriptionOffer.basePlanId

string

Required. Immutable. The ID of the base plan to which this offer is an extension.
subscriptionOffer.offerId

string

Required. Immutable. Unique ID of this subscription offer. Must be unique within the base plan.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to be updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
regionsVersion

object (RegionsVersion)

Required. The version of the available regions being used for the subscriptionOffer.
allowMissing

boolean

Optional. If set to true, and the subscription offer with the given packageName, productId, basePlanId and offerId doesn't exist, an offer will be created.

If a new offer is created, updateMask is ignored.
latencyTolerance

enum (ProductUpdateLatencyTolerance)

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

Request body

The request body contains an instance of SubscriptionOffer.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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