Method: monetization.subscriptions.patch

  • The request to update a subscription uses the PATCH method and targets a specific URL structure including package and product IDs.

  • Path parameters like packageName and productId are essential for identifying the subscription to be updated.

  • Query parameters such as updateMask, regionsVersion, and optional parameters like allowMissing and latencyTolerance control the update process.

  • The request and response bodies contain a Subscription object, representing the subscription data being updated and the resulting state.

  • Authorization requires the https://www.googleapis.com/auth/androidpublisher OAuth scope.

Updates an existing subscription.

HTTP request

PATCH https://androidpublisher.googleapis.com/androidpublisher/v3/applications/{subscription.packageName}/subscriptions/{subscription.productId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
subscription.packageName

string

Immutable. Package name of the parent app.
subscription.productId

string

Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length.

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 subscription.
allowMissing

boolean

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

If a new subscription 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 Subscription.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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