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
|
# -*- 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._account import Account
from stripe._account_capability_service import AccountCapabilityService
from stripe._account_external_account_service import (
AccountExternalAccountService,
)
from stripe._account_login_link_service import AccountLoginLinkService
from stripe._account_person_service import AccountPersonService
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.params._account_create_params import AccountCreateParams
from stripe.params._account_delete_params import AccountDeleteParams
from stripe.params._account_list_params import AccountListParams
from stripe.params._account_reject_params import AccountRejectParams
from stripe.params._account_retrieve_current_params import (
AccountRetrieveCurrentParams,
)
from stripe.params._account_retrieve_params import AccountRetrieveParams
from stripe.params._account_update_params import AccountUpdateParams
_subservices = {
"capabilities": [
"stripe._account_capability_service",
"AccountCapabilityService",
],
"external_accounts": [
"stripe._account_external_account_service",
"AccountExternalAccountService",
],
"login_links": [
"stripe._account_login_link_service",
"AccountLoginLinkService",
],
"persons": ["stripe._account_person_service", "AccountPersonService"],
}
class AccountService(StripeService):
capabilities: "AccountCapabilityService"
external_accounts: "AccountExternalAccountService"
login_links: "AccountLoginLinkService"
persons: "AccountPersonService"
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,
account: str,
params: Optional["AccountDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
"""
return cast(
"Account",
self._request(
"delete",
"/v1/accounts/{account}".format(account=sanitize_id(account)),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
account: str,
params: Optional["AccountDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
Test-mode accounts can be deleted at any time.
Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
"""
return cast(
"Account",
await self._request_async(
"delete",
"/v1/accounts/{account}".format(account=sanitize_id(account)),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
account: str,
params: Optional["AccountRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
Retrieves the details of an account.
"""
return cast(
"Account",
self._request(
"get",
"/v1/accounts/{account}".format(account=sanitize_id(account)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
account: str,
params: Optional["AccountRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
Retrieves the details of an account.
"""
return cast(
"Account",
await self._request_async(
"get",
"/v1/accounts/{account}".format(account=sanitize_id(account)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
account: str,
params: Optional["AccountUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
left unchanged.
For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
is application, which includes Custom accounts, you can update any information on the account.
For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
is stripe, which includes Standard and Express accounts, you can update all information until you create
an [Account Link or <a href="/api/account_sessions">Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding,
after which some properties can no longer be updated.
To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
[Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
"""
return cast(
"Account",
self._request(
"post",
"/v1/accounts/{account}".format(account=sanitize_id(account)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
account: str,
params: Optional["AccountUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
left unchanged.
For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
is application, which includes Custom accounts, you can update any information on the account.
For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
is stripe, which includes Standard and Express accounts, you can update all information until you create
an [Account Link or <a href="/api/account_sessions">Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding,
after which some properties can no longer be updated.
To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
[Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
"""
return cast(
"Account",
await self._request_async(
"post",
"/v1/accounts/{account}".format(account=sanitize_id(account)),
base_address="api",
params=params,
options=options,
),
)
def retrieve_current(
self,
params: Optional["AccountRetrieveCurrentParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
Retrieves the details of an account.
"""
return cast(
"Account",
self._request(
"get",
"/v1/account",
base_address="api",
params=params,
options=options,
),
)
async def retrieve_current_async(
self,
params: Optional["AccountRetrieveCurrentParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
Retrieves the details of an account.
"""
return cast(
"Account",
await self._request_async(
"get",
"/v1/account",
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["AccountListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Account]":
"""
Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty.
"""
return cast(
"ListObject[Account]",
self._request(
"get",
"/v1/accounts",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["AccountListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Account]":
"""
Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty.
"""
return cast(
"ListObject[Account]",
await self._request_async(
"get",
"/v1/accounts",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["AccountCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
You can prefill any information on the account.
"""
return cast(
"Account",
self._request(
"post",
"/v1/accounts",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["AccountCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
You can prefill any information on the account.
"""
return cast(
"Account",
await self._request_async(
"post",
"/v1/accounts",
base_address="api",
params=params,
options=options,
),
)
def reject(
self,
account: str,
params: "AccountRejectParams",
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
"""
return cast(
"Account",
self._request(
"post",
"/v1/accounts/{account}/reject".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
async def reject_async(
self,
account: str,
params: "AccountRejectParams",
options: Optional["RequestOptions"] = None,
) -> "Account":
"""
With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
"""
return cast(
"Account",
await self._request_async(
"post",
"/v1/accounts/{account}/reject".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
|
