/
androidpublisher_v3.monetization.subscriptions.html
746 lines (698 loc) 路 83.5 KB
/
androidpublisher_v3.monetization.subscriptions.html
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
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
<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></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="androidpublisher_v3.monetization.subscriptions.basePlans.html">basePlans()</a></code>
</p>
<p class="firstline">Returns the basePlans Resource.</p>
<p class="toc_element">
<code><a href="#archive">archive(packageName, productId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Archives a subscription. Can only be done if at least one base plan was active in the past, and no base plan is available for new or existing subscribers currently. This action is irreversible, and the subscription ID will remain reserved.</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="#create">create(packageName, body=None, productId=None, regionsVersion_version=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new subscription. Newly added base plans will remain in draft state until activated.</p>
<p class="toc_element">
<code><a href="#delete">delete(packageName, productId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a subscription. A subscription can only be deleted if it has never had a base plan published.</p>
<p class="toc_element">
<code><a href="#get">get(packageName, productId, x__xgafv=None)</a></code></p>
<p class="firstline">Reads a single subscription.</p>
<p class="toc_element">
<code><a href="#list">list(packageName, pageSize=None, pageToken=None, showArchived=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all subscriptions under a given app.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(packageName, productId, body=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing subscription.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="archive">archive(packageName, productId, body=None, x__xgafv=None)</code>
<pre>Archives a subscription. Can only be done if at least one base plan was active in the past, and no base plan is available for new or existing subscribers currently. This action is irreversible, and the subscription ID will remain reserved.
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:
{ # Request message for ArchiveSubscription.
}
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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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="create">create(packageName, body=None, productId=None, regionsVersion_version=None, x__xgafv=None)</code>
<pre>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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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 version of the available regions being used for the specified resource. The current version is 2022/01.
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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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, x__xgafv=None)</code>
<pre>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
</pre>
</div>
<div class="method">
<code class="details" id="get">get(packageName, productId, x__xgafv=None)</code>
<pre>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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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="list">list(packageName, pageSize=None, pageToken=None, showArchived=None, x__xgafv=None)</code>
<pre>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, Whether archived subscriptions should be included in the response. Defaults to false.
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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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="list_next">list_next()</code>
<pre>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.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(packageName, productId, body=None, regionsVersion_version=None, updateMask=None, x__xgafv=None)</code>
<pre>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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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).
},
},
},
}
regionsVersion_version: string, Required. A string representing version of the available regions being used for the specified resource. The current version is 2022/01.
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. Whether this subscription is archived. Archived subscriptions are not available to any subscriber any longer, cannot be updated, and are not returned in list requests unless the show archived flag is passed in.
"basePlans": [ # 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.
"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.
"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 United States.
"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>
</body></html>