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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._stripe_object import StripeObject
from typing import ClassVar, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params._account_session_create_params import (
AccountSessionCreateParams,
)
class AccountSession(CreateableAPIResource["AccountSession"]):
"""
An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
We recommend that you create an AccountSession each time you need to display an embedded component
to your user. Do not save AccountSessions to your database as they expire relatively
quickly, and cannot be used more than once.
Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
"""
OBJECT_NAME: ClassVar[Literal["account_session"]] = "account_session"
class Components(StripeObject):
class AccountManagement(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class AccountOnboarding(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class Balances(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
edit_payout_schedule: bool
"""
Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
instant_payouts: bool
"""
Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
standard_payouts: bool
"""
Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class DisputesList(StripeObject):
class Features(StripeObject):
capture_payments: bool
"""
Whether to allow capturing and cancelling payment intents. This is `true` by default.
"""
destination_on_behalf_of_charge_management: bool
"""
Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
"""
dispute_management: bool
"""
Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
"""
refund_management: bool
"""
Whether sending refunds is enabled. This is `true` by default.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class Documents(StripeObject):
class Features(StripeObject):
pass
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class FinancialAccount(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
send_money: bool
"""
Whether to allow sending money.
"""
transfer_balance: bool
"""
Whether to allow transferring balance.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class FinancialAccountTransactions(StripeObject):
class Features(StripeObject):
card_spend_dispute_management: bool
"""
Whether to allow card spend dispute management features.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class InstantPayoutsPromotion(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
instant_payouts: bool
"""
Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class IssuingCard(StripeObject):
class Features(StripeObject):
card_management: bool
"""
Whether to allow card management features.
"""
card_spend_dispute_management: bool
"""
Whether to allow card spend dispute management features.
"""
cardholder_management: bool
"""
Whether to allow cardholder management features.
"""
spend_control_management: bool
"""
Whether to allow spend control management features.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class IssuingCardsList(StripeObject):
class Features(StripeObject):
card_management: bool
"""
Whether to allow card management features.
"""
card_spend_dispute_management: bool
"""
Whether to allow card spend dispute management features.
"""
cardholder_management: bool
"""
Whether to allow cardholder management features.
"""
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
spend_control_management: bool
"""
Whether to allow spend control management features.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class NotificationBanner(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class PaymentDetails(StripeObject):
class Features(StripeObject):
capture_payments: bool
"""
Whether to allow capturing and cancelling payment intents. This is `true` by default.
"""
destination_on_behalf_of_charge_management: bool
"""
Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
"""
dispute_management: bool
"""
Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
"""
refund_management: bool
"""
Whether sending refunds is enabled. This is `true` by default.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class PaymentDisputes(StripeObject):
class Features(StripeObject):
destination_on_behalf_of_charge_management: bool
"""
Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
"""
dispute_management: bool
"""
Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
"""
refund_management: bool
"""
Whether sending refunds is enabled. This is `true` by default.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class Payments(StripeObject):
class Features(StripeObject):
capture_payments: bool
"""
Whether to allow capturing and cancelling payment intents. This is `true` by default.
"""
destination_on_behalf_of_charge_management: bool
"""
Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default.
"""
dispute_management: bool
"""
Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default.
"""
refund_management: bool
"""
Whether sending refunds is enabled. This is `true` by default.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class PayoutDetails(StripeObject):
class Features(StripeObject):
pass
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class Payouts(StripeObject):
class Features(StripeObject):
disable_stripe_user_authentication: bool
"""
Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`.
"""
edit_payout_schedule: bool
"""
Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
external_account_collection: bool
"""
Whether external account collection is enabled. This feature can only be `false` for accounts where you're responsible for collecting updated information when requirements are due or change, like Custom accounts. The default value for this feature is `true`.
"""
instant_payouts: bool
"""
Whether to allow creation of instant payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
standard_payouts: bool
"""
Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`.
"""
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class PayoutsList(StripeObject):
class Features(StripeObject):
pass
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class TaxRegistrations(StripeObject):
class Features(StripeObject):
pass
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
class TaxSettings(StripeObject):
class Features(StripeObject):
pass
enabled: bool
"""
Whether the embedded component is enabled.
"""
features: Features
_inner_class_types = {"features": Features}
account_management: AccountManagement
account_onboarding: AccountOnboarding
balances: Balances
disputes_list: DisputesList
documents: Documents
financial_account: FinancialAccount
financial_account_transactions: FinancialAccountTransactions
instant_payouts_promotion: InstantPayoutsPromotion
issuing_card: IssuingCard
issuing_cards_list: IssuingCardsList
notification_banner: NotificationBanner
payment_details: PaymentDetails
payment_disputes: PaymentDisputes
payments: Payments
payout_details: PayoutDetails
payouts: Payouts
payouts_list: PayoutsList
tax_registrations: TaxRegistrations
tax_settings: TaxSettings
_inner_class_types = {
"account_management": AccountManagement,
"account_onboarding": AccountOnboarding,
"balances": Balances,
"disputes_list": DisputesList,
"documents": Documents,
"financial_account": FinancialAccount,
"financial_account_transactions": FinancialAccountTransactions,
"instant_payouts_promotion": InstantPayoutsPromotion,
"issuing_card": IssuingCard,
"issuing_cards_list": IssuingCardsList,
"notification_banner": NotificationBanner,
"payment_details": PaymentDetails,
"payment_disputes": PaymentDisputes,
"payments": Payments,
"payout_details": PayoutDetails,
"payouts": Payouts,
"payouts_list": PayoutsList,
"tax_registrations": TaxRegistrations,
"tax_settings": TaxSettings,
}
account: str
"""
The ID of the account the AccountSession was created for
"""
client_secret: str
"""
The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.
The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.
Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.
"""
components: Components
expires_at: int
"""
The timestamp at which this AccountSession will expire.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
object: Literal["account_session"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
@classmethod
def create(
cls, **params: Unpack["AccountSessionCreateParams"]
) -> "AccountSession":
"""
Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
"""
return cast(
"AccountSession",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["AccountSessionCreateParams"]
) -> "AccountSession":
"""
Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
"""
return cast(
"AccountSession",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
_inner_class_types = {"components": Components}
|
