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
|
# -*- 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 importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._customer import Customer
from stripe._customer_balance_transaction_service import (
CustomerBalanceTransactionService,
)
from stripe._customer_cash_balance_service import (
CustomerCashBalanceService,
)
from stripe._customer_cash_balance_transaction_service import (
CustomerCashBalanceTransactionService,
)
from stripe._customer_funding_instructions_service import (
CustomerFundingInstructionsService,
)
from stripe._customer_payment_method_service import (
CustomerPaymentMethodService,
)
from stripe._customer_payment_source_service import (
CustomerPaymentSourceService,
)
from stripe._customer_tax_id_service import CustomerTaxIdService
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.params._customer_create_params import CustomerCreateParams
from stripe.params._customer_delete_discount_params import (
CustomerDeleteDiscountParams,
)
from stripe.params._customer_delete_params import CustomerDeleteParams
from stripe.params._customer_list_params import CustomerListParams
from stripe.params._customer_retrieve_params import CustomerRetrieveParams
from stripe.params._customer_search_params import CustomerSearchParams
from stripe.params._customer_update_params import CustomerUpdateParams
_subservices = {
"balance_transactions": [
"stripe._customer_balance_transaction_service",
"CustomerBalanceTransactionService",
],
"cash_balance": [
"stripe._customer_cash_balance_service",
"CustomerCashBalanceService",
],
"cash_balance_transactions": [
"stripe._customer_cash_balance_transaction_service",
"CustomerCashBalanceTransactionService",
],
"funding_instructions": [
"stripe._customer_funding_instructions_service",
"CustomerFundingInstructionsService",
],
"payment_methods": [
"stripe._customer_payment_method_service",
"CustomerPaymentMethodService",
],
"payment_sources": [
"stripe._customer_payment_source_service",
"CustomerPaymentSourceService",
],
"tax_ids": ["stripe._customer_tax_id_service", "CustomerTaxIdService"],
}
class CustomerService(StripeService):
balance_transactions: "CustomerBalanceTransactionService"
cash_balance: "CustomerCashBalanceService"
cash_balance_transactions: "CustomerCashBalanceTransactionService"
funding_instructions: "CustomerFundingInstructionsService"
payment_methods: "CustomerPaymentMethodService"
payment_sources: "CustomerPaymentSourceService"
tax_ids: "CustomerTaxIdService"
def __init__(self, requestor):
super().__init__(requestor)
def __getattr__(self, name):
try:
import_from, service = _subservices[name]
service_class = getattr(
import_module(import_from),
service,
)
setattr(
self,
name,
service_class(self._requestor),
)
return getattr(self, name)
except KeyError:
raise AttributeError()
def delete(
self,
customer: str,
params: Optional["CustomerDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
"""
return cast(
"Customer",
self._request(
"delete",
"/v1/customers/{customer}".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
customer: str,
params: Optional["CustomerDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
"""
return cast(
"Customer",
await self._request_async(
"delete",
"/v1/customers/{customer}".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
customer: str,
params: Optional["CustomerRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Retrieves a Customer object.
"""
return cast(
"Customer",
self._request(
"get",
"/v1/customers/{customer}".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
customer: str,
params: Optional["CustomerRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Retrieves a Customer object.
"""
return cast(
"Customer",
await self._request_async(
"get",
"/v1/customers/{customer}".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
customer: str,
params: Optional["CustomerUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
This request accepts mostly the same arguments as the customer creation call.
"""
return cast(
"Customer",
self._request(
"post",
"/v1/customers/{customer}".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
customer: str,
params: Optional["CustomerUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
This request accepts mostly the same arguments as the customer creation call.
"""
return cast(
"Customer",
await self._request_async(
"post",
"/v1/customers/{customer}".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def delete_discount(
self,
customer: str,
params: Optional["CustomerDeleteDiscountParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Discount":
"""
Removes the currently applied discount on a customer.
"""
return cast(
"Discount",
self._request(
"delete",
"/v1/customers/{customer}/discount".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_discount_async(
self,
customer: str,
params: Optional["CustomerDeleteDiscountParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Discount":
"""
Removes the currently applied discount on a customer.
"""
return cast(
"Discount",
await self._request_async(
"delete",
"/v1/customers/{customer}/discount".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["CustomerListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Customer]":
"""
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
"""
return cast(
"ListObject[Customer]",
self._request(
"get",
"/v1/customers",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["CustomerListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Customer]":
"""
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
"""
return cast(
"ListObject[Customer]",
await self._request_async(
"get",
"/v1/customers",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["CustomerCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Creates a new customer object.
"""
return cast(
"Customer",
self._request(
"post",
"/v1/customers",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["CustomerCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Customer":
"""
Creates a new customer object.
"""
return cast(
"Customer",
await self._request_async(
"post",
"/v1/customers",
base_address="api",
params=params,
options=options,
),
)
def search(
self,
params: "CustomerSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Customer]":
"""
Search for customers 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[Customer]",
self._request(
"get",
"/v1/customers/search",
base_address="api",
params=params,
options=options,
),
)
async def search_async(
self,
params: "CustomerSearchParams",
options: Optional["RequestOptions"] = None,
) -> "SearchResultObject[Customer]":
"""
Search for customers 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[Customer]",
await self._request_async(
"get",
"/v1/customers/search",
base_address="api",
params=params,
options=options,
),
)
|
