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 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._deletable_api_resource import DeletableAPIResource
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._nested_resource_class_methods import nested_resource_class_methods
from stripe._oauth import OAuth
from stripe._person import Person
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import class_method_variant, sanitize_id
from typing import ClassVar, Dict, List, Optional, Union, cast, overload
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._bank_account import BankAccount
from stripe._capability import Capability
from stripe._card import Card
from stripe._file import File
from stripe._login_link import LoginLink
from stripe._tax_id import TaxId
from stripe.params._account_create_external_account_params import (
AccountCreateExternalAccountParams,
)
from stripe.params._account_create_login_link_params import (
AccountCreateLoginLinkParams,
)
from stripe.params._account_create_params import AccountCreateParams
from stripe.params._account_create_person_params import (
AccountCreatePersonParams,
)
from stripe.params._account_delete_external_account_params import (
AccountDeleteExternalAccountParams,
)
from stripe.params._account_delete_params import AccountDeleteParams
from stripe.params._account_delete_person_params import (
AccountDeletePersonParams,
)
from stripe.params._account_list_capabilities_params import (
AccountListCapabilitiesParams,
)
from stripe.params._account_list_external_accounts_params import (
AccountListExternalAccountsParams,
)
from stripe.params._account_list_params import AccountListParams
from stripe.params._account_list_persons_params import (
AccountListPersonsParams,
)
from stripe.params._account_modify_capability_params import (
AccountModifyCapabilityParams,
)
from stripe.params._account_modify_external_account_params import (
AccountModifyExternalAccountParams,
)
from stripe.params._account_modify_person_params import (
AccountModifyPersonParams,
)
from stripe.params._account_persons_params import AccountPersonsParams
from stripe.params._account_reject_params import AccountRejectParams
from stripe.params._account_retrieve_capability_params import (
AccountRetrieveCapabilityParams,
)
from stripe.params._account_retrieve_external_account_params import (
AccountRetrieveExternalAccountParams,
)
from stripe.params._account_retrieve_person_params import (
AccountRetrievePersonParams,
)
@nested_resource_class_methods("capability")
@nested_resource_class_methods("external_account")
@nested_resource_class_methods("login_link")
@nested_resource_class_methods("person")
class Account(
CreateableAPIResource["Account"],
DeletableAPIResource["Account"],
ListableAPIResource["Account"],
UpdateableAPIResource["Account"],
):
"""
This is an object representing a Stripe account. You can retrieve it to see
properties on the account like its current requirements or if the account is
enabled to make live charges or receive payouts.
For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
is `application`, which includes Custom accounts, the properties below are always
returned.
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, some properties are only returned
until you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions)
to start Connect Onboarding. Learn about the [differences between accounts](https://docs.stripe.com/connect/accounts).
"""
OBJECT_NAME: ClassVar[Literal["account"]] = "account"
class BusinessProfile(StripeObject):
class AnnualRevenue(StripeObject):
amount: Optional[int]
"""
A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
"""
currency: Optional[str]
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
"""
fiscal_year_end: Optional[str]
"""
The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
"""
class MonthlyEstimatedRevenue(StripeObject):
amount: int
"""
A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
"""
currency: str
"""
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
"""
class SupportAddress(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1, such as the street, PO Box, or company name.
"""
line2: Optional[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
annual_revenue: Optional[AnnualRevenue]
"""
The applicant's gross annual revenue for its preceding fiscal year.
"""
estimated_worker_count: Optional[int]
"""
An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
"""
mcc: Optional[str]
"""
[The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
"""
minority_owned_business_designation: Optional[
List[
Literal[
"lgbtqi_owned_business",
"minority_owned_business",
"none_of_these_apply",
"prefer_not_to_answer",
"women_owned_business",
]
]
]
"""
Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
"""
monthly_estimated_revenue: Optional[MonthlyEstimatedRevenue]
name: Optional[str]
"""
The customer-facing business name.
"""
product_description: Optional[str]
"""
Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
"""
support_address: Optional[SupportAddress]
"""
A publicly available mailing address for sending support issues to.
"""
support_email: Optional[str]
"""
A publicly available email address for sending support issues to.
"""
support_phone: Optional[str]
"""
A publicly available phone number to call with support issues.
"""
support_url: Optional[str]
"""
A publicly available website for handling support issues.
"""
url: Optional[str]
"""
The business's publicly available website.
"""
_inner_class_types = {
"annual_revenue": AnnualRevenue,
"monthly_estimated_revenue": MonthlyEstimatedRevenue,
"support_address": SupportAddress,
}
class Capabilities(StripeObject):
acss_debit_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
"""
affirm_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
"""
afterpay_clearpay_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
"""
alma_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Alma capability of the account, or whether the account can directly process Alma payments.
"""
amazon_pay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
"""
au_becs_debit_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
"""
bacs_debit_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
"""
bancontact_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
"""
bank_transfer_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
"""
billie_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Billie capability of the account, or whether the account can directly process Billie payments.
"""
blik_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the blik payments capability of the account, or whether the account can directly process blik charges.
"""
boleto_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
"""
card_issuing: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
"""
card_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
"""
cartes_bancaires_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
"""
cashapp_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
"""
crypto_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Crypto capability of the account, or whether the account can directly process Crypto payments.
"""
eps_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
"""
fpx_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
"""
gb_bank_transfer_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges.
"""
giropay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
"""
grabpay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
"""
ideal_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
"""
india_international_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
"""
jcb_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
"""
jp_bank_transfer_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges.
"""
kakao_pay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.
"""
klarna_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
"""
konbini_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
"""
kr_card_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.
"""
legacy_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the legacy payments capability of the account.
"""
link_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the link_payments capability of the account, or whether the account can directly process Link charges.
"""
mb_way_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.
"""
mobilepay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.
"""
multibanco_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.
"""
mx_bank_transfer_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges.
"""
naver_pay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.
"""
nz_bank_account_becs_debit_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges.
"""
oxxo_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
"""
p24_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
"""
pay_by_bank_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.
"""
payco_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Payco capability of the account, or whether the account can directly process Payco payments.
"""
paynow_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
"""
pix_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the pix payments capability of the account, or whether the account can directly process pix charges.
"""
promptpay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
"""
revolut_pay_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
"""
samsung_pay_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.
"""
satispay_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Satispay capability of the account, or whether the account can directly process Satispay payments.
"""
sepa_bank_transfer_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges.
"""
sepa_debit_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
"""
sofort_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
"""
swish_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Swish capability of the account, or whether the account can directly process Swish payments.
"""
tax_reporting_us_1099_k: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the tax reporting 1099-K (US) capability of the account.
"""
tax_reporting_us_1099_misc: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the tax reporting 1099-MISC (US) capability of the account.
"""
transfers: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
"""
treasury: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the banking capability, or whether the account can have bank accounts.
"""
twint_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.
"""
us_bank_account_ach_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges.
"""
us_bank_transfer_payments: Optional[
Literal["active", "inactive", "pending"]
]
"""
The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges.
"""
zip_payments: Optional[Literal["active", "inactive", "pending"]]
"""
The status of the Zip capability of the account, or whether the account can directly process Zip charges.
"""
class Company(StripeObject):
class Address(StripeObject):
city: Optional[str]
"""
City, district, suburb, town, or village.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Address line 1, such as the street, PO Box, or company name.
"""
line2: Optional[str]
"""
Address line 2, such as the apartment, suite, unit, or building.
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
State, county, province, or region.
"""
class AddressKana(StripeObject):
city: Optional[str]
"""
City/Ward.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Block/Building number.
"""
line2: Optional[str]
"""
Building details.
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
Prefecture.
"""
town: Optional[str]
"""
Town/cho-me.
"""
class AddressKanji(StripeObject):
city: Optional[str]
"""
City/Ward.
"""
country: Optional[str]
"""
Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
"""
line1: Optional[str]
"""
Block/Building number.
"""
line2: Optional[str]
"""
Building details.
"""
postal_code: Optional[str]
"""
ZIP or postal code.
"""
state: Optional[str]
"""
Prefecture.
"""
town: Optional[str]
"""
Town/cho-me.
"""
class DirectorshipDeclaration(StripeObject):
date: Optional[int]
"""
The Unix timestamp marking when the directorship declaration attestation was made.
"""
ip: Optional[str]
"""
The IP address from which the directorship declaration attestation was made.
"""
user_agent: Optional[str]
"""
The user-agent string from the browser where the directorship declaration attestation was made.
"""
class OwnershipDeclaration(StripeObject):
date: Optional[int]
"""
The Unix timestamp marking when the beneficial owner attestation was made.
"""
ip: Optional[str]
"""
The IP address from which the beneficial owner attestation was made.
"""
user_agent: Optional[str]
"""
The user-agent string from the browser where the beneficial owner attestation was made.
"""
class RegistrationDate(StripeObject):
day: Optional[int]
"""
The day of registration, between 1 and 31.
"""
month: Optional[int]
"""
The month of registration, between 1 and 12.
"""
year: Optional[int]
"""
The four-digit year of registration.
"""
class RepresentativeDeclaration(StripeObject):
date: Optional[int]
"""
The Unix timestamp marking when the representative declaration attestation was made.
"""
ip: Optional[str]
"""
The IP address from which the representative declaration attestation was made.
"""
user_agent: Optional[str]
"""
The user-agent string from the browser where the representative declaration attestation was made.
"""
class Verification(StripeObject):
class Document(StripeObject):
back: Optional[ExpandableField["File"]]
"""
The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file).
"""
details: Optional[str]
"""
A user-displayable string describing the verification state of this document.
"""
details_code: Optional[str]
"""
One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document.
"""
front: Optional[ExpandableField["File"]]
"""
The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](https://docs.stripe.com/file-upload#uploading-a-file).
"""
document: Document
_inner_class_types = {"document": Document}
address: Optional[Address]
address_kana: Optional[AddressKana]
"""
The Kana variation of the company's primary address (Japan only).
"""
address_kanji: Optional[AddressKanji]
"""
The Kanji variation of the company's primary address (Japan only).
"""
directors_provided: Optional[bool]
"""
Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).
"""
directorship_declaration: Optional[DirectorshipDeclaration]
"""
This hash is used to attest that the director information provided to Stripe is both current and correct.
"""
executives_provided: Optional[bool]
"""
Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.
"""
export_license_id: Optional[str]
"""
The export license ID number of the company, also referred as Import Export Code (India only).
"""
export_purpose_code: Optional[str]
"""
The purpose code to use for export transactions (India only).
"""
name: Optional[str]
"""
The company's legal name. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
"""
name_kana: Optional[str]
"""
The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
"""
name_kanji: Optional[str]
"""
The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
"""
owners_provided: Optional[bool]
"""
Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).
"""
ownership_declaration: Optional[OwnershipDeclaration]
"""
This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
"""
ownership_exemption_reason: Optional[
Literal[
"qualified_entity_exceeds_ownership_threshold",
"qualifies_as_financial_institution",
]
]
"""
This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details.
"""
phone: Optional[str]
"""
The company's phone number (used for verification).
"""
registration_date: Optional[RegistrationDate]
representative_declaration: Optional[RepresentativeDeclaration]
"""
This hash is used to attest that the representative is authorized to act as the representative of their legal entity.
"""
structure: Optional[
Literal[
"free_zone_establishment",
"free_zone_llc",
"government_instrumentality",
"governmental_unit",
"incorporated_non_profit",
"incorporated_partnership",
"limited_liability_partnership",
"llc",
"multi_member_llc",
"private_company",
"private_corporation",
"private_partnership",
"public_company",
"public_corporation",
"public_partnership",
"registered_charity",
"single_member_llc",
"sole_establishment",
"sole_proprietorship",
"tax_exempt_government_instrumentality",
"unincorporated_association",
"unincorporated_non_profit",
"unincorporated_partnership",
]
]
"""
The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.
"""
tax_id_provided: Optional[bool]
"""
Whether the company's business ID number was provided.
"""
tax_id_registrar: Optional[str]
"""
The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
"""
vat_id_provided: Optional[bool]
"""
Whether the company's business VAT number was provided.
"""
verification: Optional[Verification]
"""
Information on the verification state of the company.
"""
_inner_class_types = {
"address": Address,
"address_kana": AddressKana,
"address_kanji": AddressKanji,
"directorship_declaration": DirectorshipDeclaration,
"ownership_declaration": OwnershipDeclaration,
"registration_date": RegistrationDate,
"representative_declaration": RepresentativeDeclaration,
"verification": Verification,
}
class Controller(StripeObject):
class Fees(StripeObject):
payer: Literal[
"account",
"application",
"application_custom",
"application_express",
]
"""
A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior).
"""
class Losses(StripeObject):
payments: Literal["application", "stripe"]
"""
A value indicating who is liable when this account can't pay back negative balances from payments.
"""
class StripeDashboard(StripeObject):
type: Literal["express", "full", "none"]
"""
A value indicating the Stripe dashboard this account has access to independent of the Connect application.
"""
fees: Optional[Fees]
is_controller: Optional[bool]
"""
`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.
"""
losses: Optional[Losses]
requirement_collection: Optional[Literal["application", "stripe"]]
"""
A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
"""
stripe_dashboard: Optional[StripeDashboard]
type: Literal["account", "application"]
"""
The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
"""
_inner_class_types = {
"fees": Fees,
"losses": Losses,
"stripe_dashboard": StripeDashboard,
}
class FutureRequirements(StripeObject):
class Alternative(StripeObject):
alternative_fields_due: List[str]
"""
Fields that can be provided to satisfy all fields in `original_fields_due`.
"""
original_fields_due: List[str]
"""
Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
"""
class Error(StripeObject):
code: Literal[
"external_request",
"information_missing",
"invalid_address_city_state_postal_code",
"invalid_address_highway_contract_box",
"invalid_address_private_mailbox",
"invalid_business_profile_name",
"invalid_business_profile_name_denylisted",
"invalid_company_name_denylisted",
"invalid_dob_age_over_maximum",
"invalid_dob_age_under_18",
"invalid_dob_age_under_minimum",
"invalid_product_description_length",
"invalid_product_description_url_match",
"invalid_representative_country",
"invalid_signator",
"invalid_statement_descriptor_business_mismatch",
"invalid_statement_descriptor_denylisted",
"invalid_statement_descriptor_length",
"invalid_statement_descriptor_prefix_denylisted",
"invalid_statement_descriptor_prefix_mismatch",
"invalid_street_address",
"invalid_tax_id",
"invalid_tax_id_format",
"invalid_tos_acceptance",
"invalid_url_denylisted",
"invalid_url_format",
"invalid_url_length",
"invalid_url_web_presence_detected",
"invalid_url_website_business_information_mismatch",
"invalid_url_website_empty",
"invalid_url_website_inaccessible",
"invalid_url_website_inaccessible_geoblocked",
"invalid_url_website_inaccessible_password_protected",
"invalid_url_website_incomplete",
"invalid_url_website_incomplete_cancellation_policy",
"invalid_url_website_incomplete_customer_service_details",
"invalid_url_website_incomplete_legal_restrictions",
"invalid_url_website_incomplete_refund_policy",
"invalid_url_website_incomplete_return_policy",
"invalid_url_website_incomplete_terms_and_conditions",
"invalid_url_website_incomplete_under_construction",
"invalid_url_website_other",
"invalid_value_other",
"unsupported_business_type",
"verification_directors_mismatch",
"verification_document_address_mismatch",
"verification_document_address_missing",
"verification_document_corrupt",
"verification_document_country_not_supported",
"verification_document_directors_mismatch",
"verification_document_dob_mismatch",
"verification_document_duplicate_type",
"verification_document_expired",
"verification_document_failed_copy",
"verification_document_failed_greyscale",
"verification_document_failed_other",
"verification_document_failed_test_mode",
"verification_document_fraudulent",
"verification_document_id_number_mismatch",
"verification_document_id_number_missing",
"verification_document_incomplete",
"verification_document_invalid",
"verification_document_issue_or_expiry_date_missing",
"verification_document_manipulated",
"verification_document_missing_back",
"verification_document_missing_front",
"verification_document_name_mismatch",
"verification_document_name_missing",
"verification_document_nationality_mismatch",
"verification_document_not_readable",
"verification_document_not_signed",
"verification_document_not_uploaded",
"verification_document_photo_mismatch",
"verification_document_too_large",
"verification_document_type_not_supported",
"verification_extraneous_directors",
"verification_failed_address_match",
"verification_failed_authorizer_authority",
"verification_failed_business_iec_number",
"verification_failed_document_match",
"verification_failed_id_number_match",
"verification_failed_keyed_identity",
"verification_failed_keyed_match",
"verification_failed_name_match",
"verification_failed_other",
"verification_failed_representative_authority",
"verification_failed_residential_address",
"verification_failed_tax_id_match",
"verification_failed_tax_id_not_issued",
"verification_legal_entity_structure_mismatch",
"verification_missing_directors",
"verification_missing_executives",
"verification_missing_owners",
"verification_rejected_ownership_exemption_reason",
"verification_requires_additional_memorandum_of_associations",
"verification_requires_additional_proof_of_registration",
"verification_supportability",
]
"""
The code for the type of error.
"""
reason: str
"""
An informative message that indicates the error type and provides additional details about the error.
"""
requirement: str
"""
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
"""
alternatives: Optional[List[Alternative]]
"""
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
"""
current_deadline: Optional[int]
"""
Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.
"""
currently_due: Optional[List[str]]
"""
Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
"""
disabled_reason: Optional[
Literal[
"action_required.requested_capabilities",
"listed",
"other",
"platform_paused",
"rejected.fraud",
"rejected.incomplete_verification",
"rejected.listed",
"rejected.other",
"rejected.platform_fraud",
"rejected.platform_other",
"rejected.platform_terms_of_service",
"rejected.terms_of_service",
"requirements.past_due",
"requirements.pending_verification",
"under_review",
]
]
"""
This is typed as an enum for consistency with `requirements.disabled_reason`.
"""
errors: Optional[List[Error]]
"""
Fields that are `currently_due` and need to be collected again because validation or verification failed.
"""
eventually_due: Optional[List[str]]
"""
Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
"""
past_due: Optional[List[str]]
"""
Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
"""
pending_verification: Optional[List[str]]
"""
Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
"""
_inner_class_types = {"alternatives": Alternative, "errors": Error}
class Groups(StripeObject):
payments_pricing: Optional[str]
"""
The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://stripe.com/docs/connect/platform-pricing-tools) for details.
"""
class Requirements(StripeObject):
class Alternative(StripeObject):
alternative_fields_due: List[str]
"""
Fields that can be provided to satisfy all fields in `original_fields_due`.
"""
original_fields_due: List[str]
"""
Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
"""
class Error(StripeObject):
code: Literal[
"external_request",
"information_missing",
"invalid_address_city_state_postal_code",
"invalid_address_highway_contract_box",
"invalid_address_private_mailbox",
"invalid_business_profile_name",
"invalid_business_profile_name_denylisted",
"invalid_company_name_denylisted",
"invalid_dob_age_over_maximum",
"invalid_dob_age_under_18",
"invalid_dob_age_under_minimum",
"invalid_product_description_length",
"invalid_product_description_url_match",
"invalid_representative_country",
"invalid_signator",
"invalid_statement_descriptor_business_mismatch",
"invalid_statement_descriptor_denylisted",
"invalid_statement_descriptor_length",
"invalid_statement_descriptor_prefix_denylisted",
"invalid_statement_descriptor_prefix_mismatch",
"invalid_street_address",
"invalid_tax_id",
"invalid_tax_id_format",
"invalid_tos_acceptance",
"invalid_url_denylisted",
"invalid_url_format",
"invalid_url_length",
"invalid_url_web_presence_detected",
"invalid_url_website_business_information_mismatch",
"invalid_url_website_empty",
"invalid_url_website_inaccessible",
"invalid_url_website_inaccessible_geoblocked",
"invalid_url_website_inaccessible_password_protected",
"invalid_url_website_incomplete",
"invalid_url_website_incomplete_cancellation_policy",
"invalid_url_website_incomplete_customer_service_details",
"invalid_url_website_incomplete_legal_restrictions",
"invalid_url_website_incomplete_refund_policy",
"invalid_url_website_incomplete_return_policy",
"invalid_url_website_incomplete_terms_and_conditions",
"invalid_url_website_incomplete_under_construction",
"invalid_url_website_other",
"invalid_value_other",
"unsupported_business_type",
"verification_directors_mismatch",
"verification_document_address_mismatch",
"verification_document_address_missing",
"verification_document_corrupt",
"verification_document_country_not_supported",
"verification_document_directors_mismatch",
"verification_document_dob_mismatch",
"verification_document_duplicate_type",
"verification_document_expired",
"verification_document_failed_copy",
"verification_document_failed_greyscale",
"verification_document_failed_other",
"verification_document_failed_test_mode",
"verification_document_fraudulent",
"verification_document_id_number_mismatch",
"verification_document_id_number_missing",
"verification_document_incomplete",
"verification_document_invalid",
"verification_document_issue_or_expiry_date_missing",
"verification_document_manipulated",
"verification_document_missing_back",
"verification_document_missing_front",
"verification_document_name_mismatch",
"verification_document_name_missing",
"verification_document_nationality_mismatch",
"verification_document_not_readable",
"verification_document_not_signed",
"verification_document_not_uploaded",
"verification_document_photo_mismatch",
"verification_document_too_large",
"verification_document_type_not_supported",
"verification_extraneous_directors",
"verification_failed_address_match",
"verification_failed_authorizer_authority",
"verification_failed_business_iec_number",
"verification_failed_document_match",
"verification_failed_id_number_match",
"verification_failed_keyed_identity",
"verification_failed_keyed_match",
"verification_failed_name_match",
"verification_failed_other",
"verification_failed_representative_authority",
"verification_failed_residential_address",
"verification_failed_tax_id_match",
"verification_failed_tax_id_not_issued",
"verification_legal_entity_structure_mismatch",
"verification_missing_directors",
"verification_missing_executives",
"verification_missing_owners",
"verification_rejected_ownership_exemption_reason",
"verification_requires_additional_memorandum_of_associations",
"verification_requires_additional_proof_of_registration",
"verification_supportability",
]
"""
The code for the type of error.
"""
reason: str
"""
An informative message that indicates the error type and provides additional details about the error.
"""
requirement: str
"""
The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
"""
alternatives: Optional[List[Alternative]]
"""
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
"""
current_deadline: Optional[int]
"""
Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.
"""
currently_due: Optional[List[str]]
"""
Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
"""
disabled_reason: Optional[
Literal[
"action_required.requested_capabilities",
"listed",
"other",
"platform_paused",
"rejected.fraud",
"rejected.incomplete_verification",
"rejected.listed",
"rejected.other",
"rejected.platform_fraud",
"rejected.platform_other",
"rejected.platform_terms_of_service",
"rejected.terms_of_service",
"requirements.past_due",
"requirements.pending_verification",
"under_review",
]
]
"""
If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
"""
errors: Optional[List[Error]]
"""
Fields that are `currently_due` and need to be collected again because validation or verification failed.
"""
eventually_due: Optional[List[str]]
"""
Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
"""
past_due: Optional[List[str]]
"""
Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.
"""
pending_verification: Optional[List[str]]
"""
Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
"""
_inner_class_types = {"alternatives": Alternative, "errors": Error}
class Settings(StripeObject):
class BacsDebitPayments(StripeObject):
display_name: Optional[str]
"""
The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free.
"""
service_user_number: Optional[str]
"""
The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.
"""
class Branding(StripeObject):
icon: Optional[ExpandableField["File"]]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
"""
logo: Optional[ExpandableField["File"]]
"""
(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
"""
primary_color: Optional[str]
"""
A CSS hex color value representing the primary branding color for this account
"""
secondary_color: Optional[str]
"""
A CSS hex color value representing the secondary branding color for this account
"""
class CardIssuing(StripeObject):
class TosAcceptance(StripeObject):
date: Optional[int]
"""
The Unix timestamp marking when the account representative accepted the service agreement.
"""
ip: Optional[str]
"""
The IP address from which the account representative accepted the service agreement.
"""
user_agent: Optional[str]
"""
The user agent of the browser from which the account representative accepted the service agreement.
"""
tos_acceptance: Optional[TosAcceptance]
_inner_class_types = {"tos_acceptance": TosAcceptance}
class CardPayments(StripeObject):
class DeclineOn(StripeObject):
avs_failure: bool
"""
Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.
"""
cvc_failure: bool
"""
Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
"""
decline_on: Optional[DeclineOn]
statement_descriptor_prefix: Optional[str]
"""
The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
"""
statement_descriptor_prefix_kana: Optional[str]
"""
The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion.
"""
statement_descriptor_prefix_kanji: Optional[str]
"""
The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion.
"""
_inner_class_types = {"decline_on": DeclineOn}
class Dashboard(StripeObject):
display_name: Optional[str]
"""
The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.
"""
timezone: Optional[str]
"""
The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).
"""
class Invoices(StripeObject):
default_account_tax_ids: Optional[List[ExpandableField["TaxId"]]]
"""
The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized.
"""
hosted_payment_method_save: Optional[
Literal["always", "never", "offer"]
]
"""
Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page.
"""
class Payments(StripeObject):
statement_descriptor: Optional[str]
"""
The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.
"""
statement_descriptor_kana: Optional[str]
"""
The Kana variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
"""
statement_descriptor_kanji: Optional[str]
"""
The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
"""
statement_descriptor_prefix_kana: Optional[str]
"""
The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
"""
statement_descriptor_prefix_kanji: Optional[str]
"""
The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors).
"""
class Payouts(StripeObject):
class Schedule(StripeObject):
delay_days: int
"""
The number of days charges for the account will be held before being paid out.
"""
interval: str
"""
How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
"""
monthly_anchor: Optional[int]
"""
The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
"""
monthly_payout_days: Optional[List[int]]
"""
The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
"""
weekly_anchor: Optional[str]
"""
The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly.
"""
weekly_payout_days: Optional[
List[
Literal[
"friday",
"monday",
"thursday",
"tuesday",
"wednesday",
]
]
]
"""
The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
"""
debit_negative_balances: bool
"""
A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
"""
schedule: Schedule
statement_descriptor: Optional[str]
"""
The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
"""
_inner_class_types = {"schedule": Schedule}
class SepaDebitPayments(StripeObject):
creditor_id: Optional[str]
"""
SEPA creditor identifier that identifies the company making the payment.
"""
class Treasury(StripeObject):
class TosAcceptance(StripeObject):
date: Optional[int]
"""
The Unix timestamp marking when the account representative accepted the service agreement.
"""
ip: Optional[str]
"""
The IP address from which the account representative accepted the service agreement.
"""
user_agent: Optional[str]
"""
The user agent of the browser from which the account representative accepted the service agreement.
"""
tos_acceptance: Optional[TosAcceptance]
_inner_class_types = {"tos_acceptance": TosAcceptance}
bacs_debit_payments: Optional[BacsDebitPayments]
branding: Branding
card_issuing: Optional[CardIssuing]
card_payments: CardPayments
dashboard: Dashboard
invoices: Optional[Invoices]
payments: Payments
payouts: Optional[Payouts]
sepa_debit_payments: Optional[SepaDebitPayments]
treasury: Optional[Treasury]
_inner_class_types = {
"bacs_debit_payments": BacsDebitPayments,
"branding": Branding,
"card_issuing": CardIssuing,
"card_payments": CardPayments,
"dashboard": Dashboard,
"invoices": Invoices,
"payments": Payments,
"payouts": Payouts,
"sepa_debit_payments": SepaDebitPayments,
"treasury": Treasury,
}
class TosAcceptance(StripeObject):
date: Optional[int]
"""
The Unix timestamp marking when the account representative accepted their service agreement
"""
ip: Optional[str]
"""
The IP address from which the account representative accepted their service agreement
"""
service_agreement: Optional[str]
"""
The user's service agreement type
"""
user_agent: Optional[str]
"""
The user agent of the browser from which the account representative accepted their service agreement
"""
business_profile: Optional[BusinessProfile]
"""
Business information about the account.
"""
business_type: Optional[
Literal["company", "government_entity", "individual", "non_profit"]
]
"""
The business type.
"""
capabilities: Optional[Capabilities]
charges_enabled: Optional[bool]
"""
Whether the account can process charges.
"""
company: Optional[Company]
controller: Optional[Controller]
country: Optional[str]
"""
The account's country.
"""
created: Optional[int]
"""
Time at which the account was connected. Measured in seconds since the Unix epoch.
"""
default_currency: Optional[str]
"""
Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
"""
deleted: Optional[Literal[True]]
"""
Always true for a deleted object
"""
details_submitted: Optional[bool]
"""
Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](https://docs.stripe.com/connect/onboarding) to finish submitting account details.
"""
email: Optional[str]
"""
An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.
"""
external_accounts: Optional[ListObject[Union["BankAccount", "Card"]]]
"""
External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true.
"""
future_requirements: Optional[FutureRequirements]
groups: Optional[Groups]
"""
The groups associated with the account.
"""
id: str
"""
Unique identifier for the object.
"""
individual: Optional["Person"]
"""
This is an object representing a person associated with a Stripe account.
A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
See the [Standard onboarding](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information).
"""
metadata: Optional[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.
"""
object: Literal["account"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
payouts_enabled: Optional[bool]
"""
Whether the funds in this account can be paid out.
"""
requirements: Optional[Requirements]
settings: Optional[Settings]
"""
Options for customizing how the account functions within Stripe.
"""
tos_acceptance: Optional[TosAcceptance]
type: Optional[Literal["custom", "express", "none", "standard"]]
"""
The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.
"""
@classmethod
def create(cls, **params: Unpack["AccountCreateParams"]) -> "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",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["AccountCreateParams"]
) -> "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 cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def _cls_delete(
cls, sid: str, **params: Unpack["AccountDeleteParams"]
) -> "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.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
return cast(
"Account",
cls._static_request(
"delete",
url,
params=params,
),
)
@overload
@staticmethod
def delete(sid: str, **params: Unpack["AccountDeleteParams"]) -> "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.
"""
...
@overload
def delete(self, **params: Unpack["AccountDeleteParams"]) -> "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.
"""
...
@class_method_variant("_cls_delete")
def delete( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["AccountDeleteParams"]
) -> "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 self._request_and_refresh(
"delete",
self.instance_url(),
params=params,
)
@classmethod
async def _cls_delete_async(
cls, sid: str, **params: Unpack["AccountDeleteParams"]
) -> "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.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
return cast(
"Account",
await cls._static_request_async(
"delete",
url,
params=params,
),
)
@overload
@staticmethod
async def delete_async(
sid: str, **params: Unpack["AccountDeleteParams"]
) -> "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.
"""
...
@overload
async def delete_async(
self, **params: Unpack["AccountDeleteParams"]
) -> "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.
"""
...
@class_method_variant("_cls_delete_async")
async def delete_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["AccountDeleteParams"]
) -> "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 await self._request_and_refresh_async(
"delete",
self.instance_url(),
params=params,
)
@classmethod
def list(
cls, **params: Unpack["AccountListParams"]
) -> 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.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["AccountListParams"]
) -> 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.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def _cls_persons(
cls, account: str, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject["Person"],
cls._static_request(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account)
),
params=params,
),
)
@overload
@staticmethod
def persons(
account: str, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
...
@overload
def persons(
self, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
...
@class_method_variant("_cls_persons")
def persons( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject["Person"],
self._request(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
async def _cls_persons_async(
cls, account: str, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject["Person"],
await cls._static_request_async(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account)
),
params=params,
),
)
@overload
@staticmethod
async def persons_async(
account: str, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
...
@overload
async def persons_async(
self, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
...
@class_method_variant("_cls_persons_async")
async def persons_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["AccountPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject["Person"],
await self._request_async(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(self.get("id"))
),
params=params,
),
)
@classmethod
def _cls_reject(
cls, account: str, **params: Unpack["AccountRejectParams"]
) -> "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",
cls._static_request(
"post",
"/v1/accounts/{account}/reject".format(
account=sanitize_id(account)
),
params=params,
),
)
@overload
@staticmethod
def reject(
account: str, **params: Unpack["AccountRejectParams"]
) -> "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.
"""
...
@overload
def reject(self, **params: Unpack["AccountRejectParams"]) -> "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.
"""
...
@class_method_variant("_cls_reject")
def reject( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["AccountRejectParams"]
) -> "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(self.get("id"))
),
params=params,
),
)
@classmethod
async def _cls_reject_async(
cls, account: str, **params: Unpack["AccountRejectParams"]
) -> "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 cls._static_request_async(
"post",
"/v1/accounts/{account}/reject".format(
account=sanitize_id(account)
),
params=params,
),
)
@overload
@staticmethod
async def reject_async(
account: str, **params: Unpack["AccountRejectParams"]
) -> "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.
"""
...
@overload
async def reject_async(
self, **params: Unpack["AccountRejectParams"]
) -> "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.
"""
...
@class_method_variant("_cls_reject_async")
async def reject_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["AccountRejectParams"]
) -> "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(self.get("id"))
),
params=params,
),
)
@classmethod
def retrieve(cls, id=None, **params) -> "Account":
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(cls, id=None, **params) -> "Account":
instance = cls(id, **params)
await instance.refresh_async()
return instance
@classmethod
def modify(cls, id=None, **params) -> "Account":
url = cls._build_instance_url(id)
return cast("Account", cls._static_request("post", url, params=params))
@classmethod
async def modify_async(cls, id=None, **params) -> "Account":
url = cls._build_instance_url(id)
return cast(
"Account",
await cls._static_request_async("post", url, params=params),
)
@classmethod
def _build_instance_url(cls, sid):
if not sid:
return "/v1/account"
base = cls.class_url()
extn = sanitize_id(sid)
return "%s/%s" % (base, extn)
def instance_url(self):
return self._build_instance_url(self.get("id"))
def deauthorize(self, **params):
params["stripe_user_id"] = self.id
return OAuth.deauthorize(**params)
def serialize(self, previous):
params = super(Account, self).serialize(previous)
previous = previous or self._previous or {}
for k, v in iter(self.items()):
if k == "individual" and isinstance(v, Person) and k not in params:
params[k] = v.serialize(previous.get(k, None))
return params
@classmethod
def list_capabilities(
cls, account: str, **params: Unpack["AccountListCapabilitiesParams"]
) -> ListObject["Capability"]:
"""
Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
"""
return cast(
ListObject["Capability"],
cls._static_request(
"get",
"/v1/accounts/{account}/capabilities".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
async def list_capabilities_async(
cls, account: str, **params: Unpack["AccountListCapabilitiesParams"]
) -> ListObject["Capability"]:
"""
Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
"""
return cast(
ListObject["Capability"],
await cls._static_request_async(
"get",
"/v1/accounts/{account}/capabilities".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
def retrieve_capability(
cls,
account: str,
capability: str,
**params: Unpack["AccountRetrieveCapabilityParams"],
) -> "Capability":
"""
Retrieves information about the specified Account Capability.
"""
return cast(
"Capability",
cls._static_request(
"get",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
params=params,
),
)
@classmethod
async def retrieve_capability_async(
cls,
account: str,
capability: str,
**params: Unpack["AccountRetrieveCapabilityParams"],
) -> "Capability":
"""
Retrieves information about the specified Account Capability.
"""
return cast(
"Capability",
await cls._static_request_async(
"get",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
params=params,
),
)
@classmethod
def modify_capability(
cls,
account: str,
capability: str,
**params: Unpack["AccountModifyCapabilityParams"],
) -> "Capability":
"""
Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
"""
return cast(
"Capability",
cls._static_request(
"post",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
params=params,
),
)
@classmethod
async def modify_capability_async(
cls,
account: str,
capability: str,
**params: Unpack["AccountModifyCapabilityParams"],
) -> "Capability":
"""
Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
"""
return cast(
"Capability",
await cls._static_request_async(
"post",
"/v1/accounts/{account}/capabilities/{capability}".format(
account=sanitize_id(account),
capability=sanitize_id(capability),
),
params=params,
),
)
@classmethod
def delete_external_account(
cls,
account: str,
id: str,
**params: Unpack["AccountDeleteExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Delete a specified external account for a given account.
"""
return cast(
Union["BankAccount", "Card"],
cls._static_request(
"delete",
"/v1/accounts/{account}/external_accounts/{id}".format(
account=sanitize_id(account), id=sanitize_id(id)
),
params=params,
),
)
@classmethod
async def delete_external_account_async(
cls,
account: str,
id: str,
**params: Unpack["AccountDeleteExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Delete a specified external account for a given account.
"""
return cast(
Union["BankAccount", "Card"],
await cls._static_request_async(
"delete",
"/v1/accounts/{account}/external_accounts/{id}".format(
account=sanitize_id(account), id=sanitize_id(id)
),
params=params,
),
)
@classmethod
def retrieve_external_account(
cls,
account: str,
id: str,
**params: Unpack["AccountRetrieveExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Retrieve a specified external account for a given account.
"""
return cast(
Union["BankAccount", "Card"],
cls._static_request(
"get",
"/v1/accounts/{account}/external_accounts/{id}".format(
account=sanitize_id(account), id=sanitize_id(id)
),
params=params,
),
)
@classmethod
async def retrieve_external_account_async(
cls,
account: str,
id: str,
**params: Unpack["AccountRetrieveExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Retrieve a specified external account for a given account.
"""
return cast(
Union["BankAccount", "Card"],
await cls._static_request_async(
"get",
"/v1/accounts/{account}/external_accounts/{id}".format(
account=sanitize_id(account), id=sanitize_id(id)
),
params=params,
),
)
@classmethod
def modify_external_account(
cls,
account: str,
id: str,
**params: Unpack["AccountModifyExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Updates the metadata, account holder name, account holder type of a bank account belonging to
a connected account and optionally sets it as the default for its currency. Other bank account
details are not editable by design.
You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
You can re-enable a disabled bank account by performing an update call without providing any
arguments or changes.
"""
return cast(
Union["BankAccount", "Card"],
cls._static_request(
"post",
"/v1/accounts/{account}/external_accounts/{id}".format(
account=sanitize_id(account), id=sanitize_id(id)
),
params=params,
),
)
@classmethod
async def modify_external_account_async(
cls,
account: str,
id: str,
**params: Unpack["AccountModifyExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Updates the metadata, account holder name, account holder type of a bank account belonging to
a connected account and optionally sets it as the default for its currency. Other bank account
details are not editable by design.
You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
You can re-enable a disabled bank account by performing an update call without providing any
arguments or changes.
"""
return cast(
Union["BankAccount", "Card"],
await cls._static_request_async(
"post",
"/v1/accounts/{account}/external_accounts/{id}".format(
account=sanitize_id(account), id=sanitize_id(id)
),
params=params,
),
)
@classmethod
def list_external_accounts(
cls,
account: str,
**params: Unpack["AccountListExternalAccountsParams"],
) -> ListObject[Union["BankAccount", "Card"]]:
"""
List external accounts for an account.
"""
return cast(
ListObject[Union["BankAccount", "Card"]],
cls._static_request(
"get",
"/v1/accounts/{account}/external_accounts".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
async def list_external_accounts_async(
cls,
account: str,
**params: Unpack["AccountListExternalAccountsParams"],
) -> ListObject[Union["BankAccount", "Card"]]:
"""
List external accounts for an account.
"""
return cast(
ListObject[Union["BankAccount", "Card"]],
await cls._static_request_async(
"get",
"/v1/accounts/{account}/external_accounts".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
def create_external_account(
cls,
account: str,
**params: Unpack["AccountCreateExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Create an external account for a given account.
"""
return cast(
Union["BankAccount", "Card"],
cls._static_request(
"post",
"/v1/accounts/{account}/external_accounts".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
async def create_external_account_async(
cls,
account: str,
**params: Unpack["AccountCreateExternalAccountParams"],
) -> Union["BankAccount", "Card"]:
"""
Create an external account for a given account.
"""
return cast(
Union["BankAccount", "Card"],
await cls._static_request_async(
"post",
"/v1/accounts/{account}/external_accounts".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
def create_login_link(
cls, account: str, **params: Unpack["AccountCreateLoginLinkParams"]
) -> "LoginLink":
"""
Creates a login link for a connected account to access the Express Dashboard.
You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform.
"""
return cast(
"LoginLink",
cls._static_request(
"post",
"/v1/accounts/{account}/login_links".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
async def create_login_link_async(
cls, account: str, **params: Unpack["AccountCreateLoginLinkParams"]
) -> "LoginLink":
"""
Creates a login link for a connected account to access the Express Dashboard.
You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform.
"""
return cast(
"LoginLink",
await cls._static_request_async(
"post",
"/v1/accounts/{account}/login_links".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
def delete_person(
cls,
account: str,
person: str,
**params: Unpack["AccountDeletePersonParams"],
) -> "Person":
"""
Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
"""
return cast(
"Person",
cls._static_request(
"delete",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account), person=sanitize_id(person)
),
params=params,
),
)
@classmethod
async def delete_person_async(
cls,
account: str,
person: str,
**params: Unpack["AccountDeletePersonParams"],
) -> "Person":
"""
Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
"""
return cast(
"Person",
await cls._static_request_async(
"delete",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account), person=sanitize_id(person)
),
params=params,
),
)
@classmethod
def retrieve_person(
cls,
account: str,
person: str,
**params: Unpack["AccountRetrievePersonParams"],
) -> "Person":
"""
Retrieves an existing person.
"""
return cast(
"Person",
cls._static_request(
"get",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account), person=sanitize_id(person)
),
params=params,
),
)
@classmethod
async def retrieve_person_async(
cls,
account: str,
person: str,
**params: Unpack["AccountRetrievePersonParams"],
) -> "Person":
"""
Retrieves an existing person.
"""
return cast(
"Person",
await cls._static_request_async(
"get",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account), person=sanitize_id(person)
),
params=params,
),
)
@classmethod
def modify_person(
cls,
account: str,
person: str,
**params: Unpack["AccountModifyPersonParams"],
) -> "Person":
"""
Updates an existing person.
"""
return cast(
"Person",
cls._static_request(
"post",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account), person=sanitize_id(person)
),
params=params,
),
)
@classmethod
async def modify_person_async(
cls,
account: str,
person: str,
**params: Unpack["AccountModifyPersonParams"],
) -> "Person":
"""
Updates an existing person.
"""
return cast(
"Person",
await cls._static_request_async(
"post",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account), person=sanitize_id(person)
),
params=params,
),
)
@classmethod
def list_persons(
cls, account: str, **params: Unpack["AccountListPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject["Person"],
cls._static_request(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
async def list_persons_async(
cls, account: str, **params: Unpack["AccountListPersonsParams"]
) -> ListObject["Person"]:
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
ListObject["Person"],
await cls._static_request_async(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
def create_person(
cls, account: str, **params: Unpack["AccountCreatePersonParams"]
) -> "Person":
"""
Creates a new person.
"""
return cast(
"Person",
cls._static_request(
"post",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account)
),
params=params,
),
)
@classmethod
async def create_person_async(
cls, account: str, **params: Unpack["AccountCreatePersonParams"]
) -> "Person":
"""
Creates a new person.
"""
return cast(
"Person",
await cls._static_request_async(
"post",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account)
),
params=params,
),
)
_inner_class_types = {
"business_profile": BusinessProfile,
"capabilities": Capabilities,
"company": Company,
"controller": Controller,
"future_requirements": FutureRequirements,
"groups": Groups,
"requirements": Requirements,
"settings": Settings,
"tos_acceptance": TosAcceptance,
}
|