/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}

PATCH

monetization

Updates an existing subscription.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://androidpublisher.googleapis.com//androidpublisher/v3/applications//subscriptions/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "basePlans": [
        {
            "autoRenewingBasePlanType": {
                "billingPeriodDuration": "string",
                "gracePeriodDuration": "string",
                "legacyCompatible": true,
                "prorationMode": "SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED",
                "resubscribeState": "RESUBSCRIBE_STATE_UNSPECIFIED"
            },
            "basePlanId": "string",
            "offerTags": [
                {
                    "tag": "string"
                }
            ],
            "otherRegionsConfig": {
                "eurPrice": {
                    "currencyCode": "string",
                    "nanos": 0,
                    "units": "string"
                },
                "newSubscriberAvailability": true,
                "usdPrice": {
                    "currencyCode": "string",
                    "nanos": 0,
                    "units": "string"
                }
            },
            "prepaidBasePlanType": {
                "billingPeriodDuration": "string",
                "timeExtension": "TIME_EXTENSION_UNSPECIFIED"
            },
            "regionalConfigs": [
                {
                    "newSubscriberAvailability": true,
                    "price": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "regionCode": "string"
                }
            ]
        }
    ],
    "listings": [
        {
            "benefits": [
                "string"
            ],
            "description": "string",
            "languageCode": "string",
            "title": "string"
        }
    ],
    "packageName": "string",
    "productId": "string",
    "taxAndComplianceSettings": {
        "eeaWithdrawalRightType": "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED",
        "taxRateInfoByRegionCode": {
            "property1": {
                "eligibleForStreamingServiceTaxRate": true,
                "taxTier": "TAX_TIER_UNSPECIFIED"
            },
            "property2": {
                "eligibleForStreamingServiceTaxRate": true,
                "taxTier": "TAX_TIER_UNSPECIFIED"
            }
        }
    }
}'

Response Example

{
    "archived": true,
    "basePlans": [
        {
            "autoRenewingBasePlanType": {
                "billingPeriodDuration": "string",
                "gracePeriodDuration": "string",
                "legacyCompatible": true,
                "prorationMode": "SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED",
                "resubscribeState": "RESUBSCRIBE_STATE_UNSPECIFIED"
            },
            "basePlanId": "string",
            "offerTags": [
                {
                    "tag": "string"
                }
            ],
            "otherRegionsConfig": {
                "eurPrice": {
                    "currencyCode": "string",
                    "nanos": 0,
                    "units": "string"
                },
                "newSubscriberAvailability": true,
                "usdPrice": {
                    "currencyCode": "string",
                    "nanos": 0,
                    "units": "string"
                }
            },
            "prepaidBasePlanType": {
                "billingPeriodDuration": "string",
                "timeExtension": "TIME_EXTENSION_UNSPECIFIED"
            },
            "regionalConfigs": [
                {
                    "newSubscriberAvailability": true,
                    "price": {
                        "currencyCode": "string",
                        "nanos": 0,
                        "units": "string"
                    },
                    "regionCode": "string"
                }
            ],
            "state": "STATE_UNSPECIFIED"
        }
    ],
    "listings": [
        {
            "benefits": [
                "string"
            ],
            "description": "string",
            "languageCode": "string",
            "title": "string"
        }
    ],
    "packageName": "string",
    "productId": "string",
    "taxAndComplianceSettings": {
        "eeaWithdrawalRightType": "WITHDRAWAL_RIGHT_TYPE_UNSPECIFIED",
        "taxRateInfoByRegionCode": {
            "property1": {
                "eligibleForStreamingServiceTaxRate": true,
                "taxTier": "TAX_TIER_UNSPECIFIED"
            },
            "property2": {
                "eligibleForStreamingServiceTaxRate": true,
                "taxTier": "TAX_TIER_UNSPECIFIED"
            }
        }
    }
}

Request

Path Params

packageName

string

required

Immutable. Package name of the parent app.

productId

string

required

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 Params

regionsVersion.version

string

optional

Required. A string representing version of the available regions being used for the specified resource. The current version is 2022/01.

updateMask

string

optional

Required. The list of fields to be updated.

Body Params application/json

A single subscription for an app.

basePlans

array[object (BasePlan) {6}]

optional

The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.

autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

optional

Set when the base plan automatically renews at a regular interval.

basePlanId

string

optional

Required. Immutable. The unique identifier of this base plan. Must be unique within the subscription, and conform with RFC-1034. That is, this ID can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 63 characters.

offerTags

array[object (OfferTag) {1}]

optional

List of up to 20 custom tags specified for this base plan, and returned to the app through the billing library. Subscription offers for this base plan will also receive these offer tags in the billing library.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

optional

Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.

prepaidBasePlanType

object (PrepaidBasePlanType)

optional

Set when the base plan does not automatically renew at the end of the billing period.

regionalConfigs

array[object (RegionalBasePlanConfig) {3}]

optional

Region-specific information for this base plan.

listings

array[object (SubscriptionListing) {4}]

optional

Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.

benefits

array[string]

optional

A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits.

description

string

optional

The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.

languageCode

string

optional

Required. The language of this listing, as defined by BCP-47, e.g. "en-US".

title

string

optional

Required. The title of this subscription in the language of this listing. Plain text.

packageName

string

optional

Immutable. Package name of the parent app.

productId

string

optional

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

optional

Details about taxes and legal compliance.

eeaWithdrawalRightType

enum<string>

optional

Digital content or service classification for products distributed to users in the European Economic Area (EEA). The withdrawal regime under EEA consumer laws depends on this classification. Refer to the Help Center article for more information.

Allowed values:

WITHDRAWAL_RIGHT_TYPE_UNSPECIFIEDWITHDRAWAL_RIGHT_DIGITAL_CONTENTWITHDRAWAL_RIGHT_SERVICE

taxRateInfoByRegionCode

object

optional

A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".

Examples

Responses

🟢200Successful response

application/json

Body

A single subscription for an app.

archived

boolean

read-onlyoptional

Output only. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.

basePlans

array[object (BasePlan) {7}]

optional

The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.

autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

optional

Set when the base plan automatically renews at a regular interval.

basePlanId

string

optional

offerTags

array[object (OfferTag) {1}]

optional

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

optional

Pricing information for any new locations Play may launch in the future. If omitted, the BasePlan will not be automatically available any new locations Play may launch in the future.

prepaidBasePlanType

object (PrepaidBasePlanType)

optional

Set when the base plan does not automatically renew at the end of the billing period.

regionalConfigs

array[object (RegionalBasePlanConfig) {3}]

optional

Region-specific information for this base plan.

state

enum<string>

read-onlyoptional

Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead.

Allowed values:

STATE_UNSPECIFIEDDRAFTACTIVEINACTIVE

listings

array[object (SubscriptionListing) {4}]

optional

Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.

benefits

array[string]

optional

A list of benefits shown to the user on platforms such as the Play Store and in restoration flows in the language of this listing. Plain text. Ordered list of at most four benefits.

description

string

optional

The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.

languageCode

string

optional

Required. The language of this listing, as defined by BCP-47, e.g. "en-US".

title

string

optional

Required. The title of this subscription in the language of this listing. Plain text.

packageName

string

optional

Immutable. Package name of the parent app.

productId

string

optional

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

optional

Details about taxes and legal compliance.

eeaWithdrawalRightType

enum<string>

optional

Allowed values:

WITHDRAWAL_RIGHT_TYPE_UNSPECIFIEDWITHDRAWAL_RIGHT_DIGITAL_CONTENTWITHDRAWAL_RIGHT_SERVICE

taxRateInfoByRegionCode

object

optional

A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".

Modified at 2022-09-11 20:51:56

/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}

/androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}