1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="androidpublisher_v3.html">Google Play Android Developer API</a> . <a href="androidpublisher_v3.monetization.html">monetization</a> . <a href="androidpublisher_v3.monetization.subscriptions.html">subscriptions</a> . <a href="androidpublisher_v3.monetization.subscriptions.basePlans.html">basePlans</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v3.monetization.subscriptions.basePlans.offers.html">offers()</a></code>
</p>
<p class="firstline">Returns the offers Resource.</p>
<p class="toc_element">
<code><a href="#activate">activate(packageName, productId, basePlanId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Activates a base plan. Once activated, base plans will be available to new subscribers.</p>
<p class="toc_element">
<code><a href="#batchMigratePrices">batchMigratePrices(packageName, productId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch variant of the MigrateBasePlanPrices endpoint. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.</p>
<p class="toc_element">
<code><a href="#batchUpdateStates">batchUpdateStates(packageName, productId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Activates or deactivates base plans across one or multiple subscriptions. Set the latencyTolerance field on nested requests to PRODUCT_UPDATE_LATENCY_TOLERANCE_LATENCY_TOLERANT to achieve maximum update throughput.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#deactivate">deactivate(packageName, productId, basePlanId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription</p>
<p class="toc_element">
<code><a href="#delete">delete(packageName, productId, basePlanId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a base plan. Can only be done for draft base plans. This action is irreversible.</p>
<p class="toc_element">
<code><a href="#migratePrices">migratePrices(packageName, productId, basePlanId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="activate">activate(packageName, productId, basePlanId, body=None, x__xgafv=None)</code>
<pre>Activates a base plan. Once activated, base plans will be available to new subscribers.
Args:
packageName: string, Required. The parent app (package name) of the base plan to activate. (required)
productId: string, Required. The parent subscription (ID) of the base plan to activate. (required)
basePlanId: string, Required. The unique base plan ID of the base plan to activate. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ActivateBasePlan.
"basePlanId": "A String", # Required. The unique base plan ID of the base plan to activate.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. The parent app (package name) of the base plan to activate.
"productId": "A String", # Required. The parent subscription (ID) of the base plan to activate.
}
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 between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"billingPeriodDuration": "A String", # Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"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.
"installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"billingPeriodDuration": "A String", # Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"committedPaymentsCount": 42, # Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"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.
"renewalType": "A String", # Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.
"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.
},
"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 a product offer.
"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. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"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.
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"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).
},
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="batchMigratePrices">batchMigratePrices(packageName, productId, body=None, x__xgafv=None)</code>
<pre>Batch variant of the MigrateBasePlanPrices endpoint. 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 created or updated. Must be equal to the package_name field on all the Subscription resources. (required)
productId: string, Required. The product ID of the parent subscription, if all updated offers belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchMigrateBasePlanPrices.
"requests": [ # Required. Up to 100 price migration requests. All requests must update different base plans.
{ # Request message for MigrateBasePlanPrices.
"basePlanId": "A String", # Required. The unique base plan ID of the base plan to update prices on.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.
"productId": "A String", # Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.
"regionalPriceMigrations": [ # Required. The regional prices to update.
{ # Configuration for migration of a legacy price cohort.
"oldestAllowedPriceVersionTime": "A String", # Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type.
"priceIncreaseType": "A String", # Optional. The requested type of price increase
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version 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.
},
},
],
}
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 BatchMigrateBasePlanPrices.
"responses": [ # Contains one response per requested price migration, in the same order as the request.
{ # Response message for MigrateBasePlanPrices.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchUpdateStates">batchUpdateStates(packageName, productId, body=None, x__xgafv=None)</code>
<pre>Activates or deactivates base plans across one or multiple 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) of the updated base plans. (required)
productId: string, Required. The product ID of the parent subscription, if all updated base plans belong to the same subscription. If this batch update spans multiple subscriptions, set this field to "-". Must be set. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for BatchUpdateBasePlanStates.
"requests": [ # Required. The update request list of up to 100 elements. All requests must update different base plans.
{ # Request message to update the state of a subscription base plan.
"activateBasePlanRequest": { # Request message for ActivateBasePlan. # Activates a base plan. Once activated, base plans will be available to new subscribers.
"basePlanId": "A String", # Required. The unique base plan ID of the base plan to activate.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. The parent app (package name) of the base plan to activate.
"productId": "A String", # Required. The parent subscription (ID) of the base plan to activate.
},
"deactivateBasePlanRequest": { # Request message for DeactivateBasePlan. # Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription
"basePlanId": "A String", # Required. The unique base plan ID of the base plan to deactivate.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. The parent app (package name) of the base plan to deactivate.
"productId": "A String", # Required. The parent subscription (ID) of the base plan to deactivate.
},
},
],
}
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 BatchUpdateBasePlanStates.
"subscriptions": [ # The list of updated subscriptions. This list will match the requests one to one, in the same order.
{ # 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 between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"billingPeriodDuration": "A String", # Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"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.
"installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"billingPeriodDuration": "A String", # Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"committedPaymentsCount": 42, # Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"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.
"renewalType": "A String", # Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.
"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.
},
"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 a product offer.
"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. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"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.
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"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).
},
},
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="deactivate">deactivate(packageName, productId, basePlanId, body=None, x__xgafv=None)</code>
<pre>Deactivates a base plan. Once deactivated, the base plan will become unavailable to new subscribers, but existing subscribers will maintain their subscription
Args:
packageName: string, Required. The parent app (package name) of the base plan to deactivate. (required)
productId: string, Required. The parent subscription (ID) of the base plan to deactivate. (required)
basePlanId: string, Required. The unique base plan ID of the base plan to deactivate. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DeactivateBasePlan.
"basePlanId": "A String", # Required. The unique base plan ID of the base plan to deactivate.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. The parent app (package name) of the base plan to deactivate.
"productId": "A String", # Required. The parent subscription (ID) of the base plan to deactivate.
}
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 between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"billingPeriodDuration": "A String", # Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"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.
"installmentsBasePlanType": { # Represents an installments base plan where a user commits to a specified number of payments. # Set for installments base plans where a user is committed to a specified number of payments.
"accountHoldDuration": "A String", # Optional. Account hold period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and P60D. If not specified, the default value is P30D. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"billingPeriodDuration": "A String", # Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"committedPaymentsCount": 42, # Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.
"gracePeriodDuration": "A String", # Grace period of the subscription, specified in ISO 8601 format. Acceptable values must be in days and between P0D and the lesser of 30D and base plan billing period. If not specified, a default value will be used based on the billing period. The sum of gracePeriodDuration and accountHoldDuration must be between P30D and P60D days, inclusive.
"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.
"renewalType": "A String", # Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.
"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.
},
"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 a product offer.
"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. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.
"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.
"restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed.
"regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US".
"A String",
],
},
"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).
},
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(packageName, productId, basePlanId, x__xgafv=None)</code>
<pre>Deletes a base plan. Can only be done for draft base plans. This action is irreversible.
Args:
packageName: string, Required. The parent app (package name) of the base plan to delete. (required)
productId: string, Required. The parent subscription (ID) of the base plan to delete. (required)
basePlanId: string, Required. The unique offer ID of the base plan to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="migratePrices">migratePrices(packageName, productId, basePlanId, body=None, x__xgafv=None)</code>
<pre>Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.
Args:
packageName: string, Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource. (required)
productId: string, Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource. (required)
basePlanId: string, Required. The unique base plan ID of the base plan to update prices on. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for MigrateBasePlanPrices.
"basePlanId": "A String", # Required. The unique base plan ID of the base plan to update prices on.
"latencyTolerance": "A String", # Optional. The latency tolerance for the propagation of this product update. Defaults to latency-sensitive.
"packageName": "A String", # Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource.
"productId": "A String", # Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource.
"regionalPriceMigrations": [ # Required. The regional prices to update.
{ # Configuration for migration of a legacy price cohort.
"oldestAllowedPriceVersionTime": "A String", # Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type.
"priceIncreaseType": "A String", # Optional. The requested type of price increase
"regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US".
},
],
"regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations.
"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version 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.
},
}
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 MigrateBasePlanPrices.
}</pre>
</div>
</body></html>
|
