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 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::client::{Client, Response};
use crate::ids::{CouponId, CustomerId, PlanId, PriceId, PromotionCodeId, SubscriptionId};
use crate::params::{
Deleted, Expand, Expandable, List, Metadata, Object, Paginable, RangeQuery, Timestamp,
};
use crate::resources::{
Account, Application, CollectionMethod, ConnectAccountReference, Currency, Customer, Discount,
Invoice, InvoicePaymentMethodOptionsAcssDebit, InvoicePaymentMethodOptionsBancontact,
InvoicePaymentMethodOptionsCustomerBalance, InvoicePaymentMethodOptionsKonbini,
InvoicePaymentMethodOptionsUsBankAccount, PaymentMethod, PaymentSource, Scheduled, SetupIntent,
SubscriptionBillingThresholds, SubscriptionItem, SubscriptionItemBillingThresholds,
SubscriptionSchedule, SubscriptionTransferData, SubscriptionsTrialsResourceTrialSettings,
TaxRate, TestHelpersTestClock,
};
/// The resource representing a Stripe "Subscription".
///
/// For more details see <https://stripe.com/docs/api/subscriptions/object>
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct Subscription {
/// Unique identifier for the object.
pub id: SubscriptionId,
/// ID of the Connect Application that created the subscription.
pub application: Option<Expandable<Application>>,
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
pub application_fee_percent: Option<f64>,
pub automatic_tax: SubscriptionAutomaticTax,
/// The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates.
///
/// It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
/// The timestamp is in UTC format.
pub billing_cycle_anchor: Timestamp,
/// The fixed values used to calculate the `billing_cycle_anchor`.
pub billing_cycle_anchor_config: Option<SubscriptionsResourceBillingCycleAnchorConfig>,
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
pub billing_thresholds: Option<SubscriptionBillingThresholds>,
/// A date in the future at which the subscription will automatically get canceled.
pub cancel_at: Option<Timestamp>,
/// If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true.
///
/// You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
pub cancel_at_period_end: bool,
/// If the subscription has been canceled, the date of that cancellation.
///
/// If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
pub canceled_at: Option<Timestamp>,
/// Details about why this subscription was cancelled.
pub cancellation_details: Option<CancellationDetails>,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
pub collection_method: Option<CollectionMethod>,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
pub created: Timestamp,
/// 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).
pub currency: Currency,
/// End of the current period that the subscription has been invoiced for.
///
/// At the end of this period, a new invoice will be created.
pub current_period_end: Timestamp,
/// Start of the current period that the subscription has been invoiced for.
pub current_period_start: Timestamp,
/// ID of the customer who owns the subscription.
pub customer: Expandable<Customer>,
/// Number of days a customer has to pay invoices generated by this subscription.
///
/// This value will be `null` for subscriptions where `collection_method=charge_automatically`.
pub days_until_due: Option<u32>,
/// ID of the default payment method for the subscription.
///
/// It must belong to the customer associated with the subscription.
/// This takes precedence over `default_source`.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
pub default_payment_method: Option<Expandable<PaymentMethod>>,
/// ID of the default payment source for the subscription.
///
/// It must belong to the customer associated with the subscription and be in a chargeable state.
/// If `default_payment_method` is also set, `default_payment_method` will take precedence.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
pub default_source: Option<Expandable<PaymentSource>>,
/// The tax rates that will apply to any subscription item that does not have `tax_rates` set.
///
/// Invoices created will have their `default_tax_rates` populated from the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<TaxRate>>,
/// The subscription's description, meant to be displayable to the customer.
///
/// Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
pub description: Option<String>,
/// Describes the current discount applied to this subscription, if there is one.
///
/// When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
pub discount: Option<Discount>,
/// If the subscription has ended, the date the subscription ended.
pub ended_at: Option<Timestamp>,
/// List of subscription items, each with an attached price.
pub items: List<SubscriptionItem>,
/// The most recent invoice this subscription has generated.
pub latest_invoice: Option<Expandable<Invoice>>,
/// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
pub livemode: bool,
/// 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.
pub metadata: Metadata,
/// Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
pub next_pending_invoice_item_invoice: Option<Timestamp>,
/// The account (if any) the charge was made on behalf of for charges associated with this subscription.
///
/// See the Connect documentation for details.
pub on_behalf_of: Option<Expandable<Account>>,
/// If specified, payment collection for this subscription will be paused.
pub pause_collection: Option<SubscriptionsResourcePauseCollection>,
/// Payment settings passed on to invoices created by the subscription.
pub payment_settings: Option<SubscriptionsResourcePaymentSettings>,
/// Specifies an interval for how often to bill for any pending invoice items.
///
/// It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
pub pending_invoice_item_interval: Option<SubscriptionPendingInvoiceItemInterval>,
/// You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments.
///
/// Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
pub pending_setup_intent: Option<Expandable<SetupIntent>>,
/// If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
pub pending_update: Option<SubscriptionsResourcePendingUpdate>,
/// The schedule attached to the subscription.
pub schedule: Option<Expandable<SubscriptionSchedule>>,
/// Date when the subscription was first created.
///
/// The date might differ from the `created` date due to backdating.
pub start_date: Timestamp,
/// Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`.
///
/// For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails.
/// A subscription in this state can only have metadata and default_source updated.
/// Once the first invoice is paid, the subscription moves into an `active` state.
/// If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`.
/// This is a terminal state, the open invoice will be voided and no further invoices will be generated.
/// A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.
/// If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions).
/// Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).
/// If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that.
/// Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed).
/// After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
pub status: SubscriptionStatus,
/// ID of the test clock this subscription belongs to.
pub test_clock: Option<Expandable<TestHelpersTestClock>>,
/// The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
pub transfer_data: Option<SubscriptionTransferData>,
/// If the subscription has a trial, the end of that trial.
pub trial_end: Option<Timestamp>,
/// Settings related to subscription trials.
pub trial_settings: Option<SubscriptionsTrialsResourceTrialSettings>,
/// If the subscription has a trial, the beginning of that trial.
pub trial_start: Option<Timestamp>,
}
impl Subscription {
/// By default, returns a list of subscriptions that have not been canceled.
///
/// In order to list canceled subscriptions, specify `status=canceled`.
pub fn list(client: &Client, params: &ListSubscriptions<'_>) -> Response<List<Subscription>> {
client.get_query("/subscriptions", params)
}
/// Creates a new subscription on an existing customer.
///
/// Each customer can have up to 500 active or scheduled subscriptions. When you create a subscription with `collection_method=charge_automatically`, the first invoice is finalized as part of the request. The `payment_behavior` parameter determines the exact behavior of the initial payment. To start subscriptions where the first invoice always begins in a `draft` status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. Schedules provide the flexibility to model more complex billing configurations that change over time.
pub fn create(client: &Client, params: CreateSubscription<'_>) -> Response<Subscription> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form("/subscriptions", ¶ms)
}
/// Retrieves the subscription with the given ID.
pub fn retrieve(
client: &Client,
id: &SubscriptionId,
expand: &[&str],
) -> Response<Subscription> {
client.get_query(&format!("/subscriptions/{}", id), Expand { expand })
}
/// Updates an existing subscription to match the specified parameters.
/// When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
/// To preview how the proration is calculated, use the [upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) endpoint.
///
/// By default, we prorate subscription changes.
///
/// For example, if a customer signs up on May 1 for a $100 price, they’ll be billed $100 immediately.
/// If on May 15 they switch to a $200 price, then on June 1 they’ll be billed $250 ($200 for a renewal of her subscription, plus a $50 prorating adjustment for half of the previous month’s $100 difference).
/// Similarly, a downgrade generates a credit that is applied to the next invoice.
/// We also prorate when you make quantity changes. Switching prices does not normally change the billing date or generate an immediate charge unless: <ul> <li>The billing interval is changed (for example, from monthly to yearly).</li> <li>The subscription moves from free to paid, or paid to free.</li> <li>A trial starts or ends.</li> </ul> In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. If you want to charge for an upgrade immediately, pass `proration_behavior` as `always_invoice` to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment.
/// If you pass `create_prorations`, the prorations are created but not automatically invoiced.
/// If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create). If you don’t want to prorate, set the `proration_behavior` option to `none`.
/// With this option, the customer is billed $100 on May 1 and $200 on June 1.
/// Similarly, if you set `proration_behavior` to `none` when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time.
/// We still reset the billing date and bill immediately for the new subscription. Updating the quantity on a subscription many times in an hour may result in [rate limiting](https://stripe.com/docs/rate-limits).
/// If you need to bill for a frequently changing quantity, consider integrating [usage-based billing](https://stripe.com/docs/billing/subscriptions/usage-based) instead.
pub fn update(
client: &Client,
id: &SubscriptionId,
params: UpdateSubscription<'_>,
) -> Response<Subscription> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form(&format!("/subscriptions/{}", id), ¶ms)
}
/// Cancels a customer’s subscription immediately.
///
/// The customer will not be charged again for the subscription. Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem).
/// If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period.
/// But if the subscription is set to cancel immediately, pending prorations will be removed. By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer.
/// This is intended to prevent unexpected payment attempts after the customer has canceled a subscription.
/// However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed.
/// Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
pub fn delete(client: &Client, id: &SubscriptionId) -> Response<Deleted<SubscriptionId>> {
client.delete(&format!("/subscriptions/{}", id))
}
}
impl Object for Subscription {
type Id = SubscriptionId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"subscription"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CancellationDetails {
/// Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
pub comment: Option<String>,
/// The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
pub feedback: Option<CancellationDetailsFeedback>,
/// Why this subscription was canceled.
pub reason: Option<CancellationDetailsReason>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionAutomaticTax {
/// Whether Stripe automatically computes tax on this subscription.
pub enabled: bool,
/// The account that's liable for tax.
///
/// If set, the business address and tax registrations required to perform the tax calculation are loaded from this account.
/// The tax transaction is returned in the report of the connected account.
pub liability: Option<ConnectAccountReference>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionPendingInvoiceItemInterval {
/// Specifies invoicing frequency.
///
/// Either `day`, `week`, `month` or `year`.
pub interval: PlanInterval,
/// The number of intervals between invoices.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
/// Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
pub interval_count: u64,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourceBillingCycleAnchorConfig {
/// The day of the month of the billing_cycle_anchor.
pub day_of_month: i64,
/// The hour of the day of the billing_cycle_anchor.
pub hour: Option<i64>,
/// The minute of the hour of the billing_cycle_anchor.
pub minute: Option<i64>,
/// The month to start full cycle billing periods.
pub month: Option<i64>,
/// The second of the minute of the billing_cycle_anchor.
pub second: Option<i64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePauseCollection {
/// The payment collection behavior for this subscription while paused.
///
/// One of `keep_as_draft`, `mark_uncollectible`, or `void`.
pub behavior: SubscriptionsResourcePauseCollectionBehavior,
/// The time after which the subscription will resume collecting payments.
pub resumes_at: Option<Timestamp>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePaymentSettings {
/// Payment-method-specific configuration to provide to invoices created by the subscription.
pub payment_method_options: Option<SubscriptionsResourcePaymentMethodOptions>,
/// The list of payment method types to provide to every invoice created by the subscription.
///
/// If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
pub payment_method_types: Option<Vec<SubscriptionsResourcePaymentSettingsPaymentMethodTypes>>,
/// Either `off`, or `on_subscription`.
///
/// With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
pub save_default_payment_method:
Option<SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePaymentMethodOptions {
/// This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
pub acss_debit: Option<InvoicePaymentMethodOptionsAcssDebit>,
/// This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
pub bancontact: Option<InvoicePaymentMethodOptionsBancontact>,
/// This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
pub card: Option<SubscriptionPaymentMethodOptionsCard>,
/// This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
pub customer_balance: Option<InvoicePaymentMethodOptionsCustomerBalance>,
/// This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
pub konbini: Option<InvoicePaymentMethodOptionsKonbini>,
/// This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
pub us_bank_account: Option<InvoicePaymentMethodOptionsUsBankAccount>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionPaymentMethodOptionsCard {
#[serde(skip_serializing_if = "Option::is_none")]
pub mandate_options: Option<InvoiceMandateOptionsCard>,
/// Selected network to process this Subscription on.
///
/// Depends on the available networks of the card attached to the Subscription.
/// Can be only set confirm-time.
pub network: Option<SubscriptionPaymentMethodOptionsCardNetwork>,
/// We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication).
///
/// However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
/// Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
pub request_three_d_secure: Option<SubscriptionPaymentMethodOptionsCardRequestThreeDSecure>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoiceMandateOptionsCard {
/// Amount to be charged for future payments.
pub amount: Option<i64>,
/// One of `fixed` or `maximum`.
///
/// If `fixed`, the `amount` param refers to the exact amount to be charged in future payments.
/// If `maximum`, the amount charged can be up to the value passed for the `amount` param.
pub amount_type: Option<InvoiceMandateOptionsCardAmountType>,
/// A description of the mandate or subscription that is meant to be displayed to the customer.
pub description: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePendingUpdate {
/// If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.
///
/// The timestamp is in UTC format.
pub billing_cycle_anchor: Option<Timestamp>,
/// The point after which the changes reflected by this update will be discarded and no longer applied.
pub expires_at: Timestamp,
/// List of subscription items, each with an attached plan, that will be set if the update is applied.
pub subscription_items: Option<Vec<SubscriptionItem>>,
/// Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
pub trial_end: Option<Timestamp>,
/// Indicates if a plan's `trial_period_days` should be applied to the subscription.
///
/// Setting `trial_end` per subscription is preferred, and this defaults to `false`.
/// Setting this flag to `true` together with `trial_end` is not allowed.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
pub trial_from_plan: Option<bool>,
}
/// The parameters for `Subscription::create`.
#[derive(Clone, Debug, Serialize)]
pub struct CreateSubscription<'a> {
/// A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription.
///
/// You may pass up to 20 items.
#[serde(skip_serializing_if = "Option::is_none")]
pub add_invoice_items: Option<Vec<AddInvoiceItems>>,
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
/// The request must be made by a platform account on a connected account in order to set an application fee percentage.
/// For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
#[serde(skip_serializing_if = "Option::is_none")]
pub application_fee_percent: Option<f64>,
/// Automatic tax settings for this subscription.
///
/// We recommend you only include this parameter when the existing value is being changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub automatic_tax: Option<CreateSubscriptionAutomaticTax>,
/// For new subscriptions, a past timestamp to backdate the subscription's start date to.
///
/// If set, the first invoice will contain a proration for the timespan between the start date and the current time.
/// Can be combined with trials and the billing cycle anchor.
#[serde(skip_serializing_if = "Option::is_none")]
pub backdate_start_date: Option<Timestamp>,
/// A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle).
///
/// The anchor is the reference point that aligns future billing cycle dates.
/// It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_cycle_anchor: Option<Timestamp>,
/// Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals.
///
/// When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_cycle_anchor_config: Option<CreateSubscriptionBillingCycleAnchorConfig>,
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
///
/// Pass an empty string to remove previously-defined thresholds.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_thresholds: Option<SubscriptionBillingThresholds>,
/// A timestamp at which the subscription should cancel.
///
/// If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`.
/// If set during a future period, this will always cause a proration for that period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at: Option<Timestamp>,
/// Boolean indicating whether this subscription should cancel at the end of the current period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at_period_end: Option<bool>,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
/// Defaults to `charge_automatically`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collection_method: Option<CollectionMethod>,
/// The ID of the coupon to apply to this subscription.
///
/// A coupon applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub coupon: Option<CouponId>,
/// 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).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency: Option<Currency>,
/// The identifier of the customer to subscribe.
pub customer: CustomerId,
/// Number of days a customer has to pay invoices generated by this subscription.
///
/// Valid only for subscriptions where `collection_method` is set to `send_invoice`.
#[serde(skip_serializing_if = "Option::is_none")]
pub days_until_due: Option<u32>,
/// ID of the default payment method for the subscription.
///
/// It must belong to the customer associated with the subscription.
/// This takes precedence over `default_source`.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_payment_method: Option<&'a str>,
/// ID of the default payment source for the subscription.
///
/// It must belong to the customer associated with the subscription and be in a chargeable state.
/// If `default_payment_method` is also set, `default_payment_method` will take precedence.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_source: Option<&'a str>,
/// The tax rates that will apply to any subscription item that does not have `tax_rates` set.
///
/// Invoices created will have their `default_tax_rates` populated from the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<String>>,
/// The subscription's description, meant to be displayable to the customer.
///
/// Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<&'a str>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// All invoices will be billed using the specified settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub invoice_settings: Option<CreateSubscriptionInvoiceSettings>,
/// A list of up to 20 subscription items, each with an attached price.
#[serde(skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<CreateSubscriptionItems>>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Individual keys can be unset by posting an empty value to them.
/// All keys can be unset by posting an empty value to `metadata`.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Indicates if a customer is on or off-session while an invoice payment is attempted.
#[serde(skip_serializing_if = "Option::is_none")]
pub off_session: Option<bool>,
/// The account on behalf of which to charge, for each of the subscription's invoices.
#[serde(skip_serializing_if = "Option::is_none")]
pub on_behalf_of: Option<String>,
/// Only applies to subscriptions with `collection_method=charge_automatically`.
///
/// Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid.
///
/// Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice.
/// For example, SCA regulation may require 3DS authentication to complete payment.
/// See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more.
/// This is the default behavior. Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active.
/// Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice.
/// This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice.
/// Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
/// If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid.
/// For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead.
/// This was the default behavior for API versions prior to 2019-03-14.
/// See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_behavior: Option<SubscriptionPaymentBehavior>,
/// Payment settings to pass to invoices created by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_settings: Option<CreateSubscriptionPaymentSettings>,
/// Specifies an interval for how often to bill for any pending invoice items.
///
/// It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
#[serde(skip_serializing_if = "Option::is_none")]
pub pending_invoice_item_interval: Option<CreateSubscriptionPendingInvoiceItemInterval>,
/// The API ID of a promotion code to apply to this subscription.
///
/// A promotion code applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub promotion_code: Option<PromotionCodeId>,
/// Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`.
///
/// If no value is passed, the default is `create_prorations`.
#[serde(skip_serializing_if = "Option::is_none")]
pub proration_behavior: Option<SubscriptionProrationBehavior>,
/// If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
#[serde(skip_serializing_if = "Option::is_none")]
pub transfer_data: Option<CreateSubscriptionTransferData>,
/// Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
///
/// If set, trial_end will override the default trial period of the plan the customer is being subscribed to.
/// The special value `now` can be provided to end the customer's trial immediately.
/// Can be at most two years from `billing_cycle_anchor`.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_end: Option<Scheduled>,
/// Indicates if a plan's `trial_period_days` should be applied to the subscription.
///
/// Setting `trial_end` per subscription is preferred, and this defaults to `false`.
/// Setting this flag to `true` together with `trial_end` is not allowed.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_from_plan: Option<bool>,
/// Integer representing the number of trial period days before the customer is charged for the first time.
///
/// This will always overwrite any trials that might apply via a subscribed plan.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_period_days: Option<u32>,
/// Settings related to subscription trials.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_settings: Option<CreateSubscriptionTrialSettings>,
}
impl<'a> CreateSubscription<'a> {
pub fn new(customer: CustomerId) -> Self {
CreateSubscription {
add_invoice_items: Default::default(),
application_fee_percent: Default::default(),
automatic_tax: Default::default(),
backdate_start_date: Default::default(),
billing_cycle_anchor: Default::default(),
billing_cycle_anchor_config: Default::default(),
billing_thresholds: Default::default(),
cancel_at: Default::default(),
cancel_at_period_end: Default::default(),
collection_method: Default::default(),
coupon: Default::default(),
currency: Default::default(),
customer,
days_until_due: Default::default(),
default_payment_method: Default::default(),
default_source: Default::default(),
default_tax_rates: Default::default(),
description: Default::default(),
expand: Default::default(),
invoice_settings: Default::default(),
items: Default::default(),
metadata: Default::default(),
off_session: Default::default(),
on_behalf_of: Default::default(),
payment_behavior: Default::default(),
payment_settings: Default::default(),
pending_invoice_item_interval: Default::default(),
promotion_code: Default::default(),
proration_behavior: Default::default(),
transfer_data: Default::default(),
trial_end: Default::default(),
trial_from_plan: Default::default(),
trial_period_days: Default::default(),
trial_settings: Default::default(),
}
}
}
/// The parameters for `Subscription::list`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct ListSubscriptions<'a> {
/// Filter subscriptions by their automatic tax settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub automatic_tax: Option<ListSubscriptionsAutomaticTax>,
/// The collection method of the subscriptions to retrieve.
///
/// Either `charge_automatically` or `send_invoice`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collection_method: Option<CollectionMethod>,
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<RangeQuery<Timestamp>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_period_end: Option<RangeQuery<Timestamp>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_period_start: Option<RangeQuery<Timestamp>>,
/// The ID of the customer whose subscriptions will be retrieved.
#[serde(skip_serializing_if = "Option::is_none")]
pub customer: Option<CustomerId>,
/// A cursor for use in pagination.
///
/// `ending_before` is an object ID that defines your place in the list.
/// For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
#[serde(skip_serializing_if = "Option::is_none")]
pub ending_before: Option<SubscriptionId>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// A limit on the number of objects to be returned.
///
/// Limit can range between 1 and 100, and the default is 10.
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<u64>,
/// The ID of the plan whose subscriptions will be retrieved.
#[serde(skip_serializing_if = "Option::is_none")]
pub plan: Option<PlanId>,
/// Filter for subscriptions that contain this recurring price ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub price: Option<PriceId>,
/// A cursor for use in pagination.
///
/// `starting_after` is an object ID that defines your place in the list.
/// For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
#[serde(skip_serializing_if = "Option::is_none")]
pub starting_after: Option<SubscriptionId>,
/// The status of the subscriptions to retrieve.
///
/// Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers.
/// Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses).
/// Passing in a value of `all` will return subscriptions of all statuses.
/// If no value is supplied, all subscriptions that have not been canceled are returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub status: Option<SubscriptionStatusFilter>,
/// Filter for subscriptions that are associated with the specified test clock.
///
/// The response will not include subscriptions with test clocks if this and the customer parameter is not set.
#[serde(skip_serializing_if = "Option::is_none")]
pub test_clock: Option<&'a str>,
}
impl<'a> ListSubscriptions<'a> {
pub fn new() -> Self {
ListSubscriptions {
automatic_tax: Default::default(),
collection_method: Default::default(),
created: Default::default(),
current_period_end: Default::default(),
current_period_start: Default::default(),
customer: Default::default(),
ending_before: Default::default(),
expand: Default::default(),
limit: Default::default(),
plan: Default::default(),
price: Default::default(),
starting_after: Default::default(),
status: Default::default(),
test_clock: Default::default(),
}
}
}
impl Paginable for ListSubscriptions<'_> {
type O = Subscription;
fn set_last(&mut self, item: Self::O) {
self.starting_after = Some(item.id());
}
}
/// The parameters for `Subscription::update`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct UpdateSubscription<'a> {
/// A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription.
///
/// You may pass up to 20 items.
#[serde(skip_serializing_if = "Option::is_none")]
pub add_invoice_items: Option<Vec<AddInvoiceItems>>,
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
/// The request must be made by a platform account on a connected account in order to set an application fee percentage.
/// For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
#[serde(skip_serializing_if = "Option::is_none")]
pub application_fee_percent: Option<f64>,
/// Automatic tax settings for this subscription.
///
/// We recommend you only include this parameter when the existing value is being changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub automatic_tax: Option<UpdateSubscriptionAutomaticTax>,
/// Either `now` or `unchanged`.
///
/// Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC).
/// For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_cycle_anchor: Option<SubscriptionBillingCycleAnchor>,
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
///
/// Pass an empty string to remove previously-defined thresholds.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_thresholds: Option<SubscriptionBillingThresholds>,
/// A timestamp at which the subscription should cancel.
///
/// If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`.
/// If set during a future period, this will always cause a proration for that period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at: Option<Timestamp>,
/// Boolean indicating whether this subscription should cancel at the end of the current period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at_period_end: Option<bool>,
/// Details about why this subscription was cancelled.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancellation_details: Option<UpdateSubscriptionCancellationDetails>,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
/// Defaults to `charge_automatically`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collection_method: Option<CollectionMethod>,
/// The ID of the coupon to apply to this subscription.
///
/// A coupon applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub coupon: Option<CouponId>,
/// Number of days a customer has to pay invoices generated by this subscription.
///
/// Valid only for subscriptions where `collection_method` is set to `send_invoice`.
#[serde(skip_serializing_if = "Option::is_none")]
pub days_until_due: Option<u32>,
/// ID of the default payment method for the subscription.
///
/// It must belong to the customer associated with the subscription.
/// This takes precedence over `default_source`.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_payment_method: Option<&'a str>,
/// ID of the default payment source for the subscription.
///
/// It must belong to the customer associated with the subscription and be in a chargeable state.
/// If `default_payment_method` is also set, `default_payment_method` will take precedence.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_source: Option<String>,
/// The tax rates that will apply to any subscription item that does not have `tax_rates` set.
///
/// Invoices created will have their `default_tax_rates` populated from the subscription.
/// Pass an empty string to remove previously-defined tax rates.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<String>>,
/// The subscription's description, meant to be displayable to the customer.
///
/// Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// All invoices will be billed using the specified settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub invoice_settings: Option<UpdateSubscriptionInvoiceSettings>,
/// A list of up to 20 subscription items, each with an attached price.
#[serde(skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<UpdateSubscriptionItems>>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Individual keys can be unset by posting an empty value to them.
/// All keys can be unset by posting an empty value to `metadata`.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Indicates if a customer is on or off-session while an invoice payment is attempted.
#[serde(skip_serializing_if = "Option::is_none")]
pub off_session: Option<bool>,
/// The account on behalf of which to charge, for each of the subscription's invoices.
#[serde(skip_serializing_if = "Option::is_none")]
pub on_behalf_of: Option<String>,
/// If specified, payment collection for this subscription will be paused.
#[serde(skip_serializing_if = "Option::is_none")]
pub pause_collection: Option<UpdateSubscriptionPauseCollection>,
/// Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid.
///
/// This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice.
/// For example, SCA regulation may require 3DS authentication to complete payment.
/// See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more.
/// This is the default behavior. Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent.
/// This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice.
/// Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates).
/// When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid.
/// For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead.
/// This was the default behavior for API versions prior to 2019-03-14.
/// See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_behavior: Option<SubscriptionPaymentBehavior>,
/// Payment settings to pass to invoices created by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_settings: Option<UpdateSubscriptionPaymentSettings>,
/// Specifies an interval for how often to bill for any pending invoice items.
///
/// It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
#[serde(skip_serializing_if = "Option::is_none")]
pub pending_invoice_item_interval: Option<UpdateSubscriptionPendingInvoiceItemInterval>,
/// The promotion code to apply to this subscription.
///
/// A promotion code applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub promotion_code: Option<PromotionCodeId>,
/// Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes.
///
/// The default value is `create_prorations`.
#[serde(skip_serializing_if = "Option::is_none")]
pub proration_behavior: Option<SubscriptionProrationBehavior>,
/// If set, the proration will be calculated as though the subscription was updated at the given time.
///
/// This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint.
/// It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
#[serde(skip_serializing_if = "Option::is_none")]
pub proration_date: Option<Timestamp>,
/// If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
///
/// This will be unset if you POST an empty value.
#[serde(skip_serializing_if = "Option::is_none")]
pub transfer_data: Option<UpdateSubscriptionTransferData>,
/// Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
///
/// This will always overwrite any trials that might apply via a subscribed plan.
/// If set, trial_end will override the default trial period of the plan the customer is being subscribed to.
/// The special value `now` can be provided to end the customer's trial immediately.
/// Can be at most two years from `billing_cycle_anchor`.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_end: Option<Scheduled>,
/// Indicates if a plan's `trial_period_days` should be applied to the subscription.
///
/// Setting `trial_end` per subscription is preferred, and this defaults to `false`.
/// Setting this flag to `true` together with `trial_end` is not allowed.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_from_plan: Option<bool>,
/// Settings related to subscription trials.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_settings: Option<UpdateSubscriptionTrialSettings>,
}
impl<'a> UpdateSubscription<'a> {
pub fn new() -> Self {
UpdateSubscription {
add_invoice_items: Default::default(),
application_fee_percent: Default::default(),
automatic_tax: Default::default(),
billing_cycle_anchor: Default::default(),
billing_thresholds: Default::default(),
cancel_at: Default::default(),
cancel_at_period_end: Default::default(),
cancellation_details: Default::default(),
collection_method: Default::default(),
coupon: Default::default(),
days_until_due: Default::default(),
default_payment_method: Default::default(),
default_source: Default::default(),
default_tax_rates: Default::default(),
description: Default::default(),
expand: Default::default(),
invoice_settings: Default::default(),
items: Default::default(),
metadata: Default::default(),
off_session: Default::default(),
on_behalf_of: Default::default(),
pause_collection: Default::default(),
payment_behavior: Default::default(),
payment_settings: Default::default(),
pending_invoice_item_interval: Default::default(),
promotion_code: Default::default(),
proration_behavior: Default::default(),
proration_date: Default::default(),
transfer_data: Default::default(),
trial_end: Default::default(),
trial_from_plan: Default::default(),
trial_settings: Default::default(),
}
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct AddInvoiceItems {
/// The ID of the price object.
#[serde(skip_serializing_if = "Option::is_none")]
pub price: Option<String>,
/// Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
#[serde(skip_serializing_if = "Option::is_none")]
pub price_data: Option<InvoiceItemPriceData>,
/// Quantity for this item.
///
/// Defaults to 1.
#[serde(skip_serializing_if = "Option::is_none")]
pub quantity: Option<u64>,
/// The tax rates which apply to the item.
///
/// When set, the `default_tax_rates` do not apply to this item.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_rates: Option<Vec<String>>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionAutomaticTax {
/// Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
pub enabled: bool,
/// The account that's liable for tax.
///
/// If set, the business address and tax registrations required to perform the tax calculation are loaded from this account.
/// The tax transaction is returned in the report of the connected account.
#[serde(skip_serializing_if = "Option::is_none")]
pub liability: Option<CreateSubscriptionAutomaticTaxLiability>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionBillingCycleAnchorConfig {
/// The day of the month the billing_cycle_anchor should be.
///
/// Ranges from 1 to 31.
pub day_of_month: i64,
/// The hour of the day the billing_cycle_anchor should be.
///
/// Ranges from 0 to 23.
#[serde(skip_serializing_if = "Option::is_none")]
pub hour: Option<i64>,
/// The minute of the hour the billing_cycle_anchor should be.
///
/// Ranges from 0 to 59.
#[serde(skip_serializing_if = "Option::is_none")]
pub minute: Option<i64>,
/// The month to start full cycle billing periods.
///
/// Ranges from 1 to 12.
#[serde(skip_serializing_if = "Option::is_none")]
pub month: Option<i64>,
/// The second of the minute the billing_cycle_anchor should be.
///
/// Ranges from 0 to 59.
#[serde(skip_serializing_if = "Option::is_none")]
pub second: Option<i64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionInvoiceSettings {
/// The account tax IDs associated with the subscription.
///
/// Will be set on invoices generated by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub account_tax_ids: Option<Vec<String>>,
/// The connected account that issues the invoice.
///
/// The invoice is presented with the branding and support information of the specified account.
#[serde(skip_serializing_if = "Option::is_none")]
pub issuer: Option<CreateSubscriptionInvoiceSettingsIssuer>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionItems {
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
///
/// When updating, pass an empty string to remove previously-defined thresholds.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_thresholds: Option<CreateSubscriptionItemsBillingThresholds>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Individual keys can be unset by posting an empty value to them.
/// All keys can be unset by posting an empty value to `metadata`.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Plan ID for this item, as a string.
#[serde(skip_serializing_if = "Option::is_none")]
pub plan: Option<String>,
/// The ID of the price object.
#[serde(skip_serializing_if = "Option::is_none")]
pub price: Option<String>,
/// Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
#[serde(skip_serializing_if = "Option::is_none")]
pub price_data: Option<SubscriptionItemPriceData>,
/// Quantity for this item.
#[serde(skip_serializing_if = "Option::is_none")]
pub quantity: Option<u64>,
/// A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids.
///
/// These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription.
/// When updating, pass an empty string to remove previously-defined tax rates.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_rates: Option<Vec<String>>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettings {
/// Payment-method-specific configuration to provide to invoices created by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_method_options: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptions>,
/// The list of payment method types (e.g.
///
/// card) to provide to the invoice’s PaymentIntent.
/// If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_method_types: Option<Vec<CreateSubscriptionPaymentSettingsPaymentMethodTypes>>,
/// Either `off`, or `on_subscription`.
///
/// With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
#[serde(skip_serializing_if = "Option::is_none")]
pub save_default_payment_method:
Option<CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPendingInvoiceItemInterval {
/// Specifies invoicing frequency.
///
/// Either `day`, `week`, `month` or `year`.
pub interval: PlanInterval,
/// The number of intervals between invoices.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
/// Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
#[serde(skip_serializing_if = "Option::is_none")]
pub interval_count: Option<u64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionTransferData {
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the destination account.
/// By default, the entire amount is transferred to the destination.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount_percent: Option<f64>,
/// ID of an existing, connected Stripe account.
pub destination: String,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionTrialSettings {
/// Defines how the subscription should behave when the user's free trial ends.
pub end_behavior: CreateSubscriptionTrialSettingsEndBehavior,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct ListSubscriptionsAutomaticTax {
/// Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
pub enabled: bool,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionAutomaticTax {
/// Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
pub enabled: bool,
/// The account that's liable for tax.
///
/// If set, the business address and tax registrations required to perform the tax calculation are loaded from this account.
/// The tax transaction is returned in the report of the connected account.
#[serde(skip_serializing_if = "Option::is_none")]
pub liability: Option<UpdateSubscriptionAutomaticTaxLiability>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionCancellationDetails {
/// Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub comment: Option<String>,
/// The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub feedback: Option<UpdateSubscriptionCancellationDetailsFeedback>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionInvoiceSettings {
/// The account tax IDs associated with the subscription.
///
/// Will be set on invoices generated by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub account_tax_ids: Option<Vec<String>>,
/// The connected account that issues the invoice.
///
/// The invoice is presented with the branding and support information of the specified account.
#[serde(skip_serializing_if = "Option::is_none")]
pub issuer: Option<UpdateSubscriptionInvoiceSettingsIssuer>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionItems {
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
///
/// When updating, pass an empty string to remove previously-defined thresholds.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_thresholds: Option<SubscriptionItemBillingThresholds>,
/// Delete all usage for a given subscription item.
///
/// Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
#[serde(skip_serializing_if = "Option::is_none")]
pub clear_usage: Option<bool>,
/// A flag that, if set to `true`, will delete the specified item.
#[serde(skip_serializing_if = "Option::is_none")]
pub deleted: Option<bool>,
/// Subscription item to update.
#[serde(skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
/// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
/// Individual keys can be unset by posting an empty value to them.
/// All keys can be unset by posting an empty value to `metadata`.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// Plan ID for this item, as a string.
#[serde(skip_serializing_if = "Option::is_none")]
pub plan: Option<String>,
/// The ID of the price object.
///
/// When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
#[serde(skip_serializing_if = "Option::is_none")]
pub price: Option<String>,
/// Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
#[serde(skip_serializing_if = "Option::is_none")]
pub price_data: Option<SubscriptionItemPriceData>,
/// Quantity for this item.
#[serde(skip_serializing_if = "Option::is_none")]
pub quantity: Option<u64>,
/// A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids.
///
/// These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription.
/// When updating, pass an empty string to remove previously-defined tax rates.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_rates: Option<Vec<String>>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPauseCollection {
/// The payment collection behavior for this subscription while paused.
///
/// One of `keep_as_draft`, `mark_uncollectible`, or `void`.
pub behavior: UpdateSubscriptionPauseCollectionBehavior,
/// The time after which the subscription will resume collecting payments.
#[serde(skip_serializing_if = "Option::is_none")]
pub resumes_at: Option<Timestamp>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettings {
/// Payment-method-specific configuration to provide to invoices created by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_method_options: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptions>,
/// The list of payment method types (e.g.
///
/// card) to provide to the invoice’s PaymentIntent.
/// If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_method_types: Option<Vec<UpdateSubscriptionPaymentSettingsPaymentMethodTypes>>,
/// Either `off`, or `on_subscription`.
///
/// With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
#[serde(skip_serializing_if = "Option::is_none")]
pub save_default_payment_method:
Option<UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPendingInvoiceItemInterval {
/// Specifies invoicing frequency.
///
/// Either `day`, `week`, `month` or `year`.
pub interval: PlanInterval,
/// The number of intervals between invoices.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
/// Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
#[serde(skip_serializing_if = "Option::is_none")]
pub interval_count: Option<u64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionTransferData {
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the destination account.
/// By default, the entire amount is transferred to the destination.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount_percent: Option<f64>,
/// ID of an existing, connected Stripe account.
pub destination: String,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionTrialSettings {
/// Defines how the subscription should behave when the user's free trial ends.
pub end_behavior: UpdateSubscriptionTrialSettingsEndBehavior,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionAutomaticTaxLiability {
/// The connected account being referenced when `type` is `account`.
#[serde(skip_serializing_if = "Option::is_none")]
pub account: Option<String>,
/// Type of the account referenced in the request.
#[serde(rename = "type")]
pub type_: CreateSubscriptionAutomaticTaxLiabilityType,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionInvoiceSettingsIssuer {
/// The connected account being referenced when `type` is `account`.
#[serde(skip_serializing_if = "Option::is_none")]
pub account: Option<String>,
/// Type of the account referenced in the request.
#[serde(rename = "type")]
pub type_: CreateSubscriptionInvoiceSettingsIssuerType,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionItemsBillingThresholds {
/// Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)).
pub usage_gte: i64,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptions {
/// This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub acss_debit: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit>,
/// This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub bancontact: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontact>,
/// This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub card: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCard>,
/// This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub customer_balance:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance>,
/// This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub konbini: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsKonbini>,
/// This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub us_bank_account: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionTrialSettingsEndBehavior {
/// Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
pub missing_payment_method: CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoiceItemPriceData {
/// 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).
pub currency: Currency,
/// The ID of the product that this price will belong to.
pub product: String,
/// Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings.
///
/// Specifies whether the price is considered inclusive of taxes or exclusive of taxes.
/// One of `inclusive`, `exclusive`, or `unspecified`.
/// Once specified as either `inclusive` or `exclusive`, it cannot be changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_behavior: Option<InvoiceItemPriceDataTaxBehavior>,
/// A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount: Option<i64>,
/// Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
///
/// Only one of `unit_amount` and `unit_amount_decimal` can be set.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount_decimal: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionItemPriceData {
/// 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).
pub currency: Currency,
/// The ID of the product that this price will belong to.
pub product: String,
/// The recurring components of a price such as `interval` and `interval_count`.
pub recurring: SubscriptionItemPriceDataRecurring,
/// Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings.
///
/// Specifies whether the price is considered inclusive of taxes or exclusive of taxes.
/// One of `inclusive`, `exclusive`, or `unspecified`.
/// Once specified as either `inclusive` or `exclusive`, it cannot be changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_behavior: Option<SubscriptionItemPriceDataTaxBehavior>,
/// A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount: Option<i64>,
/// Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
///
/// Only one of `unit_amount` and `unit_amount_decimal` can be set.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount_decimal: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionAutomaticTaxLiability {
/// The connected account being referenced when `type` is `account`.
#[serde(skip_serializing_if = "Option::is_none")]
pub account: Option<String>,
/// Type of the account referenced in the request.
#[serde(rename = "type")]
pub type_: UpdateSubscriptionAutomaticTaxLiabilityType,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionInvoiceSettingsIssuer {
/// The connected account being referenced when `type` is `account`.
#[serde(skip_serializing_if = "Option::is_none")]
pub account: Option<String>,
/// Type of the account referenced in the request.
#[serde(rename = "type")]
pub type_: UpdateSubscriptionInvoiceSettingsIssuerType,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptions {
/// This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub acss_debit: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit>,
/// This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub bancontact: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontact>,
/// This sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub card: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCard>,
/// This sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub customer_balance:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance>,
/// This sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub konbini: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsKonbini>,
/// This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.
#[serde(skip_serializing_if = "Option::is_none")]
pub us_bank_account: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionTrialSettingsEndBehavior {
/// Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
pub missing_payment_method: UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit {
/// Additional fields for Mandate creation.
#[serde(skip_serializing_if = "Option::is_none")]
pub mandate_options:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions>,
/// Verification method for the intent.
#[serde(skip_serializing_if = "Option::is_none")]
pub verification_method:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontact {
/// Preferred language of the Bancontact authorization page that the customer is redirected to.
#[serde(skip_serializing_if = "Option::is_none")]
pub preferred_language:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsCard {
/// Configuration options for setting up an eMandate for cards issued in India.
#[serde(skip_serializing_if = "Option::is_none")]
pub mandate_options:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions>,
/// Selected network to process this Subscription on.
///
/// Depends on the available networks of the card attached to the Subscription.
/// Can be only set confirm-time.
#[serde(skip_serializing_if = "Option::is_none")]
pub network: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork>,
/// We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication).
///
/// However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
/// Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
#[serde(skip_serializing_if = "Option::is_none")]
pub request_three_d_secure:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance {
/// Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
#[serde(skip_serializing_if = "Option::is_none")]
pub bank_transfer:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer>,
/// The funding method type to be used when there are not enough funds in the customer balance.
///
/// Permitted values include: `bank_transfer`.
#[serde(skip_serializing_if = "Option::is_none")]
pub funding_type: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsKonbini {}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount {
/// Additional fields for Financial Connections Session creation.
#[serde(skip_serializing_if = "Option::is_none")]
pub financial_connections: Option<
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections,
>,
/// Verification method for the intent.
#[serde(skip_serializing_if = "Option::is_none")]
pub verification_method: Option<
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod,
>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionItemPriceDataRecurring {
/// Specifies billing frequency.
///
/// Either `day`, `week`, `month` or `year`.
pub interval: PlanInterval,
/// The number of intervals between subscription billings.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
/// Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
#[serde(skip_serializing_if = "Option::is_none")]
pub interval_count: Option<u64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit {
/// Additional fields for Mandate creation.
#[serde(skip_serializing_if = "Option::is_none")]
pub mandate_options:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions>,
/// Verification method for the intent.
#[serde(skip_serializing_if = "Option::is_none")]
pub verification_method:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontact {
/// Preferred language of the Bancontact authorization page that the customer is redirected to.
#[serde(skip_serializing_if = "Option::is_none")]
pub preferred_language:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCard {
/// Configuration options for setting up an eMandate for cards issued in India.
#[serde(skip_serializing_if = "Option::is_none")]
pub mandate_options:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions>,
/// Selected network to process this Subscription on.
///
/// Depends on the available networks of the card attached to the Subscription.
/// Can be only set confirm-time.
#[serde(skip_serializing_if = "Option::is_none")]
pub network: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork>,
/// We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication).
///
/// However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
/// Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
#[serde(skip_serializing_if = "Option::is_none")]
pub request_three_d_secure:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalance {
/// Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
#[serde(skip_serializing_if = "Option::is_none")]
pub bank_transfer:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer>,
/// The funding method type to be used when there are not enough funds in the customer balance.
///
/// Permitted values include: `bank_transfer`.
#[serde(skip_serializing_if = "Option::is_none")]
pub funding_type: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsKonbini {}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount {
/// Additional fields for Financial Connections Session creation.
#[serde(skip_serializing_if = "Option::is_none")]
pub financial_connections: Option<
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections,
>,
/// Verification method for the intent.
#[serde(skip_serializing_if = "Option::is_none")]
pub verification_method: Option<
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod,
>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions {
/// Transaction type of the mandate.
#[serde(skip_serializing_if = "Option::is_none")]
pub transaction_type: Option<
CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType,
>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions {
/// Amount to be charged for future payments.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount: Option<i64>,
/// One of `fixed` or `maximum`.
///
/// If `fixed`, the `amount` param refers to the exact amount to be charged in future payments.
/// If `maximum`, the amount charged can be up to the value passed for the `amount` param.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount_type:
Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType>,
/// A description of the mandate or subscription that is meant to be displayed to the customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer {
/// Configuration for eu_bank_transfer funding type.
#[serde(skip_serializing_if = "Option::is_none")]
pub eu_bank_transfer: Option<CreateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer>,
/// The bank transfer type that can be used for funding.
///
/// Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
#[serde(rename = "type")]
#[serde(skip_serializing_if = "Option::is_none")]
pub type_: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections {
/// The list of permissions to request.
///
/// If this parameter is passed, the `payment_method` permission must be included.
/// Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
#[serde(skip_serializing_if = "Option::is_none")]
pub permissions: Option<Vec<CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions>>,
/// List of data features that you would like to retrieve upon account creation.
#[serde(skip_serializing_if = "Option::is_none")]
pub prefetch: Option<Vec<CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch>>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions {
/// Transaction type of the mandate.
#[serde(skip_serializing_if = "Option::is_none")]
pub transaction_type: Option<
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType,
>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions {
/// Amount to be charged for future payments.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount: Option<i64>,
/// One of `fixed` or `maximum`.
///
/// If `fixed`, the `amount` param refers to the exact amount to be charged in future payments.
/// If `maximum`, the amount charged can be up to the value passed for the `amount` param.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount_type:
Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType>,
/// A description of the mandate or subscription that is meant to be displayed to the customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransfer {
/// Configuration for eu_bank_transfer funding type.
#[serde(skip_serializing_if = "Option::is_none")]
pub eu_bank_transfer: Option<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer>,
/// The bank transfer type that can be used for funding.
///
/// Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
#[serde(rename = "type")]
#[serde(skip_serializing_if = "Option::is_none")]
pub type_: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections {
/// The list of permissions to request.
///
/// If this parameter is passed, the `payment_method` permission must be included.
/// Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
#[serde(skip_serializing_if = "Option::is_none")]
pub permissions: Option<Vec<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions>>,
/// List of data features that you would like to retrieve upon account creation.
#[serde(skip_serializing_if = "Option::is_none")]
pub prefetch: Option<Vec<UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch>>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
{
/// The desired country code of the bank account information.
///
/// Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
pub country: String,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCustomerBalanceBankTransferEuBankTransfer
{
/// The desired country code of the bank account information.
///
/// Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
pub country: String,
}
/// An enum representing the possible values of an `CancellationDetails`'s `feedback` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CancellationDetailsFeedback {
CustomerService,
LowQuality,
MissingFeatures,
Other,
SwitchedService,
TooComplex,
TooExpensive,
Unused,
}
impl CancellationDetailsFeedback {
pub fn as_str(self) -> &'static str {
match self {
CancellationDetailsFeedback::CustomerService => "customer_service",
CancellationDetailsFeedback::LowQuality => "low_quality",
CancellationDetailsFeedback::MissingFeatures => "missing_features",
CancellationDetailsFeedback::Other => "other",
CancellationDetailsFeedback::SwitchedService => "switched_service",
CancellationDetailsFeedback::TooComplex => "too_complex",
CancellationDetailsFeedback::TooExpensive => "too_expensive",
CancellationDetailsFeedback::Unused => "unused",
}
}
}
impl AsRef<str> for CancellationDetailsFeedback {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CancellationDetailsFeedback {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CancellationDetailsFeedback {
fn default() -> Self {
Self::CustomerService
}
}
/// An enum representing the possible values of an `CancellationDetails`'s `reason` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CancellationDetailsReason {
CancellationRequested,
PaymentDisputed,
PaymentFailed,
}
impl CancellationDetailsReason {
pub fn as_str(self) -> &'static str {
match self {
CancellationDetailsReason::CancellationRequested => "cancellation_requested",
CancellationDetailsReason::PaymentDisputed => "payment_disputed",
CancellationDetailsReason::PaymentFailed => "payment_failed",
}
}
}
impl AsRef<str> for CancellationDetailsReason {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CancellationDetailsReason {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CancellationDetailsReason {
fn default() -> Self {
Self::CancellationRequested
}
}
/// An enum representing the possible values of an `CreateSubscriptionAutomaticTaxLiability`'s `type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionAutomaticTaxLiabilityType {
Account,
#[serde(rename = "self")]
Self_,
}
impl CreateSubscriptionAutomaticTaxLiabilityType {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionAutomaticTaxLiabilityType::Account => "account",
CreateSubscriptionAutomaticTaxLiabilityType::Self_ => "self",
}
}
}
impl AsRef<str> for CreateSubscriptionAutomaticTaxLiabilityType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionAutomaticTaxLiabilityType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionAutomaticTaxLiabilityType {
fn default() -> Self {
Self::Account
}
}
/// An enum representing the possible values of an `CreateSubscriptionInvoiceSettingsIssuer`'s `type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionInvoiceSettingsIssuerType {
Account,
#[serde(rename = "self")]
Self_,
}
impl CreateSubscriptionInvoiceSettingsIssuerType {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionInvoiceSettingsIssuerType::Account => "account",
CreateSubscriptionInvoiceSettingsIssuerType::Self_ => "self",
}
}
}
impl AsRef<str> for CreateSubscriptionInvoiceSettingsIssuerType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionInvoiceSettingsIssuerType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionInvoiceSettingsIssuerType {
fn default() -> Self {
Self::Account
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions`'s `transaction_type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
Business,
Personal,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType::Business => "business",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType::Personal => "personal",
}
}
}
impl AsRef<str>
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
fn default() -> Self {
Self::Business
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit`'s `verification_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod {
Automatic,
Instant,
Microdeposits,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod::Automatic => "automatic",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod::Instant => "instant",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod::Microdeposits => "microdeposits",
}
}
}
impl AsRef<str>
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod
{
fn default() -> Self {
Self::Automatic
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontact`'s `preferred_language` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage {
De,
En,
Fr,
Nl,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::De => "de",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::En => "en",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::Fr => "fr",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::Nl => "nl",
}
}
}
impl AsRef<str>
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage
{
fn default() -> Self {
Self::De
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions`'s `amount_type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType {
Fixed,
Maximum,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType::Fixed => "fixed",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType::Maximum => "maximum",
}
}
}
impl AsRef<str>
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType
{
fn default() -> Self {
Self::Fixed
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsCard`'s `network` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
Amex,
CartesBancaires,
Diners,
Discover,
EftposAu,
Interac,
Jcb,
Mastercard,
Unionpay,
Unknown,
Visa,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Amex => "amex",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::CartesBancaires => {
"cartes_bancaires"
}
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Diners => "diners",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Discover => {
"discover"
}
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::EftposAu => {
"eftpos_au"
}
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Interac => "interac",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Jcb => "jcb",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Mastercard => {
"mastercard"
}
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Unionpay => {
"unionpay"
}
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Unknown => "unknown",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Visa => "visa",
}
}
}
impl AsRef<str> for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
fn default() -> Self {
Self::Amex
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsCard`'s `request_three_d_secure` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure {
Any,
Automatic,
Challenge,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure::Any => "any",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure::Automatic => "automatic",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure::Challenge => "challenge",
}
}
}
impl AsRef<str> for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure
{
fn default() -> Self {
Self::Any
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections`'s `permissions` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions
{
Balances,
Ownership,
PaymentMethod,
Transactions,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::Balances => "balances",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::Ownership => "ownership",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::PaymentMethod => "payment_method",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::Transactions => "transactions",
}
}
}
impl AsRef<str> for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
fn default() -> Self {
Self::Balances
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections`'s `prefetch` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch
{
Balances,
Transactions,
}
impl
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch
{
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch::Balances => "balances",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch::Transactions => "transactions",
}
}
}
impl AsRef<str> for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch {
fn default() -> Self {
Self::Balances
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount`'s `verification_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod {
Automatic,
Instant,
Microdeposits,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod::Automatic => "automatic",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod::Instant => "instant",
CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod::Microdeposits => "microdeposits",
}
}
}
impl AsRef<str>
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for CreateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod
{
fn default() -> Self {
Self::Automatic
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettings`'s `payment_method_types` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsPaymentMethodTypes {
AchCreditTransfer,
AchDebit,
AcssDebit,
AuBecsDebit,
BacsDebit,
Bancontact,
Boleto,
Card,
Cashapp,
CustomerBalance,
Eps,
Fpx,
Giropay,
Grabpay,
Ideal,
Konbini,
Link,
P24,
Paynow,
Paypal,
Promptpay,
SepaCreditTransfer,
SepaDebit,
Sofort,
UsBankAccount,
WechatPay,
}
impl CreateSubscriptionPaymentSettingsPaymentMethodTypes {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsPaymentMethodTypes::AchCreditTransfer => {
"ach_credit_transfer"
}
CreateSubscriptionPaymentSettingsPaymentMethodTypes::AchDebit => "ach_debit",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::AcssDebit => "acss_debit",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::AuBecsDebit => "au_becs_debit",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::BacsDebit => "bacs_debit",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Bancontact => "bancontact",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Boleto => "boleto",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Card => "card",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Cashapp => "cashapp",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::CustomerBalance => {
"customer_balance"
}
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Eps => "eps",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Fpx => "fpx",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Giropay => "giropay",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Grabpay => "grabpay",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Ideal => "ideal",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Konbini => "konbini",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Link => "link",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::P24 => "p24",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Paynow => "paynow",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Paypal => "paypal",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Promptpay => "promptpay",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::SepaCreditTransfer => {
"sepa_credit_transfer"
}
CreateSubscriptionPaymentSettingsPaymentMethodTypes::SepaDebit => "sepa_debit",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::Sofort => "sofort",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::UsBankAccount => "us_bank_account",
CreateSubscriptionPaymentSettingsPaymentMethodTypes::WechatPay => "wechat_pay",
}
}
}
impl AsRef<str> for CreateSubscriptionPaymentSettingsPaymentMethodTypes {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionPaymentSettingsPaymentMethodTypes {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionPaymentSettingsPaymentMethodTypes {
fn default() -> Self {
Self::AchCreditTransfer
}
}
/// An enum representing the possible values of an `CreateSubscriptionPaymentSettings`'s `save_default_payment_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
Off,
OnSubscription,
}
impl CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod::Off => "off",
CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod::OnSubscription => {
"on_subscription"
}
}
}
}
impl AsRef<str> for CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
fn default() -> Self {
Self::Off
}
}
/// An enum representing the possible values of an `CreateSubscriptionTrialSettingsEndBehavior`'s `missing_payment_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
Cancel,
CreateInvoice,
Pause,
}
impl CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
pub fn as_str(self) -> &'static str {
match self {
CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod::Cancel => "cancel",
CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod::CreateInvoice => {
"create_invoice"
}
CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod::Pause => "pause",
}
}
}
impl AsRef<str> for CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
fn default() -> Self {
Self::Cancel
}
}
/// An enum representing the possible values of an `InvoiceItemPriceData`'s `tax_behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum InvoiceItemPriceDataTaxBehavior {
Exclusive,
Inclusive,
Unspecified,
}
impl InvoiceItemPriceDataTaxBehavior {
pub fn as_str(self) -> &'static str {
match self {
InvoiceItemPriceDataTaxBehavior::Exclusive => "exclusive",
InvoiceItemPriceDataTaxBehavior::Inclusive => "inclusive",
InvoiceItemPriceDataTaxBehavior::Unspecified => "unspecified",
}
}
}
impl AsRef<str> for InvoiceItemPriceDataTaxBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for InvoiceItemPriceDataTaxBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for InvoiceItemPriceDataTaxBehavior {
fn default() -> Self {
Self::Exclusive
}
}
/// An enum representing the possible values of an `InvoiceMandateOptionsCard`'s `amount_type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum InvoiceMandateOptionsCardAmountType {
Fixed,
Maximum,
}
impl InvoiceMandateOptionsCardAmountType {
pub fn as_str(self) -> &'static str {
match self {
InvoiceMandateOptionsCardAmountType::Fixed => "fixed",
InvoiceMandateOptionsCardAmountType::Maximum => "maximum",
}
}
}
impl AsRef<str> for InvoiceMandateOptionsCardAmountType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for InvoiceMandateOptionsCardAmountType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for InvoiceMandateOptionsCardAmountType {
fn default() -> Self {
Self::Fixed
}
}
/// An enum representing the possible values of an `SubscriptionPendingInvoiceItemInterval`'s `interval` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum PlanInterval {
Day,
Month,
Week,
Year,
}
impl PlanInterval {
pub fn as_str(self) -> &'static str {
match self {
PlanInterval::Day => "day",
PlanInterval::Month => "month",
PlanInterval::Week => "week",
PlanInterval::Year => "year",
}
}
}
impl AsRef<str> for PlanInterval {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for PlanInterval {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for PlanInterval {
fn default() -> Self {
Self::Day
}
}
/// An enum representing the possible values of an `UpdateSubscription`'s `billing_cycle_anchor` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionBillingCycleAnchor {
Now,
Unchanged,
}
impl SubscriptionBillingCycleAnchor {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionBillingCycleAnchor::Now => "now",
SubscriptionBillingCycleAnchor::Unchanged => "unchanged",
}
}
}
impl AsRef<str> for SubscriptionBillingCycleAnchor {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionBillingCycleAnchor {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionBillingCycleAnchor {
fn default() -> Self {
Self::Now
}
}
/// An enum representing the possible values of an `SubscriptionItemPriceData`'s `tax_behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionItemPriceDataTaxBehavior {
Exclusive,
Inclusive,
Unspecified,
}
impl SubscriptionItemPriceDataTaxBehavior {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionItemPriceDataTaxBehavior::Exclusive => "exclusive",
SubscriptionItemPriceDataTaxBehavior::Inclusive => "inclusive",
SubscriptionItemPriceDataTaxBehavior::Unspecified => "unspecified",
}
}
}
impl AsRef<str> for SubscriptionItemPriceDataTaxBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionItemPriceDataTaxBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionItemPriceDataTaxBehavior {
fn default() -> Self {
Self::Exclusive
}
}
/// An enum representing the possible values of an `CreateSubscription`'s `payment_behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionPaymentBehavior {
AllowIncomplete,
DefaultIncomplete,
ErrorIfIncomplete,
PendingIfIncomplete,
}
impl SubscriptionPaymentBehavior {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionPaymentBehavior::AllowIncomplete => "allow_incomplete",
SubscriptionPaymentBehavior::DefaultIncomplete => "default_incomplete",
SubscriptionPaymentBehavior::ErrorIfIncomplete => "error_if_incomplete",
SubscriptionPaymentBehavior::PendingIfIncomplete => "pending_if_incomplete",
}
}
}
impl AsRef<str> for SubscriptionPaymentBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionPaymentBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionPaymentBehavior {
fn default() -> Self {
Self::AllowIncomplete
}
}
/// An enum representing the possible values of an `SubscriptionPaymentMethodOptionsCard`'s `network` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionPaymentMethodOptionsCardNetwork {
Amex,
CartesBancaires,
Diners,
Discover,
EftposAu,
Interac,
Jcb,
Mastercard,
Unionpay,
Unknown,
Visa,
}
impl SubscriptionPaymentMethodOptionsCardNetwork {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionPaymentMethodOptionsCardNetwork::Amex => "amex",
SubscriptionPaymentMethodOptionsCardNetwork::CartesBancaires => "cartes_bancaires",
SubscriptionPaymentMethodOptionsCardNetwork::Diners => "diners",
SubscriptionPaymentMethodOptionsCardNetwork::Discover => "discover",
SubscriptionPaymentMethodOptionsCardNetwork::EftposAu => "eftpos_au",
SubscriptionPaymentMethodOptionsCardNetwork::Interac => "interac",
SubscriptionPaymentMethodOptionsCardNetwork::Jcb => "jcb",
SubscriptionPaymentMethodOptionsCardNetwork::Mastercard => "mastercard",
SubscriptionPaymentMethodOptionsCardNetwork::Unionpay => "unionpay",
SubscriptionPaymentMethodOptionsCardNetwork::Unknown => "unknown",
SubscriptionPaymentMethodOptionsCardNetwork::Visa => "visa",
}
}
}
impl AsRef<str> for SubscriptionPaymentMethodOptionsCardNetwork {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionPaymentMethodOptionsCardNetwork {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionPaymentMethodOptionsCardNetwork {
fn default() -> Self {
Self::Amex
}
}
/// An enum representing the possible values of an `SubscriptionPaymentMethodOptionsCard`'s `request_three_d_secure` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionPaymentMethodOptionsCardRequestThreeDSecure {
Any,
Automatic,
Challenge,
}
impl SubscriptionPaymentMethodOptionsCardRequestThreeDSecure {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionPaymentMethodOptionsCardRequestThreeDSecure::Any => "any",
SubscriptionPaymentMethodOptionsCardRequestThreeDSecure::Automatic => "automatic",
SubscriptionPaymentMethodOptionsCardRequestThreeDSecure::Challenge => "challenge",
}
}
}
impl AsRef<str> for SubscriptionPaymentMethodOptionsCardRequestThreeDSecure {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionPaymentMethodOptionsCardRequestThreeDSecure {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionPaymentMethodOptionsCardRequestThreeDSecure {
fn default() -> Self {
Self::Any
}
}
/// An enum representing the possible values of an `CreateSubscription`'s `proration_behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionProrationBehavior {
AlwaysInvoice,
CreateProrations,
None,
}
impl SubscriptionProrationBehavior {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionProrationBehavior::AlwaysInvoice => "always_invoice",
SubscriptionProrationBehavior::CreateProrations => "create_prorations",
SubscriptionProrationBehavior::None => "none",
}
}
}
impl AsRef<str> for SubscriptionProrationBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionProrationBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionProrationBehavior {
fn default() -> Self {
Self::AlwaysInvoice
}
}
/// An enum representing the possible values of an `Subscription`'s `status` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionStatus {
Active,
Canceled,
Incomplete,
IncompleteExpired,
PastDue,
Paused,
Trialing,
Unpaid,
}
impl SubscriptionStatus {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionStatus::Active => "active",
SubscriptionStatus::Canceled => "canceled",
SubscriptionStatus::Incomplete => "incomplete",
SubscriptionStatus::IncompleteExpired => "incomplete_expired",
SubscriptionStatus::PastDue => "past_due",
SubscriptionStatus::Paused => "paused",
SubscriptionStatus::Trialing => "trialing",
SubscriptionStatus::Unpaid => "unpaid",
}
}
}
impl AsRef<str> for SubscriptionStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionStatus {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionStatus {
fn default() -> Self {
Self::Active
}
}
/// An enum representing the possible values of an `ListSubscriptions`'s `status` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionStatusFilter {
Active,
All,
Canceled,
Ended,
Incomplete,
IncompleteExpired,
PastDue,
Paused,
Trialing,
Unpaid,
}
impl SubscriptionStatusFilter {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionStatusFilter::Active => "active",
SubscriptionStatusFilter::All => "all",
SubscriptionStatusFilter::Canceled => "canceled",
SubscriptionStatusFilter::Ended => "ended",
SubscriptionStatusFilter::Incomplete => "incomplete",
SubscriptionStatusFilter::IncompleteExpired => "incomplete_expired",
SubscriptionStatusFilter::PastDue => "past_due",
SubscriptionStatusFilter::Paused => "paused",
SubscriptionStatusFilter::Trialing => "trialing",
SubscriptionStatusFilter::Unpaid => "unpaid",
}
}
}
impl AsRef<str> for SubscriptionStatusFilter {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionStatusFilter {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionStatusFilter {
fn default() -> Self {
Self::Active
}
}
/// An enum representing the possible values of an `SubscriptionsResourcePauseCollection`'s `behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionsResourcePauseCollectionBehavior {
KeepAsDraft,
MarkUncollectible,
Void,
}
impl SubscriptionsResourcePauseCollectionBehavior {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionsResourcePauseCollectionBehavior::KeepAsDraft => "keep_as_draft",
SubscriptionsResourcePauseCollectionBehavior::MarkUncollectible => "mark_uncollectible",
SubscriptionsResourcePauseCollectionBehavior::Void => "void",
}
}
}
impl AsRef<str> for SubscriptionsResourcePauseCollectionBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionsResourcePauseCollectionBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionsResourcePauseCollectionBehavior {
fn default() -> Self {
Self::KeepAsDraft
}
}
/// An enum representing the possible values of an `SubscriptionsResourcePaymentSettings`'s `payment_method_types` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionsResourcePaymentSettingsPaymentMethodTypes {
AchCreditTransfer,
AchDebit,
AcssDebit,
AuBecsDebit,
BacsDebit,
Bancontact,
Boleto,
Card,
Cashapp,
CustomerBalance,
Eps,
Fpx,
Giropay,
Grabpay,
Ideal,
Konbini,
Link,
P24,
Paynow,
Paypal,
Promptpay,
SepaCreditTransfer,
SepaDebit,
Sofort,
UsBankAccount,
WechatPay,
}
impl SubscriptionsResourcePaymentSettingsPaymentMethodTypes {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::AchCreditTransfer => {
"ach_credit_transfer"
}
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::AchDebit => "ach_debit",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::AcssDebit => "acss_debit",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::AuBecsDebit => "au_becs_debit",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::BacsDebit => "bacs_debit",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Bancontact => "bancontact",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Boleto => "boleto",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Card => "card",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Cashapp => "cashapp",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::CustomerBalance => {
"customer_balance"
}
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Eps => "eps",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Fpx => "fpx",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Giropay => "giropay",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Grabpay => "grabpay",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Ideal => "ideal",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Konbini => "konbini",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Link => "link",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::P24 => "p24",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Paynow => "paynow",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Paypal => "paypal",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Promptpay => "promptpay",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::SepaCreditTransfer => {
"sepa_credit_transfer"
}
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::SepaDebit => "sepa_debit",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::Sofort => "sofort",
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::UsBankAccount => {
"us_bank_account"
}
SubscriptionsResourcePaymentSettingsPaymentMethodTypes::WechatPay => "wechat_pay",
}
}
}
impl AsRef<str> for SubscriptionsResourcePaymentSettingsPaymentMethodTypes {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionsResourcePaymentSettingsPaymentMethodTypes {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionsResourcePaymentSettingsPaymentMethodTypes {
fn default() -> Self {
Self::AchCreditTransfer
}
}
/// An enum representing the possible values of an `SubscriptionsResourcePaymentSettings`'s `save_default_payment_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod {
Off,
OnSubscription,
}
impl SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod {
pub fn as_str(self) -> &'static str {
match self {
SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod::Off => "off",
SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod::OnSubscription => {
"on_subscription"
}
}
}
}
impl AsRef<str> for SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod {
fn default() -> Self {
Self::Off
}
}
/// An enum representing the possible values of an `UpdateSubscriptionAutomaticTaxLiability`'s `type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionAutomaticTaxLiabilityType {
Account,
#[serde(rename = "self")]
Self_,
}
impl UpdateSubscriptionAutomaticTaxLiabilityType {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionAutomaticTaxLiabilityType::Account => "account",
UpdateSubscriptionAutomaticTaxLiabilityType::Self_ => "self",
}
}
}
impl AsRef<str> for UpdateSubscriptionAutomaticTaxLiabilityType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionAutomaticTaxLiabilityType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionAutomaticTaxLiabilityType {
fn default() -> Self {
Self::Account
}
}
/// An enum representing the possible values of an `UpdateSubscriptionCancellationDetails`'s `feedback` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionCancellationDetailsFeedback {
CustomerService,
LowQuality,
MissingFeatures,
Other,
SwitchedService,
TooComplex,
TooExpensive,
Unused,
}
impl UpdateSubscriptionCancellationDetailsFeedback {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionCancellationDetailsFeedback::CustomerService => "customer_service",
UpdateSubscriptionCancellationDetailsFeedback::LowQuality => "low_quality",
UpdateSubscriptionCancellationDetailsFeedback::MissingFeatures => "missing_features",
UpdateSubscriptionCancellationDetailsFeedback::Other => "other",
UpdateSubscriptionCancellationDetailsFeedback::SwitchedService => "switched_service",
UpdateSubscriptionCancellationDetailsFeedback::TooComplex => "too_complex",
UpdateSubscriptionCancellationDetailsFeedback::TooExpensive => "too_expensive",
UpdateSubscriptionCancellationDetailsFeedback::Unused => "unused",
}
}
}
impl AsRef<str> for UpdateSubscriptionCancellationDetailsFeedback {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionCancellationDetailsFeedback {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionCancellationDetailsFeedback {
fn default() -> Self {
Self::CustomerService
}
}
/// An enum representing the possible values of an `UpdateSubscriptionInvoiceSettingsIssuer`'s `type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionInvoiceSettingsIssuerType {
Account,
#[serde(rename = "self")]
Self_,
}
impl UpdateSubscriptionInvoiceSettingsIssuerType {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionInvoiceSettingsIssuerType::Account => "account",
UpdateSubscriptionInvoiceSettingsIssuerType::Self_ => "self",
}
}
}
impl AsRef<str> for UpdateSubscriptionInvoiceSettingsIssuerType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionInvoiceSettingsIssuerType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionInvoiceSettingsIssuerType {
fn default() -> Self {
Self::Account
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPauseCollection`'s `behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPauseCollectionBehavior {
KeepAsDraft,
MarkUncollectible,
Void,
}
impl UpdateSubscriptionPauseCollectionBehavior {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPauseCollectionBehavior::KeepAsDraft => "keep_as_draft",
UpdateSubscriptionPauseCollectionBehavior::MarkUncollectible => "mark_uncollectible",
UpdateSubscriptionPauseCollectionBehavior::Void => "void",
}
}
}
impl AsRef<str> for UpdateSubscriptionPauseCollectionBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionPauseCollectionBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionPauseCollectionBehavior {
fn default() -> Self {
Self::KeepAsDraft
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptions`'s `transaction_type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
Business,
Personal,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType::Business => "business",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType::Personal => "personal",
}
}
}
impl AsRef<str>
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitMandateOptionsTransactionType
{
fn default() -> Self {
Self::Business
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebit`'s `verification_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod {
Automatic,
Instant,
Microdeposits,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod::Automatic => "automatic",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod::Instant => "instant",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod::Microdeposits => "microdeposits",
}
}
}
impl AsRef<str>
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsAcssDebitVerificationMethod
{
fn default() -> Self {
Self::Automatic
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontact`'s `preferred_language` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage {
De,
En,
Fr,
Nl,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::De => "de",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::En => "en",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::Fr => "fr",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage::Nl => "nl",
}
}
}
impl AsRef<str>
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsBancontactPreferredLanguage
{
fn default() -> Self {
Self::De
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptions`'s `amount_type` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType {
Fixed,
Maximum,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType::Fixed => "fixed",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType::Maximum => "maximum",
}
}
}
impl AsRef<str>
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardMandateOptionsAmountType
{
fn default() -> Self {
Self::Fixed
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCard`'s `network` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
Amex,
CartesBancaires,
Diners,
Discover,
EftposAu,
Interac,
Jcb,
Mastercard,
Unionpay,
Unknown,
Visa,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Amex => "amex",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::CartesBancaires => {
"cartes_bancaires"
}
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Diners => "diners",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Discover => {
"discover"
}
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::EftposAu => {
"eftpos_au"
}
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Interac => "interac",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Jcb => "jcb",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Mastercard => {
"mastercard"
}
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Unionpay => {
"unionpay"
}
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Unknown => "unknown",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork::Visa => "visa",
}
}
}
impl AsRef<str> for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardNetwork {
fn default() -> Self {
Self::Amex
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCard`'s `request_three_d_secure` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure {
Any,
Automatic,
Challenge,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure::Any => "any",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure::Automatic => "automatic",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure::Challenge => "challenge",
}
}
}
impl AsRef<str> for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsCardRequestThreeDSecure
{
fn default() -> Self {
Self::Any
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections`'s `permissions` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions
{
Balances,
Ownership,
PaymentMethod,
Transactions,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::Balances => "balances",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::Ownership => "ownership",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::PaymentMethod => "payment_method",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions::Transactions => "transactions",
}
}
}
impl AsRef<str> for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPermissions {
fn default() -> Self {
Self::Balances
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnections`'s `prefetch` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch
{
Balances,
Transactions,
}
impl
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch
{
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch::Balances => "balances",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch::Transactions => "transactions",
}
}
}
impl AsRef<str> for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountFinancialConnectionsPrefetch {
fn default() -> Self {
Self::Balances
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccount`'s `verification_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod {
Automatic,
Instant,
Microdeposits,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod::Automatic => "automatic",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod::Instant => "instant",
UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod::Microdeposits => "microdeposits",
}
}
}
impl AsRef<str>
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod
{
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod
{
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default
for UpdateSubscriptionPaymentSettingsPaymentMethodOptionsUsBankAccountVerificationMethod
{
fn default() -> Self {
Self::Automatic
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettings`'s `payment_method_types` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsPaymentMethodTypes {
AchCreditTransfer,
AchDebit,
AcssDebit,
AuBecsDebit,
BacsDebit,
Bancontact,
Boleto,
Card,
Cashapp,
CustomerBalance,
Eps,
Fpx,
Giropay,
Grabpay,
Ideal,
Konbini,
Link,
P24,
Paynow,
Paypal,
Promptpay,
SepaCreditTransfer,
SepaDebit,
Sofort,
UsBankAccount,
WechatPay,
}
impl UpdateSubscriptionPaymentSettingsPaymentMethodTypes {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::AchCreditTransfer => {
"ach_credit_transfer"
}
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::AchDebit => "ach_debit",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::AcssDebit => "acss_debit",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::AuBecsDebit => "au_becs_debit",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::BacsDebit => "bacs_debit",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Bancontact => "bancontact",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Boleto => "boleto",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Card => "card",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Cashapp => "cashapp",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::CustomerBalance => {
"customer_balance"
}
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Eps => "eps",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Fpx => "fpx",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Giropay => "giropay",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Grabpay => "grabpay",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Ideal => "ideal",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Konbini => "konbini",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Link => "link",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::P24 => "p24",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Paynow => "paynow",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Paypal => "paypal",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Promptpay => "promptpay",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::SepaCreditTransfer => {
"sepa_credit_transfer"
}
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::SepaDebit => "sepa_debit",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::Sofort => "sofort",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::UsBankAccount => "us_bank_account",
UpdateSubscriptionPaymentSettingsPaymentMethodTypes::WechatPay => "wechat_pay",
}
}
}
impl AsRef<str> for UpdateSubscriptionPaymentSettingsPaymentMethodTypes {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionPaymentSettingsPaymentMethodTypes {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionPaymentSettingsPaymentMethodTypes {
fn default() -> Self {
Self::AchCreditTransfer
}
}
/// An enum representing the possible values of an `UpdateSubscriptionPaymentSettings`'s `save_default_payment_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
Off,
OnSubscription,
}
impl UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod::Off => "off",
UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod::OnSubscription => {
"on_subscription"
}
}
}
}
impl AsRef<str> for UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionPaymentSettingsSaveDefaultPaymentMethod {
fn default() -> Self {
Self::Off
}
}
/// An enum representing the possible values of an `UpdateSubscriptionTrialSettingsEndBehavior`'s `missing_payment_method` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
Cancel,
CreateInvoice,
Pause,
}
impl UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
pub fn as_str(self) -> &'static str {
match self {
UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod::Cancel => "cancel",
UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod::CreateInvoice => {
"create_invoice"
}
UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod::Pause => "pause",
}
}
}
impl AsRef<str> for UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for UpdateSubscriptionTrialSettingsEndBehaviorMissingPaymentMethod {
fn default() -> Self {
Self::Cancel
}
}