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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._discount import Discount
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._search_result_object import SearchResultObject
from stripe._subscription import Subscription
from stripe.params._subscription_cancel_params import (
SubscriptionCancelParams,
)
from stripe.params._subscription_create_params import (
SubscriptionCreateParams,
)
from stripe.params._subscription_delete_discount_params import (
SubscriptionDeleteDiscountParams,
)
from stripe.params._subscription_list_params import SubscriptionListParams
from stripe.params._subscription_migrate_params import (
SubscriptionMigrateParams,
)
from stripe.params._subscription_resume_params import (
SubscriptionResumeParams,
)
from stripe.params._subscription_retrieve_params import (
SubscriptionRetrieveParams,
)
from stripe.params._subscription_search_params import (
SubscriptionSearchParams,
)
from stripe.params._subscription_update_params import (
SubscriptionUpdateParams,
)
class SubscriptionService(StripeService):
def cancel(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
"""
return cast(
"Subscription",
self._request(
"delete",
"/v1/subscriptions/{subscription_exposed_id}".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata).
Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
"""
return cast(
"Subscription",
await self._request_async(
"delete",
"/v1/subscriptions/{subscription_exposed_id}".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Retrieves the subscription with the given ID.
"""
return cast(
"Subscription",
self._request(
"get",
"/v1/subscriptions/{subscription_exposed_id}".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Retrieves the subscription with the given ID.
"""
return cast(
"Subscription",
await self._request_async(
"get",
"/v1/subscriptions/{subscription_exposed_id}".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Updates an existing subscription to match the specified parameters.
When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
Switching prices does not normally change the billing date or generate an immediate charge unless:
The billing interval is changed (for example, from monthly to yearly).
The subscription moves from free to paid.
A trial starts or ends.
In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
"""
return cast(
"Subscription",
self._request(
"post",
"/v1/subscriptions/{subscription_exposed_id}".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Updates an existing subscription to match the specified parameters.
When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint.
By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
Switching prices does not normally change the billing date or generate an immediate charge unless:
The billing interval is changed (for example, from monthly to yearly).
The subscription moves from free to paid.
A trial starts or ends.
In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment).
If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create).
If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription.
Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating <a href="/docs/billing/subscriptions/usage-based">usage-based billing](https://docs.stripe.com/docs/rate-limits) instead.
"""
return cast(
"Subscription",
await self._request_async(
"post",
"/v1/subscriptions/{subscription_exposed_id}".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
def delete_discount(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionDeleteDiscountParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Discount":
"""
Removes the currently applied discount on a subscription.
"""
return cast(
"Discount",
self._request(
"delete",
"/v1/subscriptions/{subscription_exposed_id}/discount".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_discount_async(
self,
subscription_exposed_id: str,
params: Optional["SubscriptionDeleteDiscountParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Discount":
"""
Removes the currently applied discount on a subscription.
"""
return cast(
"Discount",
await self._request_async(
"delete",
"/v1/subscriptions/{subscription_exposed_id}/discount".format(
subscription_exposed_id=sanitize_id(
subscription_exposed_id
),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["SubscriptionListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Subscription]":
"""
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
"""
return cast(
"ListObject[Subscription]",
self._request(
"get",
"/v1/subscriptions",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["SubscriptionListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Subscription]":
"""
By default, returns a list of subscriptions that have not been canceled. In order to list canceled subscriptions, specify status=canceled.
"""
return cast(
"ListObject[Subscription]",
await self._request_async(
"get",
"/v1/subscriptions",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["SubscriptionCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
The payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
Schedules provide the flexibility to model more complex billing configurations that change over time.
"""
return cast(
"Subscription",
self._request(
"post",
"/v1/subscriptions",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["SubscriptionCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.
When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request.
The payment_behavior parameter determines the exact behavior of the initial payment.
To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead.
Schedules provide the flexibility to model more complex billing configurations that change over time.
"""
return cast(
"Subscription",
await self._request_async(
"post",
"/v1/subscriptions",
base_address="api",
params=params,
options=options,
),
)
def search(
self,
params: "SubscriptionSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Subscription]":
"""
Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Subscription]",
self._request(
"get",
"/v1/subscriptions/search",
base_address="api",
params=params,
options=options,
),
)
async def search_async(
self,
params: "SubscriptionSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Subscription]":
"""
Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
to an hour behind during outages. Search functionality is not available to merchants in India.
"""
return cast(
"SearchResultObject[Subscription]",
await self._request_async(
"get",
"/v1/subscriptions/search",
base_address="api",
params=params,
options=options,
),
)
def migrate(
self,
subscription: str,
params: "SubscriptionMigrateParams",
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Upgrade the billing_mode of an existing subscription.
"""
return cast(
"Subscription",
self._request(
"post",
"/v1/subscriptions/{subscription}/migrate".format(
subscription=sanitize_id(subscription),
),
base_address="api",
params=params,
options=options,
),
)
async def migrate_async(
self,
subscription: str,
params: "SubscriptionMigrateParams",
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Upgrade the billing_mode of an existing subscription.
"""
return cast(
"Subscription",
await self._request_async(
"post",
"/v1/subscriptions/{subscription}/migrate".format(
subscription=sanitize_id(subscription),
),
base_address="api",
params=params,
options=options,
),
)
def resume(
self,
subscription: str,
params: Optional["SubscriptionResumeParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused.
"""
return cast(
"Subscription",
self._request(
"post",
"/v1/subscriptions/{subscription}/resume".format(
subscription=sanitize_id(subscription),
),
base_address="api",
params=params,
options=options,
),
)
async def resume_async(
self,
subscription: str,
params: Optional["SubscriptionResumeParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Subscription":
"""
Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused.
"""
return cast(
"Subscription",
await self._request_async(
"post",
"/v1/subscriptions/{subscription}/resume".format(
subscription=sanitize_id(subscription),
),
base_address="api",
params=params,
options=options,
),
)
|
