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
// ======================================
// This file was automatically generated.
// ======================================
use crate::config::{Client, Response};
use crate::ids::AccountId;
use crate::params::{Deleted, Expand, Expandable, List, Metadata, Object, RangeQuery, Timestamp};
use crate::resources::{
Address, BankAccount, BusinessType, Card, Currency, DelayDays, Dob, File, Person, Weekday,
};
use serde_derive::{Deserialize, Serialize};
/// The resource representing a Stripe "Account".
///
/// For more details see [https://stripe.com/docs/api/accounts/object](https://stripe.com/docs/api/accounts/object).
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Account {
/// Unique identifier for the object.
pub id: AccountId,
/// Optional information related to the business.
#[serde(skip_serializing_if = "Option::is_none")]
pub business_profile: Option<BusinessProfile>,
/// The business type.
///
/// Can be `individual` or `company`.
#[serde(skip_serializing_if = "Option::is_none")]
pub business_type: Option<BusinessType>,
#[serde(skip_serializing_if = "Option::is_none")]
pub capabilities: Option<AccountCapabilities>,
/// Whether the account can create live charges.
#[serde(skip_serializing_if = "Option::is_none")]
pub charges_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub company: Option<Company>,
/// The account's country.
#[serde(skip_serializing_if = "Option::is_none")]
pub country: Option<String>,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<Timestamp>,
/// Three-letter ISO currency code representing the default currency for the account.
///
/// This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_currency: Option<Currency>,
// Always true for a deleted object
#[serde(default)]
pub deleted: bool,
/// Whether account details have been submitted.
///
/// Standard accounts cannot receive payouts before this is true.
#[serde(skip_serializing_if = "Option::is_none")]
pub details_submitted: Option<bool>,
/// The primary user's email address.
#[serde(skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
/// External accounts (bank accounts and debit cards) currently attached to this account.
#[serde(default)]
pub external_accounts: List<ExternalAccount>,
#[serde(skip_serializing_if = "Option::is_none")]
pub individual: Option<Person>,
/// Set of key-value pairs that you can attach to an object.
///
/// This can be useful for storing additional information about the object in a structured format.
#[serde(default)]
pub metadata: Metadata,
/// Whether Stripe can send payouts to this account.
#[serde(skip_serializing_if = "Option::is_none")]
pub payouts_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub requirements: Option<AccountRequirements>,
/// Options for customizing how the account functions within Stripe.
#[serde(skip_serializing_if = "Option::is_none")]
pub settings: Option<AccountSettings>,
#[serde(skip_serializing_if = "Option::is_none")]
pub tos_acceptance: Option<TosAcceptance>,
/// The Stripe account type.
///
/// Can be `standard`, `express`, or `custom`.
#[serde(rename = "type")]
#[serde(skip_serializing_if = "Option::is_none")]
pub type_: Option<AccountType>,
}
impl Account {
/// Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect).
///
/// If you’re not a platform, the list is empty.
pub fn list(client: &Client, params: ListAccounts<'_>) -> Response<List<Account>> {
client.get_query("/accounts", ¶ms)
}
/// With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users.
/// To do this, you’ll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
///
/// For Standard accounts, parameters other than `country`, `email`, and `type`
/// are used to prefill the account application that we ask the account holder to complete.
pub fn create(client: &Client, params: CreateAccount<'_>) -> Response<Account> {
client.post_form("/accounts", ¶ms)
}
/// Retrieves the details of an account.
pub fn retrieve(client: &Client, id: &AccountId, expand: &[&str]) -> Response<Account> {
client.get_query(&format!("/accounts/{}", id), &Expand { expand })
}
/// Updates a connected [Express or Custom account](https://stripe.com/docs/connect/accounts) by setting the values of the parameters passed.
///
/// Any parameters not provided are left unchanged.
/// Most parameters can be changed only for Custom accounts.
/// (These are marked **Custom Only** below.) Parameters marked **Custom and Express** are supported by both account types. To update your own account, use the [Dashboard](https://dashboard.stripe.com/account).
/// Refer to our [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
pub fn update(client: &Client, id: &AccountId, params: UpdateAccount<'_>) -> Response<Account> {
client.post_form(&format!("/accounts/{}", id), ¶ms)
}
/// With [Connect](https://stripe.com/docs/connect), you may delete Custom accounts you manage.
///
/// Custom accounts created using test-mode keys can be deleted at any time.
///
/// Custom accounts created using live-mode keys may only be deleted once all balances are zero. If you are looking to close your own account, use the [data tab in your account settings](https://dashboard.stripe.com/account/data) instead.
pub fn delete(client: &Client, id: &AccountId) -> Response<Deleted<AccountId>> {
client.delete(&format!("/accounts/{}", id))
}
}
impl Object for Account {
type Id = AccountId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"account"
}
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct BusinessProfile {
/// The merchant category code for the account.
///
/// MCCs are used to classify businesses based on the goods or services they provide.
#[serde(skip_serializing_if = "Option::is_none")]
pub mcc: Option<String>,
/// The customer-facing business name.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Internal-only description of the product sold or service provided by the business.
///
/// It's used by Stripe for risk and underwriting purposes.
#[serde(skip_serializing_if = "Option::is_none")]
pub product_description: Option<String>,
/// A publicly available mailing address for sending support issues to.
#[serde(skip_serializing_if = "Option::is_none")]
pub support_address: Option<Address>,
/// A publicly available email address for sending support issues to.
#[serde(skip_serializing_if = "Option::is_none")]
pub support_email: Option<String>,
/// A publicly available phone number to call with support issues.
#[serde(skip_serializing_if = "Option::is_none")]
pub support_phone: Option<String>,
/// A publicly available website for handling support issues.
#[serde(skip_serializing_if = "Option::is_none")]
pub support_url: Option<String>,
/// The business's publicly available website.
#[serde(skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct AccountCapabilities {
/// The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
#[serde(skip_serializing_if = "Option::is_none")]
pub card_payments: Option<CapabilityStatus>,
/// The status of the legacy payments capability of the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub legacy_payments: Option<CapabilityStatus>,
/// The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub transfers: Option<AccountCapabilitiesTransfers>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct AccountRequirements {
/// The date the fields in `currently_due` must be collected by to keep payouts enabled for the account.
///
/// These fields might block payouts sooner if the next threshold is reached before these fields are collected.
#[serde(skip_serializing_if = "Option::is_none")]
pub current_deadline: Option<Timestamp>,
/// The fields that need to be collected to keep the account enabled.
///
/// If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
#[serde(skip_serializing_if = "Option::is_none")]
pub currently_due: Option<Vec<String>>,
/// If the account is disabled, this string describes why the account can’t create charges or receive payouts.
///
/// Can be `requirements.past_due`, `requirements.pending_verification`, `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `listed`, `under_review`, or `other`.
#[serde(skip_serializing_if = "Option::is_none")]
pub disabled_reason: Option<String>,
/// The fields that need to be collected assuming all volume thresholds are reached.
///
/// As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set.
#[serde(skip_serializing_if = "Option::is_none")]
pub eventually_due: Option<Vec<String>>,
/// The fields that weren't collected by the `current_deadline`.
///
/// These fields need to be collected to re-enable the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub past_due: Option<Vec<String>>,
/// Additional fields that may be required depending on the results of verification or review for provided requirements.
///
/// If any of these fields become required, they appear in `currently_due` or `past_due`.
#[serde(skip_serializing_if = "Option::is_none")]
pub pending_verification: Option<Vec<String>>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct AccountSettings {
pub branding: BrandingSettings,
pub card_payments: CardPaymentsSettings,
pub dashboard: DashboardSettings,
pub payments: PaymentsSettings,
#[serde(skip_serializing_if = "Option::is_none")]
pub payouts: Option<PayoutSettings>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct BrandingSettings {
/// (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account.
///
/// Must be square and at least 128px x 128px.
#[serde(skip_serializing_if = "Option::is_none")]
pub icon: Option<Expandable<File>>,
/// (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided.
///
/// Must be at least 128px x 128px.
#[serde(skip_serializing_if = "Option::is_none")]
pub logo: Option<Expandable<File>>,
/// A CSS hex color value representing the primary branding color for this account.
#[serde(skip_serializing_if = "Option::is_none")]
pub primary_color: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CardPaymentsSettings {
#[serde(skip_serializing_if = "Option::is_none")]
pub decline_on: Option<DeclineChargeOn>,
/// The default text that appears on credit card statements when a charge is made.
///
/// This field prefixes any dynamic `statement_descriptor` specified on the charge.
/// `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor_prefix: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DashboardSettings {
/// The display name for this account.
///
/// This is used on the Stripe Dashboard to differentiate between accounts.
#[serde(skip_serializing_if = "Option::is_none")]
pub display_name: Option<String>,
/// The timezone used in the Stripe Dashboard for this account.
///
/// A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).
#[serde(skip_serializing_if = "Option::is_none")]
pub timezone: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DeclineChargeOn {
/// Whether Stripe automatically declines charges with an incorrect ZIP or postal code.
///
/// This setting only applies when a ZIP or postal code is provided and they fail bank verification.
pub avs_failure: bool,
/// Whether Stripe automatically declines charges with an incorrect CVC.
///
/// This setting only applies when a CVC is provided and it fails bank verification.
pub cvc_failure: bool,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PaymentsSettings {
/// The default text that appears on credit card statements when a charge is made.
///
/// This field prefixes any dynamic `statement_descriptor` specified on the charge.
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor: Option<String>,
/// The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only).
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor_kana: Option<String>,
/// The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only).
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor_kanji: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PayoutSettings {
/// A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account.
///
/// See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details.
/// Default value is `true` for Express accounts and `false` for Custom accounts.
pub debit_negative_balances: bool,
pub schedule: TransferSchedule,
/// The text that appears on the bank account statement for payouts.
///
/// If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct TosAcceptance {
/// The Unix timestamp marking when the Stripe Services Agreement was accepted by the account representative.
#[serde(skip_serializing_if = "Option::is_none")]
pub date: Option<Timestamp>,
/// The IP address from which the Stripe Services Agreement was accepted by the account representative.
#[serde(skip_serializing_if = "Option::is_none")]
pub ip: Option<String>,
/// The user agent of the browser from which the Stripe Services Agreement was accepted by the account representative.
#[serde(skip_serializing_if = "Option::is_none")]
pub user_agent: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Company {
#[serde(skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
/// The Kana variation of the company's primary address (Japan only).
#[serde(skip_serializing_if = "Option::is_none")]
pub address_kana: Option<Address>,
/// The Kanji variation of the company's primary address (Japan only).
#[serde(skip_serializing_if = "Option::is_none")]
pub address_kanji: Option<Address>,
/// Whether the company's directors have been provided.
///
/// This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).
pub directors_provided: bool,
/// The company's legal name.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// The Kana variation of the company's legal name (Japan only).
#[serde(skip_serializing_if = "Option::is_none")]
pub name_kana: Option<String>,
/// The Kanji variation of the company's legal name (Japan only).
#[serde(skip_serializing_if = "Option::is_none")]
pub name_kanji: Option<String>,
/// Whether the company's owners have been provided.
///
/// This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that all owners were provided.
/// Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).
pub owners_provided: bool,
/// The company's phone number (used for verification).
#[serde(skip_serializing_if = "Option::is_none")]
pub phone: Option<String>,
/// Whether the company's business ID number was provided.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_id_provided: Option<bool>,
/// The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_id_registrar: Option<String>,
/// Whether the company's business VAT number was provided.
#[serde(skip_serializing_if = "Option::is_none")]
pub vat_id_provided: Option<bool>,
/// Information on the verification state of the company.
#[serde(skip_serializing_if = "Option::is_none")]
pub verification: Option<LegalEntityCompanyVerification>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct LegalEntityCompanyVerification {
pub document: LegalEntityCompanyVerificationDocument,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct LegalEntityCompanyVerificationDocument {
/// The back of a document returned by a [file upload](#create_file) with a `purpose` value of `additional_verification`.
#[serde(skip_serializing_if = "Option::is_none")]
pub back: Option<Expandable<File>>,
/// A user-displayable string describing the verification state of this document.
#[serde(skip_serializing_if = "Option::is_none")]
pub details: Option<String>,
/// One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`.
///
/// A machine-readable code specifying the verification state for this document.
#[serde(skip_serializing_if = "Option::is_none")]
pub details_code: Option<String>,
/// The front of a document returned by a [file upload](#create_file) with a `purpose` value of `additional_verification`.
#[serde(skip_serializing_if = "Option::is_none")]
pub front: Option<Expandable<File>>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct TransferSchedule {
/// The number of days charges for the account will be held before being paid out.
pub delay_days: u32,
/// How frequently funds will be paid out.
///
/// One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
pub interval: String,
/// The day of the month funds will be paid out.
///
/// Only shown if `interval` is monthly.
/// Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
#[serde(skip_serializing_if = "Option::is_none")]
pub monthly_anchor: Option<u8>,
/// The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc.
///
/// Only shown if `interval` is weekly.
#[serde(skip_serializing_if = "Option::is_none")]
pub weekly_anchor: Option<Weekday>,
}
/// The parameters for `Account::create`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct CreateAccount<'a> {
/// An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub account_token: Option<&'a str>,
/// Non-essential business information about the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub business_profile: Option<BusinessProfile>,
/// The business type.
///
/// Can be `individual` or `company`.
#[serde(skip_serializing_if = "Option::is_none")]
pub business_type: Option<&'a str>,
/// Information about the company or business.
///
/// This field is null unless `business_type` is set to `company`.
#[serde(skip_serializing_if = "Option::is_none")]
pub company: Option<CompanyParams>,
/// The country in which the account holder resides, or in which the business is legally established.
///
/// This should be an ISO 3166-1 alpha-2 country code.
/// For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created.
#[serde(skip_serializing_if = "Option::is_none")]
pub country: Option<&'a str>,
/// Three-letter ISO currency code representing the default currency for the account.
///
/// This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_currency: Option<Currency>,
/// The email address of the account holder.
///
/// For Custom accounts, this is only to make the account easier to identify to you: Stripe will never directly email your users.
#[serde(skip_serializing_if = "Option::is_none")]
pub email: Option<&'a str>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// A card or bank account to attach to the account.
///
/// You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.
/// By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists.
/// To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
#[serde(skip_serializing_if = "Option::is_none")]
pub external_account: Option<&'a str>,
/// Information about the person represented by the account.
///
/// This field is null unless `business_type` is set to `individual`.
#[serde(skip_serializing_if = "Option::is_none")]
pub individual: Option<PersonParams>,
/// A set of key-value pairs that you can attach to an `Account` object.
///
/// This can be useful for storing additional information about the account in a structured format.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// The set of capabilities you want to unlock for this account (US only).
///
/// Each capability will be inactive until you have provided its specific requirements and Stripe has verified them.
/// An account may have some of its requested capabilities be active and some be inactive.
#[serde(skip_serializing_if = "Option::is_none")]
pub requested_capabilities: Option<Vec<RequestedCapability>>,
/// Options for customizing how the account functions within Stripe.
#[serde(skip_serializing_if = "Option::is_none")]
pub settings: Option<AccountSettingsParams>,
/// Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).
#[serde(skip_serializing_if = "Option::is_none")]
pub tos_acceptance: Option<AcceptTos>,
/// The type of Stripe account to create.
///
/// Currently must be `custom`, as only [Custom accounts](https://stripe.com/docs/connect/custom-accounts) may be created via the API.
#[serde(rename = "type")]
#[serde(skip_serializing_if = "Option::is_none")]
pub type_: Option<AccountType>,
}
impl<'a> CreateAccount<'a> {
pub fn new() -> Self {
CreateAccount {
account_token: Default::default(),
business_profile: Default::default(),
business_type: Default::default(),
company: Default::default(),
country: Default::default(),
default_currency: Default::default(),
email: Default::default(),
expand: Default::default(),
external_account: Default::default(),
individual: Default::default(),
metadata: Default::default(),
requested_capabilities: Default::default(),
settings: Default::default(),
tos_acceptance: Default::default(),
type_: Default::default(),
}
}
}
/// The parameters for `Account::list`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct ListAccounts<'a> {
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<RangeQuery<Timestamp>>,
/// 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<AccountId>,
/// 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>,
/// 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<AccountId>,
}
impl<'a> ListAccounts<'a> {
pub fn new() -> Self {
ListAccounts {
created: Default::default(),
ending_before: Default::default(),
expand: Default::default(),
limit: Default::default(),
starting_after: Default::default(),
}
}
}
/// The parameters for `Account::update`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct UpdateAccount<'a> {
/// An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub account_token: Option<&'a str>,
/// Non-essential business information about the account.
#[serde(skip_serializing_if = "Option::is_none")]
pub business_profile: Option<BusinessProfile>,
/// The business type.
///
/// Can be `individual` or `company`.
#[serde(skip_serializing_if = "Option::is_none")]
pub business_type: Option<&'a str>,
/// Information about the company or business.
///
/// This field is null unless `business_type` is set to `company`.
#[serde(skip_serializing_if = "Option::is_none")]
pub company: Option<CompanyParams>,
/// Three-letter ISO currency code representing the default currency for the account.
///
/// This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_currency: Option<Currency>,
/// Email address of the account representative.
///
/// For Standard accounts, this is used to ask them to claim their Stripe account.
/// For Custom accounts, this only makes the account easier to identify to platforms; Stripe does not email the account representative.
#[serde(skip_serializing_if = "Option::is_none")]
pub email: Option<&'a str>,
/// Specifies which fields in the response should be expanded.
#[serde(skip_serializing_if = "Expand::is_empty")]
pub expand: &'a [&'a str],
/// A card or bank account to attach to the account.
///
/// You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/stripe.js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.
/// By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists.
/// To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
#[serde(skip_serializing_if = "Option::is_none")]
pub external_account: Option<&'a str>,
/// Information about the person represented by the account.
///
/// This field is null unless `business_type` is set to `individual`.
#[serde(skip_serializing_if = "Option::is_none")]
pub individual: Option<PersonParams>,
/// A set of key-value pairs that you can attach to an `Account` object.
///
/// This can be useful for storing additional information about the account in a structured format.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>,
/// The set of capabilities you want to unlock for this account (US only).
///
/// Each capability will be inactive until you have provided its specific requirements and Stripe has verified them.
/// An account may have some of its requested capabilities be active and some be inactive.
#[serde(skip_serializing_if = "Option::is_none")]
pub requested_capabilities: Option<Vec<RequestedCapability>>,
/// Options for customizing how the account functions within Stripe.
#[serde(skip_serializing_if = "Option::is_none")]
pub settings: Option<AccountSettingsParams>,
/// Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance).
#[serde(skip_serializing_if = "Option::is_none")]
pub tos_acceptance: Option<AcceptTos>,
}
impl<'a> UpdateAccount<'a> {
pub fn new() -> Self {
UpdateAccount {
account_token: Default::default(),
business_profile: Default::default(),
business_type: Default::default(),
company: Default::default(),
default_currency: Default::default(),
email: Default::default(),
expand: Default::default(),
external_account: Default::default(),
individual: Default::default(),
metadata: Default::default(),
requested_capabilities: Default::default(),
settings: Default::default(),
tos_acceptance: Default::default(),
}
}
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct AcceptTos {
pub date: Timestamp,
pub ip: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub user_agent: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct AccountSettingsParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub branding: Option<BrandingSettingsParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub card_payments: Option<CardPaymentsSettingsParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub payments: Option<PaymentsSettingsParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub payouts: Option<PayoutSettingsParams>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CompanyParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
#[serde(skip_serializing_if = "Option::is_none")]
pub address_kana: Option<Address>,
#[serde(skip_serializing_if = "Option::is_none")]
pub address_kanji: Option<Address>,
#[serde(skip_serializing_if = "Option::is_none")]
pub directors_provided: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub name_kana: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub name_kanji: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub owners_provided: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub phone: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_id_registrar: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub vat_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub verification: Option<CompanyParamsVerification>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PersonParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub address: Option<Address>,
#[serde(skip_serializing_if = "Option::is_none")]
pub address_kana: Option<Address>,
#[serde(skip_serializing_if = "Option::is_none")]
pub address_kanji: Option<Address>,
#[serde(skip_serializing_if = "Option::is_none")]
pub dob: Option<Dob>,
#[serde(skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub first_name_kana: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub first_name_kanji: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub gender: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub id_number: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub last_name_kana: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub last_name_kanji: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub maiden_name: Option<String>,
#[serde(default)]
pub metadata: Metadata,
#[serde(skip_serializing_if = "Option::is_none")]
pub phone: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub ssn_last_4: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub verification: Option<PersonVerificationParams>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct BrandingSettingsParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub icon: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub logo: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub primary_color: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CardPaymentsSettingsParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub decline_on: Option<DeclineChargeOnParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor_prefix: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CompanyParamsVerification {
#[serde(skip_serializing_if = "Option::is_none")]
pub document: Option<CompanyParamsVerificationDocument>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PaymentsSettingsParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor_kana: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor_kanji: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PayoutSettingsParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub debit_negative_balances: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub schedule: Option<TransferScheduleParams>,
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PersonVerificationParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub additional_document: Option<PersonVerificationParamsAdditionalDocument>,
#[serde(skip_serializing_if = "Option::is_none")]
pub document: Option<PersonVerificationDocumentParams>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct CompanyParamsVerificationDocument {
#[serde(skip_serializing_if = "Option::is_none")]
pub back: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub front: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct DeclineChargeOnParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub avs_failure: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
pub cvc_failure: Option<bool>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PersonVerificationDocumentParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub back: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub front: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct PersonVerificationParamsAdditionalDocument {
#[serde(skip_serializing_if = "Option::is_none")]
pub back: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub front: Option<String>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct TransferScheduleParams {
#[serde(skip_serializing_if = "Option::is_none")]
pub delay_days: Option<DelayDays>,
#[serde(skip_serializing_if = "Option::is_none")]
pub interval: Option<TransferScheduleInterval>,
#[serde(skip_serializing_if = "Option::is_none")]
pub monthly_anchor: Option<u8>,
#[serde(skip_serializing_if = "Option::is_none")]
pub weekly_anchor: Option<Weekday>,
}
#[derive(Clone, Debug, Deserialize, Serialize)]
#[serde(tag = "object", rename_all = "snake_case")]
pub enum ExternalAccount {
BankAccount(BankAccount),
Card(Card),
}
/// An enum representing the possible values of an `AccountCapabilities`'s `transfers` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum AccountCapabilitiesTransfers {
Active,
Inactive,
Pending,
}
impl AccountCapabilitiesTransfers {
pub fn as_str(self) -> &'static str {
match self {
AccountCapabilitiesTransfers::Active => "active",
AccountCapabilitiesTransfers::Inactive => "inactive",
AccountCapabilitiesTransfers::Pending => "pending",
}
}
}
impl AsRef<str> for AccountCapabilitiesTransfers {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for AccountCapabilitiesTransfers {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
/// An enum representing the possible values of an `CreateAccount`'s `type_` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum AccountType {
Custom,
Express,
Standard,
}
impl AccountType {
pub fn as_str(self) -> &'static str {
match self {
AccountType::Custom => "custom",
AccountType::Express => "express",
AccountType::Standard => "standard",
}
}
}
impl AsRef<str> for AccountType {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for AccountType {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
/// An enum representing the possible values of an `AccountCapabilities`'s `card_payments` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CapabilityStatus {
Active,
Inactive,
Pending,
}
impl CapabilityStatus {
pub fn as_str(self) -> &'static str {
match self {
CapabilityStatus::Active => "active",
CapabilityStatus::Inactive => "inactive",
CapabilityStatus::Pending => "pending",
}
}
}
impl AsRef<str> for CapabilityStatus {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CapabilityStatus {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
/// An enum representing the possible values of an `CreateAccount`'s `requested_capabilities` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum RequestedCapability {
CardIssuing,
CardPayments,
LegacyPayments,
Transfers,
}
impl RequestedCapability {
pub fn as_str(self) -> &'static str {
match self {
RequestedCapability::CardIssuing => "card_issuing",
RequestedCapability::CardPayments => "card_payments",
RequestedCapability::LegacyPayments => "legacy_payments",
RequestedCapability::Transfers => "transfers",
}
}
}
impl AsRef<str> for RequestedCapability {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for RequestedCapability {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
/// An enum representing the possible values of an `TransferScheduleParams`'s `interval` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum TransferScheduleInterval {
Daily,
Manual,
Monthly,
Weekly,
}
impl TransferScheduleInterval {
pub fn as_str(self) -> &'static str {
match self {
TransferScheduleInterval::Daily => "daily",
TransferScheduleInterval::Manual => "manual",
TransferScheduleInterval::Monthly => "monthly",
TransferScheduleInterval::Weekly => "weekly",
}
}
}
impl AsRef<str> for TransferScheduleInterval {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for TransferScheduleInterval {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}