Returns the basePlans Resource.
archive(packageName, productId, body=None, x__xgafv=None)
Deprecated: subscription archiving is not supported.
batchGet(packageName, productIds=None, x__xgafv=None)
Reads one or more subscriptions.
batchUpdate(packageName, body=None, x__xgafv=None)
Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
Close httplib2 connections.
create(packageName, body=None, productId=None, regionsVersion_version=None, x__xgafv=None)
Creates a new subscription. Newly added base plans will remain in draft state until activated.
delete(packageName, productId, x__xgafv=None)
Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.
get(packageName, productId, x__xgafv=None)
Reads a single subscription.
list(packageName, pageSize=None, pageToken=None, showArchived=None, x__xgafv=None)
Lists all subscriptions under a given app.
Retrieves the next page of results.
Updates an existing subscription.
archive(packageName, productId, body=None, x__xgafv=None)
Deprecated: subscription archiving is not supported.
Args:
packageName: string, Required. The parent app (package name) of the app of the subscription to delete. (required)
productId: string, Required. The unique product ID of the subscription to delete. (required)
body: object, The request body.
The object takes the form of:
{ # Deprecated: subscription archiving is not supported.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
}
batchGet(packageName, productIds=None, x__xgafv=None)
Reads one or more subscriptions.
Args:
packageName: string, Required. The parent app (package name) for which the subscriptions should be retrieved. Must be equal to the package_name field on all the requests. (required)
productIds: string, Required. A list of up to 100 subscription product IDs to retrieve. All the IDs must be different. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for BatchGetSubscriptions endpoint.
"subscriptions": [ # The list of requested subscriptions, in the same order as the request.
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
},
],
}
batchUpdate(packageName, body=None, x__xgafv=None)
Updates a batch of subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.
Args:
packageName: string, Required. The parent app (package name) for which the subscriptions should be updated. Must be equal to the package_name field on all the Subscription resources. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchUpdateSubscription.
"requests": [ # Required. A list of update requests of up to 100 elements. All requests must update different subscriptions.
{ # Request message for UpdateSubscription.
"allowMissing": True or False, # Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the subscription.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
},
"subscription": { # A single subscription for an app. # Required. The subscription to update.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
},
"updateMask": "A String", # Required. The list of fields to be updated.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for BatchUpdateSubscription.
"subscriptions": [ # The updated subscriptions list.
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
},
],
}
close()
Close httplib2 connections.
create(packageName, body=None, productId=None, regionsVersion_version=None, x__xgafv=None)
Creates a new subscription. Newly added base plans will remain in draft state until activated.
Args:
packageName: string, Required. The parent app (package name) for which the subscription should be created. Must be equal to the package_name field on the Subscription resource. (required)
body: object, The request body.
The object takes the form of:
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
}
productId: string, Required. The ID to use for the subscription. For the requirements on this format, see the documentation of the product_id field on the Subscription resource.
regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
}
delete(packageName, productId, x__xgafv=None)
Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.
Args:
packageName: string, Required. The parent app (package name) of the app of the subscription to delete. (required)
productId: string, Required. The unique product ID of the subscription to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
get(packageName, productId, x__xgafv=None)
Reads a single subscription.
Args:
packageName: string, Required. The parent app (package name) of the subscription to get. (required)
productId: string, Required. The unique product ID of the subscription to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
}
list(packageName, pageSize=None, pageToken=None, showArchived=None, x__xgafv=None)
Lists all subscriptions under a given app.
Args:
packageName: string, Required. The parent app (package name) for which the subscriptions should be read. (required)
pageSize: integer, The maximum number of subscriptions to return. The service may return fewer than this value. If unspecified, at most 50 subscriptions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token.
showArchived: boolean, Deprecated: subscription archiving is not supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListSubscriptions.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"subscriptions": [ # The subscriptions from the specified app.
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(packageName, productId, allowMissing=None, body=None, latencyTolerance=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)
Updates an existing subscription.
Args:
packageName: string, Immutable. Package name of the parent app. (required)
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. (required)
body: object, The request body.
The object takes the form of:
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
}
allowMissing: boolean, Optional. If set to true, and the subscription with the given package_name and product_id doesn't exist, the subscription will be created. If a new subscription is created, update_mask is ignored.
latencyTolerance: string, Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
Allowed values
PRODUCT_UPDATE_LATENCY_TOLERANCE_UNSPECIFIED - Defaults to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_SENSITIVE - The update will propagate to clients within several minutes on average and up to a few hours in rare cases. Throughput is limited to 7,200 updates per app per hour.
PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT - The update will propagate to clients within 24 hours. Supports high throughput of up to 720,000 updates per app per hour using batch modification methods.
regionsVersion_version: string, Required. A string representing the version of available regions being used for the specified resource. Regional prices for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. The latest version is 2022/02.
updateMask: string, Required. The list of fields to be updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single subscription for an app.
"archived": True or False, # Output only. Deprecated: subscription archiving is not supported.
"basePlans": [ # The set of base plans for this subscription. Represents the prices and duration of the subscription if no other offers apply.
{ # A single base plan for a subscription.
"autoRenewingBasePlanType": { # Represents a base plan that automatically renews at the end of its subscription period. # Set when the base plan automatically renews at a regular interval.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in DAYS and in the range P0D (zero days) to P30D (30 days). If not specified, the default value is P30D (30 days).
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values are P0D (zero days), P3D (3 days), P7D (7 days), P14D (14 days), and P30D (30 days). If not specified, a default value will be used based on the recurring period duration.
"legacyCompatible": True or False, # Whether the renewing base plan is backward compatible. The backward compatible base plan is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one renewing base plan can be marked as legacy compatible for a given subscription.
"legacyCompatibleSubscriptionOfferId": "A String", # Subscription offer id which is legacy compatible. The backward compatible subscription offer is returned by the Google Play Billing Library deprecated method querySkuDetailsAsync(). Only one subscription offer can be marked as legacy compatible for a given renewing base plan. To have no Subscription offer as legacy compatible set this field as empty string.
"prorationMode": "A String", # The proration mode for the base plan determines what happens when a user switches to this plan from another base plan. If unspecified, defaults to CHARGE_ON_NEXT_BILLING_DATE.
"resubscribeState": "A String", # Whether users should be able to resubscribe to this base plan in Google Play surfaces. Defaults to RESUBSCRIBE_STATE_ACTIVE if not specified.
},
"basePlanId": "A String", # 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": [ # 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.
{ # Represents a custom tag specified for base plans and subscription offers.
"tag": "A String", # Must conform with RFC-1034. That is, this string can only contain lower-case letters (a-z), numbers (0-9), and hyphens (-), and be at most 20 characters.
},
],
"otherRegionsConfig": { # Pricing information for any new locations Play may launch in. # 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.
"eurPrice": { # Represents an amount of money with its currency type. # Required. Price in EUR to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"newSubscriberAvailability": True or False, # Whether the base plan is available for new subscribers in any new locations Play may launch in. If not specified, this will default to false.
"usdPrice": { # Represents an amount of money with its currency type. # Required. Price in USD to use for any new locations Play may launch in.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
},
"prepaidBasePlanType": { # Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user. # Set when the base plan does not automatically renew at the end of the billing period.
"billingPeriodDuration": "A String", # Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.
"timeExtension": "A String", # Whether users should be able to extend this prepaid base plan in Google Play surfaces. Defaults to TIME_EXTENSION_ACTIVE if not specified.
},
"regionalConfigs": [ # Region-specific information for this base plan.
{ # Configuration for a base plan specific to a region.
"newSubscriberAvailability": True or False, # Whether the base plan in the specified region is available for new subscribers. Existing subscribers will not have their subscription canceled if this value is set to false. If not specified, this will default to false.
"price": { # Represents an amount of money with its currency type. # The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"state": "A String", # 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.
},
],
"listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app.
{ # The consumer-visible metadata of a subscription.
"benefits": [ # 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.
"A String",
],
"description": "A String", # The description of this subscription in the language of this listing. Maximum length - 80 characters. Plain text.
"languageCode": "A String", # Required. The language of this listing, as defined by BCP-47, e.g. "en-US".
"title": "A String", # Required. The title of this subscription in the language of this listing. Plain text.
},
],
"packageName": "A String", # Immutable. Package name of the parent app.
"productId": "A 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.
"taxAndComplianceSettings": { # Details about taxation, Google Play policy and legal compliance for subscription products. # Details about taxes and legal compliance.
"eeaWithdrawalRightType": "A String", # 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](https://support.google.com/googleplay/android-developer/answer/10463498) for more information.
"isTokenizedDigitalAsset": True or False, # Whether this subscription is declared as a product representing a tokenized digital asset.
"taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR".
"a_key": { # Specified details about taxation in a given geographical region.
"eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States.
"streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax).
"taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498).
},
},
},
}