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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._account import Account
from stripe._bank_account import BankAccount
from stripe._card import Card
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._source import Source
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Dict, List, Union, cast
from typing_extensions import Literal, NotRequired, TypedDict
class CustomerPaymentSourceService(StripeService):
class CreateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
source: str
"""
Please refer to full [documentation](https://stripe.com/docs/api) instead.
"""
validate: NotRequired[bool]
class DeleteParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class ListParams(TypedDict):
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
object: NotRequired[str]
"""
Filter sources according to a particular object type.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class UpdateParams(TypedDict):
account_holder_name: NotRequired[str]
"""
The name of the person or business that owns the bank account.
"""
account_holder_type: NotRequired[Literal["company", "individual"]]
"""
The type of entity that holds the account. This can be either `individual` or `company`.
"""
address_city: NotRequired[str]
"""
City/District/Suburb/Town/Village.
"""
address_country: NotRequired[str]
"""
Billing address country, if provided when creating card.
"""
address_line1: NotRequired[str]
"""
Address line 1 (Street address/PO Box/Company name).
"""
address_line2: NotRequired[str]
"""
Address line 2 (Apartment/Suite/Unit/Building).
"""
address_state: NotRequired[str]
"""
State/County/Province/Region.
"""
address_zip: NotRequired[str]
"""
ZIP or postal code.
"""
exp_month: NotRequired[str]
"""
Two digit number representing the card's expiration month.
"""
exp_year: NotRequired[str]
"""
Four digit number representing the card's expiration year.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired["Literal['']|Dict[str, str]"]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
name: NotRequired[str]
"""
Cardholder name.
"""
owner: NotRequired["CustomerPaymentSourceService.UpdateParamsOwner"]
class UpdateParamsOwner(TypedDict):
address: NotRequired[
"CustomerPaymentSourceService.UpdateParamsOwnerAddress"
]
"""
Owner's address.
"""
email: NotRequired[str]
"""
Owner's email address.
"""
name: NotRequired[str]
"""
Owner's full name.
"""
phone: NotRequired[str]
"""
Owner's phone number.
"""
class UpdateParamsOwnerAddress(TypedDict):
city: NotRequired[str]
"""
City, district, suburb, town, or village.
"""
country: NotRequired[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: NotRequired[str]
"""
Address line 1 (e.g., street, PO Box, or company name).
"""
line2: NotRequired[str]
"""
Address line 2 (e.g., apartment, suite, unit, or building).
"""
postal_code: NotRequired[str]
"""
ZIP or postal code.
"""
state: NotRequired[str]
"""
State, county, province, or region.
"""
class VerifyParams(TypedDict):
amounts: NotRequired[List[int]]
"""
Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
def list(
self,
customer: str,
params: "CustomerPaymentSourceService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Union[Account, BankAccount, Card, Source]]:
"""
List sources for a specified customer.
"""
return cast(
ListObject[Union[Account, BankAccount, Card, Source]],
self._request(
"get",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
customer: str,
params: "CustomerPaymentSourceService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Union[Account, BankAccount, Card, Source]]:
"""
List sources for a specified customer.
"""
return cast(
ListObject[Union[Account, BankAccount, Card, Source]],
await self._request_async(
"get",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def create(
self,
customer: str,
params: "CustomerPaymentSourceService.CreateParams",
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
When you create a new credit card, you must specify a customer or recipient on which to create it.
If the card's owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source.
"""
return cast(
Union[Account, BankAccount, Card, Source],
self._request(
"post",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
customer: str,
params: "CustomerPaymentSourceService.CreateParams",
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
When you create a new credit card, you must specify a customer or recipient on which to create it.
If the card's owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source.
"""
return cast(
Union[Account, BankAccount, Card, Source],
await self._request_async(
"post",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
Retrieve a specified source for a given customer.
"""
return cast(
Union[Account, BankAccount, Card, Source],
self._request(
"get",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
Retrieve a specified source for a given customer.
"""
return cast(
Union[Account, BankAccount, Card, Source],
await self._request_async(
"get",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.UpdateParams" = {},
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
Update a specified source for a given customer.
"""
return cast(
Union[Account, BankAccount, Card, Source],
self._request(
"post",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.UpdateParams" = {},
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
Update a specified source for a given customer.
"""
return cast(
Union[Account, BankAccount, Card, Source],
await self._request_async(
"post",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def delete(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.DeleteParams" = {},
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
Delete a specified source for a given customer.
"""
return cast(
Union[Account, BankAccount, Card, Source],
self._request(
"delete",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.DeleteParams" = {},
options: RequestOptions = {},
) -> Union[Account, BankAccount, Card, Source]:
"""
Delete a specified source for a given customer.
"""
return cast(
Union[Account, BankAccount, Card, Source],
await self._request_async(
"delete",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def verify(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.VerifyParams" = {},
options: RequestOptions = {},
) -> BankAccount:
"""
Verify a specified bank account for a given customer.
"""
return cast(
BankAccount,
self._request(
"post",
"/v1/customers/{customer}/sources/{id}/verify".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def verify_async(
self,
customer: str,
id: str,
params: "CustomerPaymentSourceService.VerifyParams" = {},
options: RequestOptions = {},
) -> BankAccount:
"""
Verify a specified bank account for a given customer.
"""
return cast(
BankAccount,
await self._request_async(
"post",
"/v1/customers/{customer}/sources/{id}/verify".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
|
