stripe 2.1.0 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -63,7 +63,8 @@ definitions:
63
63
  type:
64
64
  - boolean
65
65
  object:
66
- description: The type of object. Always has the value "list".
66
+ description: String representing the object's type. Objects of the same
67
+ type share the same value. Always has the value "list".
67
68
  enum:
68
69
  - list
69
70
  type:
@@ -86,7 +87,7 @@ definitions:
86
87
  type:
87
88
  - object
88
89
  id:
89
- description: A unique identifier for the account.
90
+ description: Unique identifier for the object.
90
91
  type:
91
92
  - string
92
93
  legal_entity:
@@ -101,17 +102,32 @@ definitions:
101
102
  type:
102
103
  - string
103
104
  metadata:
104
- description: A set of key/value pairs that you can attach to an account object.
105
- It can be useful for storing additional information about the account in
106
- a structured format.
105
+ description: Set of key/value pairs that you can attach to an object. It can
106
+ be useful for storing additional information about the object in a structured
107
+ format.
107
108
  type:
108
109
  - object
109
110
  object:
110
- description: ''
111
+ description: String representing the object's type. Objects of the same type
112
+ share the same value.
111
113
  type:
112
114
  - string
113
115
  orders:
114
116
  "$ref": "#/definitions/settings"
117
+ payout_schedule:
118
+ "$ref": "#/definitions/transfer_schedule"
119
+ payout_statement_descriptor:
120
+ description: The text that will appear on the account's bank account statement
121
+ for payouts. If not set, this will default to your platform's bank descriptor
122
+ set on the Dashboard.
123
+ type:
124
+ - string
125
+ payouts_enabled:
126
+ description: Whether or not Stripe will send automatic transfers for this
127
+ account. This is only false when Stripe is waiting for additional information
128
+ from the account holder.
129
+ type:
130
+ - boolean
115
131
  product_description:
116
132
  description: An internal-only description of the product or service provided.
117
133
  This is used by Stripe in the event the account gets flagged for potential
@@ -132,26 +148,13 @@ definitions:
132
148
  type:
133
149
  - string
134
150
  timezone:
135
- description: The timezone used in the Stripe dashboard for this account. A
136
- list of possible timezone values is maintained at the [IANA Timezone Database](http://www.iana.org/time-zones).
151
+ description: The time zone used in the Stripe dashboard for this account.
152
+ A list of possible time zone values is maintained at the [IANA Time Zone
153
+ Database](http://www.iana.org/time-zones).
137
154
  type:
138
155
  - string
139
156
  tos_acceptance:
140
157
  "$ref": "#/definitions/account_tos_acceptance"
141
- transfer_schedule:
142
- "$ref": "#/definitions/transfer_schedule"
143
- transfer_statement_descriptor:
144
- description: The text that will appear on the account's bank account statement
145
- for payouts. If not set, this will default to your platform's bank descriptor
146
- set on the Dashboard.
147
- type:
148
- - string
149
- transfers_enabled:
150
- description: Whether or not Stripe will send automatic transfers for this
151
- account. This is only false when Stripe is waiting for additional information
152
- from the account holder.
153
- type:
154
- - boolean
155
158
  verification:
156
159
  "$ref": "#/definitions/account_verification"
157
160
  required:
@@ -167,9 +170,9 @@ definitions:
167
170
  - legal_entity
168
171
  - managed
169
172
  - object
173
+ - payout_schedule
174
+ - payouts_enabled
170
175
  - tos_acceptance
171
- - transfer_schedule
172
- - transfers_enabled
173
176
  - verification
174
177
  title: Account
175
178
  type:
@@ -305,7 +308,8 @@ definitions:
305
308
  type:
306
309
  - boolean
307
310
  object:
308
- description: The type of object. Always has the value "list".
311
+ description: String representing the object's type. Objects of the same
312
+ type share the same value. Always has the value "list".
309
313
  enum:
310
314
  - list
311
315
  type:
@@ -328,7 +332,7 @@ definitions:
328
332
  type:
329
333
  - object
330
334
  id:
331
- description: A unique identifier for the account.
335
+ description: Unique identifier for the object.
332
336
  type:
333
337
  - string
334
338
  keys:
@@ -347,17 +351,32 @@ definitions:
347
351
  type:
348
352
  - string
349
353
  metadata:
350
- description: A set of key/value pairs that you can attach to an account object.
351
- It can be useful for storing additional information about the account in
352
- a structured format.
354
+ description: Set of key/value pairs that you can attach to an object. It can
355
+ be useful for storing additional information about the object in a structured
356
+ format.
353
357
  type:
354
358
  - object
355
359
  object:
356
- description: ''
360
+ description: String representing the object's type. Objects of the same type
361
+ share the same value.
357
362
  type:
358
363
  - string
359
364
  orders:
360
365
  "$ref": "#/definitions/settings"
366
+ payout_schedule:
367
+ "$ref": "#/definitions/transfer_schedule"
368
+ payout_statement_descriptor:
369
+ description: The text that will appear on the account's bank account statement
370
+ for payouts. If not set, this will default to your platform's bank descriptor
371
+ set on the Dashboard.
372
+ type:
373
+ - string
374
+ payouts_enabled:
375
+ description: Whether or not Stripe will send automatic transfers for this
376
+ account. This is only false when Stripe is waiting for additional information
377
+ from the account holder.
378
+ type:
379
+ - boolean
361
380
  product_description:
362
381
  description: An internal-only description of the product or service provided.
363
382
  This is used by Stripe in the event the account gets flagged for potential
@@ -378,26 +397,13 @@ definitions:
378
397
  type:
379
398
  - string
380
399
  timezone:
381
- description: The timezone used in the Stripe dashboard for this account. A
382
- list of possible timezone values is maintained at the [IANA Timezone Database](http://www.iana.org/time-zones).
400
+ description: The time zone used in the Stripe dashboard for this account.
401
+ A list of possible time zone values is maintained at the [IANA Time Zone
402
+ Database](http://www.iana.org/time-zones).
383
403
  type:
384
404
  - string
385
405
  tos_acceptance:
386
406
  "$ref": "#/definitions/account_tos_acceptance"
387
- transfer_schedule:
388
- "$ref": "#/definitions/transfer_schedule"
389
- transfer_statement_descriptor:
390
- description: The text that will appear on the account's bank account statement
391
- for payouts. If not set, this will default to your platform's bank descriptor
392
- set on the Dashboard.
393
- type:
394
- - string
395
- transfers_enabled:
396
- description: Whether or not Stripe will send automatic transfers for this
397
- account. This is only false when Stripe is waiting for additional information
398
- from the account holder.
399
- type:
400
- - boolean
401
407
  verification:
402
408
  "$ref": "#/definitions/account_verification"
403
409
  required:
@@ -414,9 +420,9 @@ definitions:
414
420
  - legal_entity
415
421
  - managed
416
422
  - object
423
+ - payout_schedule
424
+ - payouts_enabled
417
425
  - tos_acceptance
418
- - transfer_schedule
419
- - transfers_enabled
420
426
  - verification
421
427
  title: AccountWithKeys
422
428
  type:
@@ -455,7 +461,8 @@ definitions:
455
461
  alipay_account:
456
462
  properties:
457
463
  created:
458
- description: ''
464
+ description: Time at which the object was created. Measured in seconds since
465
+ the Unix epoch.
459
466
  type:
460
467
  - integer
461
468
  customer:
@@ -468,21 +475,23 @@ definitions:
468
475
  type:
469
476
  - string
470
477
  id:
471
- description: ''
478
+ description: Unique identifier for the object.
472
479
  type:
473
480
  - string
474
481
  livemode:
475
- description: ''
482
+ description: Flag indicating whether the object exists in live mode or test
483
+ mode.
476
484
  type:
477
485
  - boolean
478
486
  metadata:
479
- description: A set of key/value pairs that you can attach to a customer object.
480
- It can be useful for storing additional information about the customer in
481
- a structured format.
487
+ description: Set of key/value pairs that you can attach to an object. It can
488
+ be useful for storing additional information about the object in a structured
489
+ format.
482
490
  type:
483
491
  - object
484
492
  object:
485
- description: ''
493
+ description: String representing the object's type. Objects of the same type
494
+ share the same value.
486
495
  type:
487
496
  - string
488
497
  payment_amount:
@@ -526,7 +535,8 @@ definitions:
526
535
  apple_pay_domain:
527
536
  properties:
528
537
  created:
529
- description: ''
538
+ description: Time at which the object was created. Measured in seconds since
539
+ the Unix epoch.
530
540
  type:
531
541
  - integer
532
542
  domain_name:
@@ -534,15 +544,17 @@ definitions:
534
544
  type:
535
545
  - string
536
546
  id:
537
- description: ''
547
+ description: Unique identifier for the object.
538
548
  type:
539
549
  - string
540
550
  livemode:
541
- description: ''
551
+ description: Flag indicating whether the object exists in live mode or test
552
+ mode.
542
553
  type:
543
554
  - boolean
544
555
  object:
545
- description: ''
556
+ description: String representing the object's type. Objects of the same type
557
+ share the same value.
546
558
  type:
547
559
  - string
548
560
  required:
@@ -590,11 +602,13 @@ definitions:
590
602
  type:
591
603
  - array
592
604
  livemode:
593
- description: ''
605
+ description: Flag indicating whether the object exists in live mode or test
606
+ mode.
594
607
  type:
595
608
  - boolean
596
609
  object:
597
- description: ''
610
+ description: String representing the object's type. Objects of the same type
611
+ share the same value.
598
612
  type:
599
613
  - string
600
614
  pending:
@@ -624,15 +638,18 @@ definitions:
624
638
  type:
625
639
  - integer
626
640
  created:
627
- description: ''
641
+ description: Time at which the object was created. Measured in seconds since
642
+ the Unix epoch.
628
643
  type:
629
644
  - integer
630
645
  currency:
631
- description: ''
646
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
647
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
632
648
  type:
633
649
  - string
634
650
  description:
635
- description: ''
651
+ description: An arbitrary string attached to the object. Often useful for
652
+ displaying to users.
636
653
  type:
637
654
  - string
638
655
  fee:
@@ -642,7 +659,7 @@ definitions:
642
659
  fee_details:
643
660
  "$ref": "#/definitions/fee"
644
661
  id:
645
- description: ''
662
+ description: Unique identifier for the object.
646
663
  type:
647
664
  - string
648
665
  net:
@@ -650,7 +667,8 @@ definitions:
650
667
  type:
651
668
  - integer
652
669
  object:
653
- description: ''
670
+ description: String representing the object's type. Objects of the same type
671
+ share the same value.
654
672
  type:
655
673
  - string
656
674
  source:
@@ -735,8 +753,8 @@ definitions:
735
753
  type:
736
754
  - string
737
755
  currency:
738
- description: Three-letter ISO currency code representing the currency paid
739
- out to the bank account.
756
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
757
+ paid out to the bank account.
740
758
  type:
741
759
  - string
742
760
  customer:
@@ -758,7 +776,7 @@ definitions:
758
776
  type:
759
777
  - string
760
778
  id:
761
- description: ''
779
+ description: Unique identifier for the object.
762
780
  type:
763
781
  - string
764
782
  last4:
@@ -766,13 +784,14 @@ definitions:
766
784
  type:
767
785
  - string
768
786
  metadata:
769
- description: A set of key/value pairs that you can attach to a bank account
770
- object. It can be useful for storing additional information about the bank
771
- account in a structured format.
787
+ description: Set of key/value pairs that you can attach to an object. It can
788
+ be useful for storing additional information about the object in a structured
789
+ format.
772
790
  type:
773
791
  - object
774
792
  object:
775
- description: ''
793
+ description: String representing the object's type. Objects of the same type
794
+ share the same value.
776
795
  type:
777
796
  - string
778
797
  reusable:
@@ -844,12 +863,13 @@ definitions:
844
863
  type:
845
864
  - string
846
865
  created:
847
- description: ''
866
+ description: Time at which the object was created. Measured in seconds since
867
+ the Unix epoch.
848
868
  type:
849
869
  - integer
850
870
  currency:
851
- description: Three-letter ISO currency code representing the currency to which
852
- the bitcoin will be converted.
871
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
872
+ to which the bitcoin will be converted.
853
873
  type:
854
874
  - string
855
875
  customer:
@@ -857,7 +877,8 @@ definitions:
857
877
  type:
858
878
  - string
859
879
  description:
860
- description: ''
880
+ description: An arbitrary string attached to the object. Often useful for
881
+ displaying to users.
861
882
  type:
862
883
  - string
863
884
  email:
@@ -871,7 +892,7 @@ definitions:
871
892
  type:
872
893
  - boolean
873
894
  id:
874
- description: ''
895
+ description: Unique identifier for the object.
875
896
  type:
876
897
  - string
877
898
  inbound_address:
@@ -880,17 +901,19 @@ definitions:
880
901
  type:
881
902
  - string
882
903
  livemode:
883
- description: ''
904
+ description: Flag indicating whether the object exists in live mode or test
905
+ mode.
884
906
  type:
885
907
  - boolean
886
908
  metadata:
887
- description: A set of key/value pairs that you can attach to a customer object.
888
- It can be useful for storing additional information about the customer in
889
- a structured format.
909
+ description: Set of key/value pairs that you can attach to an object. It can
910
+ be useful for storing additional information about the object in a structured
911
+ format.
890
912
  type:
891
913
  - object
892
914
  object:
893
- description: ''
915
+ description: String representing the object's type. Objects of the same type
916
+ share the same value.
894
917
  type:
895
918
  - string
896
919
  payment:
@@ -899,8 +922,7 @@ definitions:
899
922
  type:
900
923
  - string
901
924
  refund_address:
902
- description: The refund address for these bitcoin, if communicated by the
903
- customer.
925
+ description: ''
904
926
  type:
905
927
  - string
906
928
  transactions:
@@ -916,7 +938,8 @@ definitions:
916
938
  type:
917
939
  - boolean
918
940
  object:
919
- description: The type of object. Always has the value "list".
941
+ description: String representing the object's type. Objects of the same
942
+ type share the same value. Always has the value "list".
920
943
  enum:
921
944
  - list
922
945
  type:
@@ -980,19 +1003,22 @@ definitions:
980
1003
  type:
981
1004
  - integer
982
1005
  created:
983
- description: ''
1006
+ description: Time at which the object was created. Measured in seconds since
1007
+ the Unix epoch.
984
1008
  type:
985
1009
  - integer
986
1010
  currency:
987
- description: The currency to which this transaction was converted.
1011
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
1012
+ to which this transaction was converted.
988
1013
  type:
989
1014
  - string
990
1015
  id:
991
- description: ''
1016
+ description: Unique identifier for the object.
992
1017
  type:
993
1018
  - string
994
1019
  object:
995
- description: ''
1020
+ description: String representing the object's type. Objects of the same type
1021
+ share the same value.
996
1022
  type:
997
1023
  - string
998
1024
  receiver:
@@ -1019,7 +1045,7 @@ definitions:
1019
1045
  type:
1020
1046
  - string
1021
1047
  address_city:
1022
- description: ''
1048
+ description: City/District/Suburb/Town/Village.
1023
1049
  type:
1024
1050
  - string
1025
1051
  address_country:
@@ -1027,7 +1053,7 @@ definitions:
1027
1053
  type:
1028
1054
  - string
1029
1055
  address_line1:
1030
- description: ''
1056
+ description: Address line 1 (Street address/PO Box/Company name).
1031
1057
  type:
1032
1058
  - string
1033
1059
  address_line1_check:
@@ -1036,15 +1062,15 @@ definitions:
1036
1062
  type:
1037
1063
  - string
1038
1064
  address_line2:
1039
- description: ''
1065
+ description: Address line 2 (Apartment/Suite/Unit/Building).
1040
1066
  type:
1041
1067
  - string
1042
1068
  address_state:
1043
- description: ''
1069
+ description: State/County/Province/Region.
1044
1070
  type:
1045
1071
  - string
1046
1072
  address_zip:
1047
- description: ''
1073
+ description: Zip/Postal Code.
1048
1074
  type:
1049
1075
  - string
1050
1076
  address_zip_check:
@@ -1070,8 +1096,9 @@ definitions:
1070
1096
  type:
1071
1097
  - string
1072
1098
  currency:
1073
- description: Only applicable on accounts (not customers or recipients). The
1074
- card can be used as a transfer destination for funds in this currency.
1099
+ description: Three-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
1100
+ Only applicable on accounts (not customers or recipients). The card can
1101
+ be used as a transfer destination for funds in this currency.
1075
1102
  type:
1076
1103
  - string
1077
1104
  customer:
@@ -1100,11 +1127,11 @@ definitions:
1100
1127
  type:
1101
1128
  - string
1102
1129
  exp_month:
1103
- description: ''
1130
+ description: Two digit number representing the card's expiration month.
1104
1131
  type:
1105
1132
  - integer
1106
1133
  exp_year:
1107
- description: ''
1134
+ description: Four digit number representing the card's expiration year.
1108
1135
  type:
1109
1136
  - integer
1110
1137
  fingerprint:
@@ -1122,18 +1149,17 @@ definitions:
1122
1149
  type:
1123
1150
  - string
1124
1151
  id:
1125
- description: ID of card (used in conjunction with a customer or recipient
1126
- ID).
1152
+ description: Unique identifier for the object.
1127
1153
  type:
1128
1154
  - string
1129
1155
  last4:
1130
- description: ''
1156
+ description: The last 4 digits of the card.
1131
1157
  type:
1132
1158
  - string
1133
1159
  metadata:
1134
- description: A set of key/value pairs that you can attach to a card object.
1135
- It can be useful for storing additional information about the card in a
1136
- structured format.
1160
+ description: Set of key/value pairs that you can attach to an object. It can
1161
+ be useful for storing additional information about the object in a structured
1162
+ format.
1137
1163
  type:
1138
1164
  - object
1139
1165
  name:
@@ -1141,7 +1167,8 @@ definitions:
1141
1167
  type:
1142
1168
  - string
1143
1169
  object:
1144
- description: ''
1170
+ description: String representing the object's type. Objects of the same type
1171
+ share the same value.
1145
1172
  type:
1146
1173
  - string
1147
1174
  recipient:
@@ -1223,12 +1250,13 @@ definitions:
1223
1250
  card:
1224
1251
  "$ref": "#/definitions/card"
1225
1252
  created:
1226
- description: ''
1253
+ description: Time at which the object was created. Measured in seconds since
1254
+ the Unix epoch.
1227
1255
  type:
1228
1256
  - integer
1229
1257
  currency:
1230
- description: Three-letter ISO currency code representing the currency in which
1231
- the charge was made.
1258
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
1259
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
1232
1260
  type:
1233
1261
  - string
1234
1262
  customer:
@@ -1236,7 +1264,8 @@ definitions:
1236
1264
  type:
1237
1265
  - string
1238
1266
  description:
1239
- description: ''
1267
+ description: An arbitrary string attached to the object. Often useful for
1268
+ displaying to users.
1240
1269
  type:
1241
1270
  - string
1242
1271
  destination:
@@ -1267,7 +1296,7 @@ definitions:
1267
1296
  type:
1268
1297
  - object
1269
1298
  id:
1270
- description: ''
1299
+ description: Unique identifier for the object.
1271
1300
  type:
1272
1301
  - string
1273
1302
  invoice:
@@ -1275,17 +1304,19 @@ definitions:
1275
1304
  type:
1276
1305
  - string
1277
1306
  livemode:
1278
- description: ''
1307
+ description: Flag indicating whether the object exists in live mode or test
1308
+ mode.
1279
1309
  type:
1280
1310
  - boolean
1281
1311
  metadata:
1282
- description: A set of key/value pairs that you can attach to a charge object.
1283
- It can be useful for storing additional information about the charge in
1284
- a structured format.
1312
+ description: Set of key/value pairs that you can attach to an object. It can
1313
+ be useful for storing additional information about the object in a structured
1314
+ format.
1285
1315
  type:
1286
1316
  - object
1287
1317
  object:
1288
- description: ''
1318
+ description: String representing the object's type. Objects of the same type
1319
+ share the same value.
1289
1320
  type:
1290
1321
  - string
1291
1322
  on_behalf_of:
@@ -1333,7 +1364,8 @@ definitions:
1333
1364
  type:
1334
1365
  - boolean
1335
1366
  object:
1336
- description: The type of object. Always has the value "list".
1367
+ description: String representing the object's type. Objects of the same
1368
+ type share the same value. Always has the value "list".
1337
1369
  enum:
1338
1370
  - list
1339
1371
  type:
@@ -1459,11 +1491,13 @@ definitions:
1459
1491
  type:
1460
1492
  - string
1461
1493
  id:
1462
- description: The ISO Country code for this country.
1494
+ description: Unique identifier for the object. Represented as the ISO country
1495
+ code for this country.
1463
1496
  type:
1464
1497
  - string
1465
1498
  object:
1466
- description: ''
1499
+ description: String representing the object's type. Objects of the same type
1500
+ share the same value.
1467
1501
  type:
1468
1502
  - string
1469
1503
  supported_bank_account_currencies:
@@ -1510,12 +1544,14 @@ definitions:
1510
1544
  type:
1511
1545
  - integer
1512
1546
  created:
1513
- description: ''
1547
+ description: Time at which the object was created. Measured in seconds since
1548
+ the Unix epoch.
1514
1549
  type:
1515
1550
  - integer
1516
1551
  currency:
1517
- description: If `amount_off` has been set, the currency of the amount to take
1518
- off.
1552
+ description: If `amount_off` has been set, the three-letter [ISO code for
1553
+ the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
1554
+ of the amount to take off.
1519
1555
  type:
1520
1556
  - string
1521
1557
  duration:
@@ -1529,11 +1565,12 @@ definitions:
1529
1565
  type:
1530
1566
  - integer
1531
1567
  id:
1532
- description: ''
1568
+ description: Unique identifier for the object.
1533
1569
  type:
1534
1570
  - string
1535
1571
  livemode:
1536
- description: ''
1572
+ description: Flag indicating whether the object exists in live mode or test
1573
+ mode.
1537
1574
  type:
1538
1575
  - boolean
1539
1576
  max_redemptions:
@@ -1542,13 +1579,14 @@ definitions:
1542
1579
  type:
1543
1580
  - integer
1544
1581
  metadata:
1545
- description: A set of key/value pairs that you can attach to a coupon object.
1546
- It can be useful for storing additional information about the coupon in
1547
- a structured format.
1582
+ description: Set of key/value pairs that you can attach to an object. It can
1583
+ be useful for storing additional information about the object in a structured
1584
+ format.
1548
1585
  type:
1549
1586
  - object
1550
1587
  object:
1551
- description: ''
1588
+ description: String representing the object's type. Objects of the same type
1589
+ share the same value.
1552
1590
  type:
1553
1591
  - string
1554
1592
  percent_off:
@@ -1608,7 +1646,8 @@ definitions:
1608
1646
  type:
1609
1647
  - boolean
1610
1648
  object:
1611
- description: The type of object. Always has the value "list".
1649
+ description: String representing the object's type. Objects of the same
1650
+ type share the same value. Always has the value "list".
1612
1651
  enum:
1613
1652
  - list
1614
1653
  type:
@@ -1643,7 +1682,8 @@ definitions:
1643
1682
  type:
1644
1683
  - boolean
1645
1684
  object:
1646
- description: The type of object. Always has the value "list".
1685
+ description: String representing the object's type. Objects of the same
1686
+ type share the same value. Always has the value "list".
1647
1687
  enum:
1648
1688
  - list
1649
1689
  type:
@@ -1682,7 +1722,8 @@ definitions:
1682
1722
  type:
1683
1723
  - boolean
1684
1724
  object:
1685
- description: The type of object. Always has the value "list".
1725
+ description: String representing the object's type. Objects of the same
1726
+ type share the same value. Always has the value "list".
1686
1727
  enum:
1687
1728
  - list
1688
1729
  type:
@@ -1705,12 +1746,13 @@ definitions:
1705
1746
  type:
1706
1747
  - object
1707
1748
  created:
1708
- description: ''
1749
+ description: Time at which the object was created. Measured in seconds since
1750
+ the Unix epoch.
1709
1751
  type:
1710
1752
  - integer
1711
1753
  currency:
1712
- description: The currency the customer can be charged in for recurring billing
1713
- purposes.
1754
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
1755
+ the customer can be charged in for recurring billing purposes.
1714
1756
  type:
1715
1757
  - string
1716
1758
  default_bank_account:
@@ -1731,31 +1773,34 @@ definitions:
1731
1773
  type:
1732
1774
  - boolean
1733
1775
  description:
1734
- description: ''
1776
+ description: An arbitrary string attached to the object. Often useful for
1777
+ displaying to users.
1735
1778
  type:
1736
1779
  - string
1737
1780
  discount:
1738
1781
  "$ref": "#/definitions/discount"
1739
1782
  email:
1740
- description: ''
1783
+ description: The customer's email address.
1741
1784
  type:
1742
1785
  - string
1743
1786
  id:
1744
- description: ''
1787
+ description: Unique identifier for the object.
1745
1788
  type:
1746
1789
  - string
1747
1790
  livemode:
1748
- description: ''
1791
+ description: Flag indicating whether the object exists in live mode or test
1792
+ mode.
1749
1793
  type:
1750
1794
  - boolean
1751
1795
  metadata:
1752
- description: A set of key/value pairs that you can attach to a customer object.
1753
- It can be useful for storing additional information about the customer in
1754
- a structured format.
1796
+ description: Set of key/value pairs that you can attach to an object. It can
1797
+ be useful for storing additional information about the object in a structured
1798
+ format.
1755
1799
  type:
1756
1800
  - object
1757
1801
  object:
1758
- description: ''
1802
+ description: String representing the object's type. Objects of the same type
1803
+ share the same value.
1759
1804
  type:
1760
1805
  - string
1761
1806
  shipping:
@@ -1774,7 +1819,8 @@ definitions:
1774
1819
  type:
1775
1820
  - boolean
1776
1821
  object:
1777
- description: The type of object. Always has the value "list".
1822
+ description: String representing the object's type. Objects of the same
1823
+ type share the same value. Always has the value "list".
1778
1824
  enum:
1779
1825
  - list
1780
1826
  type:
@@ -1809,7 +1855,8 @@ definitions:
1809
1855
  type:
1810
1856
  - boolean
1811
1857
  object:
1812
- description: The type of object. Always has the value "list".
1858
+ description: String representing the object's type. Objects of the same
1859
+ type share the same value. Always has the value "list".
1813
1860
  enum:
1814
1861
  - list
1815
1862
  type:
@@ -1871,17 +1918,18 @@ definitions:
1871
1918
  type:
1872
1919
  - string
1873
1920
  id:
1874
- description: ''
1921
+ description: Unique identifier for the object.
1875
1922
  type:
1876
1923
  - string
1877
1924
  metadata:
1878
- description: A set of key/value pairs that you can attach to a bank account
1879
- object. It can be useful for storing additional information about the bank
1880
- account in a structured format.
1925
+ description: Set of key/value pairs that you can attach to an object. It can
1926
+ be useful for storing additional information about the object in a structured
1927
+ format.
1881
1928
  type:
1882
1929
  - object
1883
1930
  object:
1884
- description: ''
1931
+ description: String representing the object's type. Objects of the same type
1932
+ share the same value.
1885
1933
  type:
1886
1934
  - string
1887
1935
  required:
@@ -1933,7 +1981,8 @@ definitions:
1933
1981
  type:
1934
1982
  - integer
1935
1983
  object:
1936
- description: ''
1984
+ description: String representing the object's type. Objects of the same type
1985
+ share the same value.
1937
1986
  type:
1938
1987
  - string
1939
1988
  start:
@@ -1968,12 +2017,13 @@ definitions:
1968
2017
  type:
1969
2018
  - string
1970
2019
  created:
1971
- description: Date dispute was opened.
2020
+ description: Time at which the object was created. Measured in seconds since
2021
+ the Unix epoch.
1972
2022
  type:
1973
2023
  - integer
1974
2024
  currency:
1975
- description: Three-letter ISO currency code representing the currency of the
1976
- amount that was disputed.
2025
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2026
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
1977
2027
  type:
1978
2028
  - string
1979
2029
  evidence:
@@ -1986,7 +2036,7 @@ definitions:
1986
2036
  type:
1987
2037
  - object
1988
2038
  id:
1989
- description: ''
2039
+ description: Unique identifier for the object.
1990
2040
  type:
1991
2041
  - string
1992
2042
  is_charge_refundable:
@@ -1996,17 +2046,19 @@ definitions:
1996
2046
  type:
1997
2047
  - boolean
1998
2048
  livemode:
1999
- description: ''
2049
+ description: Flag indicating whether the object exists in live mode or test
2050
+ mode.
2000
2051
  type:
2001
2052
  - boolean
2002
2053
  metadata:
2003
- description: A set of key/value pairs that you can attach to a dispute object.
2004
- It can be useful for storing additional information about the dispute in
2005
- a structured format.
2054
+ description: Set of key/value pairs that you can attach to an object. It can
2055
+ be useful for storing additional information about the object in a structured
2056
+ format.
2006
2057
  type:
2007
2058
  - object
2008
2059
  object:
2009
- description: ''
2060
+ description: String representing the object's type. Objects of the same type
2061
+ share the same value.
2010
2062
  type:
2011
2063
  - string
2012
2064
  reason:
@@ -2092,21 +2144,24 @@ definitions:
2092
2144
  type:
2093
2145
  - string
2094
2146
  created:
2095
- description: ''
2147
+ description: Time at which the object was created. Measured in seconds since
2148
+ the Unix epoch.
2096
2149
  type:
2097
2150
  - integer
2098
2151
  data:
2099
2152
  "$ref": "#/definitions/event_data"
2100
2153
  id:
2101
- description: ''
2154
+ description: Unique identifier for the object.
2102
2155
  type:
2103
2156
  - string
2104
2157
  livemode:
2105
- description: ''
2158
+ description: Flag indicating whether the object exists in live mode or test
2159
+ mode.
2106
2160
  type:
2107
2161
  - boolean
2108
2162
  object:
2109
- description: ''
2163
+ description: String representing the object's type. Objects of the same type
2164
+ share the same value.
2110
2165
  type:
2111
2166
  - string
2112
2167
  pending_webhooks:
@@ -2142,8 +2197,9 @@ definitions:
2142
2197
  event_data:
2143
2198
  properties:
2144
2199
  object:
2145
- description: describes the object the event is about. For example, an `invoice.created`
2146
- event will have a full invoice object as the value of the object key.
2200
+ description: Static string describing the type of the object described by
2201
+ this change. For example, an `invoice.created` event will have a full invoice
2202
+ object as the value of the object key.
2147
2203
  type:
2148
2204
  - object
2149
2205
  previous_attributes:
@@ -2189,8 +2245,8 @@ definitions:
2189
2245
  type:
2190
2246
  - string
2191
2247
  currency:
2192
- description: Three-letter ISO currency code representing the currency paid
2193
- out to the bank account.
2248
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
2249
+ paid out to the bank account.
2194
2250
  type:
2195
2251
  - string
2196
2252
  customer:
@@ -2208,7 +2264,7 @@ definitions:
2208
2264
  type:
2209
2265
  - string
2210
2266
  id:
2211
- description: ''
2267
+ description: Unique identifier for the object.
2212
2268
  type:
2213
2269
  - string
2214
2270
  last4:
@@ -2216,13 +2272,14 @@ definitions:
2216
2272
  type:
2217
2273
  - string
2218
2274
  metadata:
2219
- description: A set of key/value pairs that you can attach to a bank account
2220
- object. It can be useful for storing additional information about the bank
2221
- account in a structured format.
2275
+ description: Set of key/value pairs that you can attach to an object. It can
2276
+ be useful for storing additional information about the object in a structured
2277
+ format.
2222
2278
  type:
2223
2279
  - object
2224
2280
  object:
2225
- description: ''
2281
+ description: String representing the object's type. Objects of the same type
2282
+ share the same value.
2226
2283
  type:
2227
2284
  - string
2228
2285
  required:
@@ -2238,7 +2295,7 @@ definitions:
2238
2295
  fee:
2239
2296
  properties:
2240
2297
  amount:
2241
- description: ''
2298
+ description: Amount of the fee, in cents.
2242
2299
  type:
2243
2300
  - integer
2244
2301
  application:
@@ -2246,11 +2303,13 @@ definitions:
2246
2303
  type:
2247
2304
  - string
2248
2305
  currency:
2249
- description: ''
2306
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2307
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
2250
2308
  type:
2251
2309
  - string
2252
2310
  description:
2253
- description: ''
2311
+ description: An arbitrary string attached to the object. Often useful for
2312
+ displaying to users.
2254
2313
  type:
2255
2314
  - string
2256
2315
  type:
@@ -2278,11 +2337,13 @@ definitions:
2278
2337
  type:
2279
2338
  - string
2280
2339
  created:
2281
- description: ''
2340
+ description: Time at which the object was created. Measured in seconds since
2341
+ the Unix epoch.
2282
2342
  type:
2283
2343
  - integer
2284
2344
  currency:
2285
- description: Three-letter ISO code representing the currency.
2345
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2346
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
2286
2347
  type:
2287
2348
  - string
2288
2349
  fee:
@@ -2290,16 +2351,18 @@ definitions:
2290
2351
  type:
2291
2352
  - string
2292
2353
  id:
2293
- description: ''
2354
+ description: Unique identifier for the object.
2294
2355
  type:
2295
2356
  - string
2296
2357
  metadata:
2297
- description: A set of key/value pairs that you can attach to the object. It
2298
- can be useful for storing additional information in a structured format.
2358
+ description: Set of key/value pairs that you can attach to an object. It can
2359
+ be useful for storing additional information about the object in a structured
2360
+ format.
2299
2361
  type:
2300
2362
  - object
2301
2363
  object:
2302
- description: ''
2364
+ description: String representing the object's type. Objects of the same type
2365
+ share the same value.
2303
2366
  type:
2304
2367
  - string
2305
2368
  required:
@@ -2388,7 +2451,8 @@ definitions:
2388
2451
  type:
2389
2452
  - boolean
2390
2453
  currency:
2391
- description: ''
2454
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2455
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
2392
2456
  type:
2393
2457
  - string
2394
2458
  customer:
@@ -2396,11 +2460,13 @@ definitions:
2396
2460
  type:
2397
2461
  - string
2398
2462
  date:
2399
- description: ''
2463
+ description: Time at which the object was created. Measured in seconds since
2464
+ the Unix epoch.
2400
2465
  type:
2401
2466
  - integer
2402
2467
  description:
2403
- description: ''
2468
+ description: An arbitrary string attached to the object. Often useful for
2469
+ displaying to users.
2404
2470
  type:
2405
2471
  - string
2406
2472
  discount:
@@ -2421,7 +2487,7 @@ definitions:
2421
2487
  type:
2422
2488
  - boolean
2423
2489
  id:
2424
- description: ''
2490
+ description: Unique identifier for the object.
2425
2491
  type:
2426
2492
  - string
2427
2493
  lines:
@@ -2437,7 +2503,8 @@ definitions:
2437
2503
  type:
2438
2504
  - boolean
2439
2505
  object:
2440
- description: The type of object. Always has the value "list".
2506
+ description: String representing the object's type. Objects of the same
2507
+ type share the same value. Always has the value "list".
2441
2508
  enum:
2442
2509
  - list
2443
2510
  type:
@@ -2460,13 +2527,14 @@ definitions:
2460
2527
  type:
2461
2528
  - object
2462
2529
  livemode:
2463
- description: ''
2530
+ description: Flag indicating whether the object exists in live mode or test
2531
+ mode.
2464
2532
  type:
2465
2533
  - boolean
2466
2534
  metadata:
2467
- description: A set of key/value pairs that you can attach to an invoice object.
2468
- It can be useful for storing additional information about the invoice in
2469
- a structured format.
2535
+ description: Set of key/value pairs that you can attach to an object. It can
2536
+ be useful for storing additional information about the object in a structured
2537
+ format.
2470
2538
  type:
2471
2539
  - object
2472
2540
  next_payment_attempt:
@@ -2479,7 +2547,8 @@ definitions:
2479
2547
  type:
2480
2548
  - string
2481
2549
  object:
2482
- description: ''
2550
+ description: String representing the object's type. Objects of the same type
2551
+ share the same value.
2483
2552
  type:
2484
2553
  - string
2485
2554
  paid:
@@ -2577,15 +2646,17 @@ definitions:
2577
2646
  invoice_item:
2578
2647
  properties:
2579
2648
  amount:
2580
- description: ''
2649
+ description: Amount (in the `currency` specified) of the invoice item.
2581
2650
  type:
2582
2651
  - integer
2583
2652
  currency:
2584
- description: ''
2653
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2654
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
2585
2655
  type:
2586
2656
  - string
2587
2657
  customer:
2588
- description: ''
2658
+ description: The ID of the customer who will be billed when this invoice item
2659
+ is billed.
2589
2660
  type:
2590
2661
  - string
2591
2662
  date:
@@ -2593,7 +2664,8 @@ definitions:
2593
2664
  type:
2594
2665
  - integer
2595
2666
  description:
2596
- description: ''
2667
+ description: An arbitrary string attached to the object. Often useful for
2668
+ displaying to users.
2597
2669
  type:
2598
2670
  - string
2599
2671
  discountable:
@@ -2602,25 +2674,27 @@ definitions:
2602
2674
  type:
2603
2675
  - boolean
2604
2676
  id:
2605
- description: ''
2677
+ description: Unique identifier for the object.
2606
2678
  type:
2607
2679
  - string
2608
2680
  invoice:
2609
- description: ''
2681
+ description: The ID of the invoice this invoice item belongs to.
2610
2682
  type:
2611
2683
  - string
2612
2684
  livemode:
2613
- description: ''
2685
+ description: Flag indicating whether the object exists in live mode or test
2686
+ mode.
2614
2687
  type:
2615
2688
  - boolean
2616
2689
  metadata:
2617
- description: A set of key/value pairs that you can attach to an invoice item
2618
- object. It can be useful for storing additional information about the invoice
2619
- item in a structured format.
2690
+ description: Set of key/value pairs that you can attach to an object. It can
2691
+ be useful for storing additional information about the object in a structured
2692
+ format.
2620
2693
  type:
2621
2694
  - object
2622
2695
  object:
2623
- description: ''
2696
+ description: String representing the object's type. Objects of the same type
2697
+ share the same value.
2624
2698
  type:
2625
2699
  - string
2626
2700
  period:
@@ -2670,12 +2744,13 @@ definitions:
2670
2744
  type:
2671
2745
  - integer
2672
2746
  currency:
2673
- description: ''
2747
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2748
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
2674
2749
  type:
2675
2750
  - string
2676
2751
  description:
2677
- description: A text description of the line item, if the line item is an invoice
2678
- item.
2752
+ description: An arbitrary string attached to the object. Often useful for
2753
+ displaying to users.
2679
2754
  type:
2680
2755
  - string
2681
2756
  discountable:
@@ -2684,8 +2759,7 @@ definitions:
2684
2759
  type:
2685
2760
  - boolean
2686
2761
  id:
2687
- description: The ID of the source of this line item, either an invoice item
2688
- or a subscription.
2762
+ description: Unique identifier for the object.
2689
2763
  type:
2690
2764
  - string
2691
2765
  livemode:
@@ -2693,12 +2767,14 @@ definitions:
2693
2767
  type:
2694
2768
  - boolean
2695
2769
  metadata:
2696
- description: Key-value pairs attached to object that underlies this line item
2697
- (either subscription or invoice item).
2770
+ description: Set of key/value pairs that you can attach to an object. It can
2771
+ be useful for storing additional information about the object in a structured
2772
+ format.
2698
2773
  type:
2699
2774
  - object
2700
2775
  object:
2701
- description: The type of object. Always has the value "line_item".
2776
+ description: String representing the object's type. Objects of the same type
2777
+ share the same value.
2702
2778
  type:
2703
2779
  - string
2704
2780
  period:
@@ -2771,11 +2847,13 @@ definitions:
2771
2847
  type:
2772
2848
  - string
2773
2849
  created:
2774
- description: Time that this record of the transfer was first created.
2850
+ description: Time at which the object was created. Measured in seconds since
2851
+ the Unix epoch.
2775
2852
  type:
2776
2853
  - integer
2777
2854
  currency:
2778
- description: ''
2855
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
2856
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
2779
2857
  type:
2780
2858
  - string
2781
2859
  date:
@@ -2809,7 +2887,7 @@ definitions:
2809
2887
  type:
2810
2888
  - string
2811
2889
  id:
2812
- description: ''
2890
+ description: Unique identifier for the object.
2813
2891
  type:
2814
2892
  - string
2815
2893
  legacy_date:
@@ -2817,13 +2895,14 @@ definitions:
2817
2895
  type:
2818
2896
  - integer
2819
2897
  livemode:
2820
- description: ''
2898
+ description: Flag indicating whether the object exists in live mode or test
2899
+ mode.
2821
2900
  type:
2822
2901
  - boolean
2823
2902
  metadata:
2824
- description: A set of key/value pairs that you can attach to a transfer object.
2825
- It can be useful for storing additional information about the transfer in
2826
- a structured format.
2903
+ description: Set of key/value pairs that you can attach to an object. It can
2904
+ be useful for storing additional information about the object in a structured
2905
+ format.
2827
2906
  type:
2828
2907
  - object
2829
2908
  method:
@@ -2834,7 +2913,8 @@ definitions:
2834
2913
  type:
2835
2914
  - string
2836
2915
  object:
2837
- description: ''
2916
+ description: String representing the object's type. Objects of the same type
2917
+ share the same value.
2838
2918
  type:
2839
2919
  - string
2840
2920
  reversals:
@@ -2850,7 +2930,8 @@ definitions:
2850
2930
  type:
2851
2931
  - boolean
2852
2932
  object:
2853
- description: The type of object. Always has the value "list".
2933
+ description: String representing the object's type. Objects of the same
2934
+ type share the same value. Always has the value "list".
2854
2935
  enum:
2855
2936
  - list
2856
2937
  type:
@@ -3203,12 +3284,13 @@ definitions:
3203
3284
  type:
3204
3285
  - string
3205
3286
  created:
3206
- description: ''
3287
+ description: Time at which the object was created. Measured in seconds since
3288
+ the Unix epoch.
3207
3289
  type:
3208
3290
  - integer
3209
3291
  currency:
3210
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
3211
- representing the currency in which the order was made.
3292
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
3293
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3212
3294
  type:
3213
3295
  - string
3214
3296
  customer:
@@ -3224,23 +3306,25 @@ definitions:
3224
3306
  type:
3225
3307
  - string
3226
3308
  id:
3227
- description: ''
3309
+ description: Unique identifier for the object.
3228
3310
  type:
3229
3311
  - string
3230
3312
  items:
3231
3313
  "$ref": "#/definitions/order_item"
3232
3314
  livemode:
3233
- description: ''
3315
+ description: Flag indicating whether the object exists in live mode or test
3316
+ mode.
3234
3317
  type:
3235
3318
  - boolean
3236
3319
  metadata:
3237
- description: A set of key/value pairs that you can attach to an order object.
3238
- It can be useful for storing additional information about the order in a
3239
- structured format.
3320
+ description: Set of key/value pairs that you can attach to an object. It can
3321
+ be useful for storing additional information about the object in a structured
3322
+ format.
3240
3323
  type:
3241
3324
  - object
3242
3325
  object:
3243
- description: ''
3326
+ description: String representing the object's type. Objects of the same type
3327
+ share the same value.
3244
3328
  type:
3245
3329
  - string
3246
3330
  returns:
@@ -3256,7 +3340,8 @@ definitions:
3256
3340
  type:
3257
3341
  - boolean
3258
3342
  object:
3259
- description: The type of object. Always has the value "list".
3343
+ description: String representing the object's type. Objects of the same
3344
+ type share the same value. Always has the value "list".
3260
3345
  enum:
3261
3346
  - list
3262
3347
  type:
@@ -3328,8 +3413,8 @@ definitions:
3328
3413
  type:
3329
3414
  - integer
3330
3415
  currency:
3331
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
3332
- representing the currency of the line item.
3416
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
3417
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3333
3418
  type:
3334
3419
  - string
3335
3420
  description:
@@ -3338,7 +3423,8 @@ definitions:
3338
3423
  type:
3339
3424
  - string
3340
3425
  object:
3341
- description: ''
3426
+ description: String representing the object's type. Objects of the same type
3427
+ share the same value.
3342
3428
  type:
3343
3429
  - string
3344
3430
  parent:
@@ -3391,26 +3477,29 @@ definitions:
3391
3477
  type:
3392
3478
  - integer
3393
3479
  created:
3394
- description: ''
3480
+ description: Time at which the object was created. Measured in seconds since
3481
+ the Unix epoch.
3395
3482
  type:
3396
3483
  - integer
3397
3484
  currency:
3398
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
3399
- representing the currency of the return.
3485
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
3486
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3400
3487
  type:
3401
3488
  - string
3402
3489
  id:
3403
- description: ''
3490
+ description: Unique identifier for the object.
3404
3491
  type:
3405
3492
  - string
3406
3493
  items:
3407
3494
  "$ref": "#/definitions/order_item"
3408
3495
  livemode:
3409
- description: ''
3496
+ description: Flag indicating whether the object exists in live mode or test
3497
+ mode.
3410
3498
  type:
3411
3499
  - boolean
3412
3500
  object:
3413
- description: ''
3501
+ description: String representing the object's type. Objects of the same type
3502
+ share the same value.
3414
3503
  type:
3415
3504
  - string
3416
3505
  order:
@@ -3460,6 +3549,121 @@ definitions:
3460
3549
  type:
3461
3550
  - object
3462
3551
  x-resourceId: package_dimensions
3552
+ payout:
3553
+ properties:
3554
+ amount:
3555
+ description: Amount (in %s) to be transferred to your bank account or debit
3556
+ card.
3557
+ type:
3558
+ - integer
3559
+ arrival_date:
3560
+ description: Date the payout is expected to arrive in the bank. This factors
3561
+ in delays like weekends or bank holidays.
3562
+ type:
3563
+ - integer
3564
+ balance_transaction:
3565
+ description: ID of the balance transaction that describes the impact of this
3566
+ payout on your account balance.
3567
+ type:
3568
+ - string
3569
+ created:
3570
+ description: Time at which the object was created. Measured in seconds since
3571
+ the Unix epoch.
3572
+ type:
3573
+ - integer
3574
+ currency:
3575
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
3576
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3577
+ type:
3578
+ - string
3579
+ destination:
3580
+ description: ID of the bank account or card the payout was sent to.
3581
+ type:
3582
+ - string
3583
+ failure_balance_transaction:
3584
+ description: If the payout failed or was canceled, this will be the ID of
3585
+ the balance transaction that reversed the initial balance transaction, and
3586
+ puts the funds from the failed payout back in your balance.
3587
+ type:
3588
+ - string
3589
+ failure_code:
3590
+ description: Error code explaining reason for payout failure if available.
3591
+ See [Types of payout failures](/docs/api#payout_failures) for a list of
3592
+ failure codes.
3593
+ type:
3594
+ - string
3595
+ failure_message:
3596
+ description: Message to user further explaining reason for payout failure
3597
+ if available.
3598
+ type:
3599
+ - string
3600
+ id:
3601
+ description: Unique identifier for the object.
3602
+ type:
3603
+ - string
3604
+ livemode:
3605
+ description: Flag indicating whether the object exists in live mode or test
3606
+ mode.
3607
+ type:
3608
+ - boolean
3609
+ metadata:
3610
+ description: Set of key/value pairs that you can attach to an object. It can
3611
+ be useful for storing additional information about the object in a structured
3612
+ format.
3613
+ type:
3614
+ - object
3615
+ method:
3616
+ description: The method used to send this payout, which can be `standard`
3617
+ or `instant`. `instant` is only supported for payouts to debit cards. (See
3618
+ [Instant payouts for marketplaces](/blog/instant-payouts-for-marketplaces)
3619
+ for more information.)
3620
+ type:
3621
+ - string
3622
+ object:
3623
+ description: String representing the object's type. Objects of the same type
3624
+ share the same value.
3625
+ type:
3626
+ - string
3627
+ source_type:
3628
+ description: The source balance this payout came from. One of `card`, `bank_account`,
3629
+ `bitcoin_receiver`, or `alipay_account`.
3630
+ type:
3631
+ - string
3632
+ statement_descriptor:
3633
+ description: Extra information about a payout to be displayed on the user's
3634
+ bank statement.
3635
+ type:
3636
+ - string
3637
+ status:
3638
+ description: Current status of the payout (`paid`, `pending`, `in_transit`,
3639
+ `canceled` or `failed`). A payout will be `pending` until it is submitted
3640
+ to the bank, at which point it becomes `in_transit`. It will then change
3641
+ to `paid` if the transaction goes through. If it does not go through successfully,
3642
+ its status will change to `failed` or `canceled`.
3643
+ type:
3644
+ - string
3645
+ type:
3646
+ description: Can be `bank_account` or `card`.
3647
+ type:
3648
+ - string
3649
+ required:
3650
+ - amount
3651
+ - arrival_date
3652
+ - created
3653
+ - currency
3654
+ - destination
3655
+ - id
3656
+ - livemode
3657
+ - metadata
3658
+ - method
3659
+ - object
3660
+ - source_type
3661
+ - status
3662
+ - type
3663
+ title: Payout
3664
+ type:
3665
+ - object
3666
+ x-resourceId: payout
3463
3667
  plan:
3464
3668
  properties:
3465
3669
  amount:
@@ -3467,15 +3671,17 @@ definitions:
3467
3671
  type:
3468
3672
  - integer
3469
3673
  created:
3470
- description: ''
3674
+ description: Time at which the object was created. Measured in seconds since
3675
+ the Unix epoch.
3471
3676
  type:
3472
3677
  - integer
3473
3678
  currency:
3474
- description: Currency in which subscription will be charged.
3679
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
3680
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3475
3681
  type:
3476
3682
  - string
3477
3683
  id:
3478
- description: ''
3684
+ description: Unique identifier for the object.
3479
3685
  type:
3480
3686
  - string
3481
3687
  interval:
@@ -3490,13 +3696,14 @@ definitions:
3490
3696
  type:
3491
3697
  - integer
3492
3698
  livemode:
3493
- description: ''
3699
+ description: Flag indicating whether the object exists in live mode or test
3700
+ mode.
3494
3701
  type:
3495
3702
  - boolean
3496
3703
  metadata:
3497
- description: A set of key/value pairs that you can attach to a plan object.
3498
- It can be useful for storing additional information about the plan in a
3499
- structured format.
3704
+ description: Set of key/value pairs that you can attach to an object. It can
3705
+ be useful for storing additional information about the object in a structured
3706
+ format.
3500
3707
  type:
3501
3708
  - object
3502
3709
  name:
@@ -3504,7 +3711,8 @@ definitions:
3504
3711
  type:
3505
3712
  - string
3506
3713
  object:
3507
- description: ''
3714
+ description: String representing the object's type. Objects of the same type
3715
+ share the same value.
3508
3716
  type:
3509
3717
  - string
3510
3718
  statement_descriptor:
@@ -3561,23 +3769,27 @@ definitions:
3561
3769
  type:
3562
3770
  - string
3563
3771
  created:
3564
- description: ''
3772
+ description: Time at which the object was created. Measured in seconds since
3773
+ the Unix epoch.
3565
3774
  type:
3566
3775
  - integer
3567
3776
  currency:
3568
- description: Three-letter ISO code representing the currency of the charge.
3777
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
3778
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3569
3779
  type:
3570
3780
  - string
3571
3781
  id:
3572
- description: ''
3782
+ description: Unique identifier for the object.
3573
3783
  type:
3574
3784
  - string
3575
3785
  livemode:
3576
- description: ''
3786
+ description: Flag indicating whether the object exists in live mode or test
3787
+ mode.
3577
3788
  type:
3578
3789
  - boolean
3579
3790
  object:
3580
- description: ''
3791
+ description: String representing the object's type. Objects of the same type
3792
+ share the same value.
3581
3793
  type:
3582
3794
  - string
3583
3795
  originating_transaction:
@@ -3603,7 +3815,8 @@ definitions:
3603
3815
  type:
3604
3816
  - boolean
3605
3817
  object:
3606
- description: The type of object. Always has the value "list".
3818
+ description: String representing the object's type. Objects of the same
3819
+ type share the same value. Always has the value "list".
3607
3820
  enum:
3608
3821
  - list
3609
3822
  type:
@@ -3660,7 +3873,8 @@ definitions:
3660
3873
  type:
3661
3874
  - string
3662
3875
  created:
3663
- description: ''
3876
+ description: Time at which the object was created. Measured in seconds since
3877
+ the Unix epoch.
3664
3878
  type:
3665
3879
  - integer
3666
3880
  deactivate_on:
@@ -3673,7 +3887,7 @@ definitions:
3673
3887
  type:
3674
3888
  - string
3675
3889
  id:
3676
- description: ''
3890
+ description: Unique identifier for the object.
3677
3891
  type:
3678
3892
  - string
3679
3893
  images:
@@ -3682,13 +3896,14 @@ definitions:
3682
3896
  type:
3683
3897
  - array
3684
3898
  livemode:
3685
- description: ''
3899
+ description: Flag indicating whether the object exists in live mode or test
3900
+ mode.
3686
3901
  type:
3687
3902
  - boolean
3688
3903
  metadata:
3689
- description: A set of key/value pairs that you can attach to a product object.
3690
- It can be useful for storing additional information about the product in
3691
- a structured format.
3904
+ description: Set of key/value pairs that you can attach to an object. It can
3905
+ be useful for storing additional information about the object in a structured
3906
+ format.
3692
3907
  type:
3693
3908
  - object
3694
3909
  name:
@@ -3696,7 +3911,8 @@ definitions:
3696
3911
  type:
3697
3912
  - string
3698
3913
  object:
3699
- description: ''
3914
+ description: String representing the object's type. Objects of the same type
3915
+ share the same value.
3700
3916
  type:
3701
3917
  - string
3702
3918
  package_dimensions:
@@ -3718,7 +3934,8 @@ definitions:
3718
3934
  type:
3719
3935
  - boolean
3720
3936
  object:
3721
- description: The type of object. Always has the value "list".
3937
+ description: String representing the object's type. Objects of the same
3938
+ type share the same value. Always has the value "list".
3722
3939
  enum:
3723
3940
  - list
3724
3941
  type:
@@ -3780,28 +3997,33 @@ definitions:
3780
3997
  type:
3781
3998
  - string
3782
3999
  created:
3783
- description: ''
4000
+ description: Time at which the object was created. Measured in seconds since
4001
+ the Unix epoch.
3784
4002
  type:
3785
4003
  - integer
3786
4004
  currency:
3787
- description: Three-letter ISO code representing the currency.
4005
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
4006
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3788
4007
  type:
3789
4008
  - string
3790
4009
  description:
3791
- description: ''
4010
+ description: An arbitrary string attached to the object. Often useful for
4011
+ displaying to users.
3792
4012
  type:
3793
4013
  - string
3794
4014
  id:
3795
- description: ''
4015
+ description: Unique identifier for the object.
3796
4016
  type:
3797
4017
  - string
3798
4018
  metadata:
3799
- description: A set of key/value pairs that you can attach to the object. It
3800
- can be useful for storing additional information in a structured format.
4019
+ description: Set of key/value pairs that you can attach to an object. It can
4020
+ be useful for storing additional information about the object in a structured
4021
+ format.
3801
4022
  type:
3802
4023
  - object
3803
4024
  object:
3804
- description: ''
4025
+ description: String representing the object's type. Objects of the same type
4026
+ share the same value.
3805
4027
  type:
3806
4028
  - string
3807
4029
  reason:
@@ -3903,19 +4125,19 @@ definitions:
3903
4125
  type:
3904
4126
  - integer
3905
4127
  currency:
3906
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
3907
- representing the currency of the line item.
4128
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
4129
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3908
4130
  type:
3909
4131
  - string
3910
4132
  delivery_estimate:
3911
4133
  "$ref": "#/definitions/delivery_estimate"
3912
4134
  description:
3913
- description: Description of the line item, meant to be displayable to the
3914
- user (e.g., `"Express shipping"`).
4135
+ description: An arbitrary string attached to the object. Often useful for
4136
+ displaying to users.
3915
4137
  type:
3916
4138
  - string
3917
4139
  id:
3918
- description: ''
4140
+ description: Unique identifier for the object.
3919
4141
  type:
3920
4142
  - string
3921
4143
  required:
@@ -3934,12 +4156,13 @@ definitions:
3934
4156
  type:
3935
4157
  - integer
3936
4158
  currency:
3937
- description: Currency in which shipping cost will be assessed. Present when
3938
- `type` is `flat_rate`.
4159
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
4160
+ in which shipping cost will be assessed. Present when `type` is `flat_rate`.
3939
4161
  type:
3940
4162
  - string
3941
4163
  description:
3942
- description: ''
4164
+ description: An arbitrary string attached to the object. Often useful for
4165
+ displaying to users.
3943
4166
  type:
3944
4167
  - string
3945
4168
  free_above:
@@ -3985,13 +4208,13 @@ definitions:
3985
4208
  type:
3986
4209
  - integer
3987
4210
  currency:
3988
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
3989
- representing the currency of the line item.
4211
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
4212
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
3990
4213
  type:
3991
4214
  - string
3992
4215
  description:
3993
- description: Description of the line item, meant to be displayable to the
3994
- user (e.g., `"Express shipping"`).
4216
+ description: An arbitrary string attached to the object. Often useful for
4217
+ displaying to users.
3995
4218
  type:
3996
4219
  - string
3997
4220
  required:
@@ -4016,16 +4239,17 @@ definitions:
4016
4239
  type:
4017
4240
  - object
4018
4241
  created:
4019
- description: ''
4242
+ description: Time at which the object was created. Measured in seconds since
4243
+ the Unix epoch.
4020
4244
  type:
4021
4245
  - integer
4022
4246
  currency:
4023
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
4024
- for currency.
4247
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
4248
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
4025
4249
  type:
4026
4250
  - string
4027
4251
  id:
4028
- description: ''
4252
+ description: Unique identifier for the object.
4029
4253
  type:
4030
4254
  - string
4031
4255
  image:
@@ -4036,17 +4260,19 @@ definitions:
4036
4260
  inventory:
4037
4261
  "$ref": "#/definitions/inventory"
4038
4262
  livemode:
4039
- description: ''
4263
+ description: Flag indicating whether the object exists in live mode or test
4264
+ mode.
4040
4265
  type:
4041
4266
  - boolean
4042
4267
  metadata:
4043
- description: A set of key/value pairs that you can attach to a SKU object.
4044
- It can be useful for storing additional information about the SKU in a structured
4268
+ description: Set of key/value pairs that you can attach to an object. It can
4269
+ be useful for storing additional information about the object in a structured
4045
4270
  format.
4046
4271
  type:
4047
4272
  - object
4048
4273
  object:
4049
- description: ''
4274
+ description: String representing the object's type. Objects of the same type
4275
+ share the same value.
4050
4276
  type:
4051
4277
  - string
4052
4278
  package_dimensions:
@@ -4098,13 +4324,14 @@ definitions:
4098
4324
  code_verification:
4099
4325
  "$ref": "#/definitions/source_code_verification_flow"
4100
4326
  created:
4101
- description: ''
4327
+ description: Time at which the object was created. Measured in seconds since
4328
+ the Unix epoch.
4102
4329
  type:
4103
4330
  - integer
4104
4331
  currency:
4105
- description: The currency associated with the source. This is the currency
4106
- for which the source will be chargeable once ready. Required for `single-use`
4107
- sources.
4332
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
4333
+ associated with the source. This is the currency for which the source will
4334
+ be chargeable once ready. Required for `single-use` sources.
4108
4335
  type:
4109
4336
  - string
4110
4337
  flow:
@@ -4113,21 +4340,23 @@ definitions:
4113
4340
  type:
4114
4341
  - string
4115
4342
  id:
4116
- description: ''
4343
+ description: Unique identifier for the object.
4117
4344
  type:
4118
4345
  - string
4119
4346
  livemode:
4120
- description: ''
4347
+ description: Flag indicating whether the object exists in live mode or test
4348
+ mode.
4121
4349
  type:
4122
4350
  - boolean
4123
4351
  metadata:
4124
- description: A set of key/value pairs that you can attach to a source object.
4125
- It can be useful for storing additional information about the source in
4126
- a structured format.
4352
+ description: Set of key/value pairs that you can attach to an object. It can
4353
+ be useful for storing additional information about the object in a structured
4354
+ format.
4127
4355
  type:
4128
4356
  - object
4129
4357
  object:
4130
- description: ''
4358
+ description: String representing the object's type. Objects of the same type
4359
+ share the same value.
4131
4360
  type:
4132
4361
  - string
4133
4362
  owner:
@@ -4335,7 +4564,8 @@ definitions:
4335
4564
  type:
4336
4565
  - integer
4337
4566
  created:
4338
- description: ''
4567
+ description: Time at which the object was created. Measured in seconds since
4568
+ the Unix epoch.
4339
4569
  type:
4340
4570
  - integer
4341
4571
  current_period_end:
@@ -4366,7 +4596,7 @@ definitions:
4366
4596
  type:
4367
4597
  - integer
4368
4598
  id:
4369
- description: ''
4599
+ description: Unique identifier for the object.
4370
4600
  type:
4371
4601
  - string
4372
4602
  items:
@@ -4382,7 +4612,8 @@ definitions:
4382
4612
  type:
4383
4613
  - boolean
4384
4614
  object:
4385
- description: The type of object. Always has the value "list".
4615
+ description: String representing the object's type. Objects of the same
4616
+ type share the same value. Always has the value "list".
4386
4617
  enum:
4387
4618
  - list
4388
4619
  type:
@@ -4405,7 +4636,8 @@ definitions:
4405
4636
  type:
4406
4637
  - object
4407
4638
  livemode:
4408
- description: ''
4639
+ description: Flag indicating whether the object exists in live mode or test
4640
+ mode.
4409
4641
  type:
4410
4642
  - boolean
4411
4643
  max_occurrences:
@@ -4413,13 +4645,14 @@ definitions:
4413
4645
  type:
4414
4646
  - integer
4415
4647
  metadata:
4416
- description: A set of key/value pairs that you can attach to a subscription
4417
- object. It can be useful for storing additional information about the subscription
4418
- in a structured format.
4648
+ description: Set of key/value pairs that you can attach to an object. It can
4649
+ be useful for storing additional information about the object in a structured
4650
+ format.
4419
4651
  type:
4420
4652
  - object
4421
4653
  object:
4422
- description: ''
4654
+ description: String representing the object's type. Objects of the same type
4655
+ share the same value.
4423
4656
  type:
4424
4657
  - string
4425
4658
  on_behalf_of:
@@ -4488,15 +4721,17 @@ definitions:
4488
4721
  subscription_item:
4489
4722
  properties:
4490
4723
  created:
4491
- description: ''
4724
+ description: Time at which the object was created. Measured in seconds since
4725
+ the Unix epoch.
4492
4726
  type:
4493
4727
  - integer
4494
4728
  id:
4495
- description: ''
4729
+ description: Unique identifier for the object.
4496
4730
  type:
4497
4731
  - string
4498
4732
  object:
4499
- description: ''
4733
+ description: String representing the object's type. Objects of the same type
4734
+ share the same value.
4500
4735
  type:
4501
4736
  - string
4502
4737
  plan:
@@ -4519,7 +4754,8 @@ definitions:
4519
4754
  tax_settings:
4520
4755
  properties:
4521
4756
  description:
4522
- description: ''
4757
+ description: An arbitrary string attached to the object. Often useful for
4758
+ displaying to users.
4523
4759
  type:
4524
4760
  - string
4525
4761
  provider:
@@ -4559,23 +4795,27 @@ definitions:
4559
4795
  card:
4560
4796
  "$ref": "#/definitions/card"
4561
4797
  created:
4562
- description: ''
4798
+ description: Time at which the object was created. Measured in seconds since
4799
+ the Unix epoch.
4563
4800
  type:
4564
4801
  - integer
4565
4802
  currency:
4566
- description: ''
4803
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
4804
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
4567
4805
  type:
4568
4806
  - string
4569
4807
  id:
4570
- description: ''
4808
+ description: Unique identifier for the object.
4571
4809
  type:
4572
4810
  - string
4573
4811
  livemode:
4574
- description: ''
4812
+ description: Flag indicating whether the object exists in live mode or test
4813
+ mode.
4575
4814
  type:
4576
4815
  - boolean
4577
4816
  object:
4578
- description: ''
4817
+ description: String representing the object's type. Objects of the same type
4818
+ share the same value.
4579
4819
  type:
4580
4820
  - string
4581
4821
  redirect_url:
@@ -4618,19 +4858,22 @@ definitions:
4618
4858
  type:
4619
4859
  - string
4620
4860
  created:
4621
- description: ''
4861
+ description: Time at which the object was created. Measured in seconds since
4862
+ the Unix epoch.
4622
4863
  type:
4623
4864
  - integer
4624
4865
  id:
4625
- description: ''
4866
+ description: Unique identifier for the object.
4626
4867
  type:
4627
4868
  - string
4628
4869
  livemode:
4629
- description: ''
4870
+ description: Flag indicating whether the object exists in live mode or test
4871
+ mode.
4630
4872
  type:
4631
4873
  - boolean
4632
4874
  object:
4633
- description: ''
4875
+ description: String representing the object's type. Objects of the same type
4876
+ share the same value.
4634
4877
  type:
4635
4878
  - string
4636
4879
  type:
@@ -4703,8 +4946,8 @@ definitions:
4703
4946
  type:
4704
4947
  - string
4705
4948
  currency:
4706
- description: Three-letter ISO currency code representing the currency paid
4707
- out to the bank account.
4949
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
4950
+ paid out to the bank account.
4708
4951
  type:
4709
4952
  - string
4710
4953
  fingerprint:
@@ -4713,7 +4956,7 @@ definitions:
4713
4956
  type:
4714
4957
  - string
4715
4958
  id:
4716
- description: ''
4959
+ description: Unique identifier for the object.
4717
4960
  type:
4718
4961
  - string
4719
4962
  last4:
@@ -4721,7 +4964,8 @@ definitions:
4721
4964
  type:
4722
4965
  - string
4723
4966
  object:
4724
- description: ''
4967
+ description: String representing the object's type. Objects of the same type
4968
+ share the same value.
4725
4969
  type:
4726
4970
  - string
4727
4971
  reusable:
@@ -4763,7 +5007,7 @@ definitions:
4763
5007
  token_card:
4764
5008
  properties:
4765
5009
  address_city:
4766
- description: ''
5010
+ description: City/District/Suburb/Town/Village.
4767
5011
  type:
4768
5012
  - string
4769
5013
  address_country:
@@ -4771,7 +5015,7 @@ definitions:
4771
5015
  type:
4772
5016
  - string
4773
5017
  address_line1:
4774
- description: ''
5018
+ description: Address line 1 (Street address/PO Box/Company name).
4775
5019
  type:
4776
5020
  - string
4777
5021
  address_line1_check:
@@ -4780,15 +5024,15 @@ definitions:
4780
5024
  type:
4781
5025
  - string
4782
5026
  address_line2:
4783
- description: ''
5027
+ description: Address line 2 (Apartment/Suite/Unit/Building).
4784
5028
  type:
4785
5029
  - string
4786
5030
  address_state:
4787
- description: ''
5031
+ description: State/County/Province/Region.
4788
5032
  type:
4789
5033
  - string
4790
5034
  address_zip:
4791
- description: ''
5035
+ description: Zip/Postal Code.
4792
5036
  type:
4793
5037
  - string
4794
5038
  address_zip_check:
@@ -4808,7 +5052,8 @@ definitions:
4808
5052
  type:
4809
5053
  - string
4810
5054
  currency:
4811
- description: ''
5055
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
5056
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
4812
5057
  type:
4813
5058
  - string
4814
5059
  cvc_check:
@@ -4822,11 +5067,11 @@ definitions:
4822
5067
  type:
4823
5068
  - string
4824
5069
  exp_month:
4825
- description: ''
5070
+ description: Two digit number representing the card's expiration month.
4826
5071
  type:
4827
5072
  - integer
4828
5073
  exp_year:
4829
- description: ''
5074
+ description: Four digit number representing the card's expiration year.
4830
5075
  type:
4831
5076
  - integer
4832
5077
  fingerprint:
@@ -4844,18 +5089,17 @@ definitions:
4844
5089
  type:
4845
5090
  - string
4846
5091
  id:
4847
- description: ID of card (used in conjunction with a customer or recipient
4848
- ID).
5092
+ description: Unique identifier for the object.
4849
5093
  type:
4850
5094
  - string
4851
5095
  last4:
4852
- description: ''
5096
+ description: The last 4 digits of the card.
4853
5097
  type:
4854
5098
  - string
4855
5099
  metadata:
4856
- description: A set of key/value pairs that you can attach to a card object.
4857
- It can be useful for storing additional information about the card in a
4858
- structured format.
5100
+ description: Set of key/value pairs that you can attach to an object. It can
5101
+ be useful for storing additional information about the object in a structured
5102
+ format.
4859
5103
  type:
4860
5104
  - object
4861
5105
  name:
@@ -4863,7 +5107,8 @@ definitions:
4863
5107
  type:
4864
5108
  - string
4865
5109
  object:
4866
- description: ''
5110
+ description: String representing the object's type. Objects of the same type
5111
+ share the same value.
4867
5112
  type:
4868
5113
  - string
4869
5114
  three_d_secure:
@@ -4891,47 +5136,55 @@ definitions:
4891
5136
  transfer:
4892
5137
  properties:
4893
5138
  amount:
4894
- description: ''
5139
+ description: Amount in %s to be transferred.
4895
5140
  type:
4896
5141
  - integer
4897
5142
  amount_reversed:
4898
- description: ''
5143
+ description: Amount in %s reversed (can be less than the amount attribute
5144
+ on the transfer if a partial reversal was issued).
4899
5145
  type:
4900
5146
  - integer
4901
5147
  balance_transaction:
4902
- description: ''
5148
+ description: Balance transaction that describes the impact of this transfer
5149
+ on your account balance.
4903
5150
  type:
4904
5151
  - string
4905
5152
  created:
4906
- description: ''
5153
+ description: Time that this record of the transfer was first created.
4907
5154
  type:
4908
5155
  - integer
4909
5156
  currency:
4910
- description: ''
5157
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
5158
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
4911
5159
  type:
4912
5160
  - string
4913
5161
  destination:
4914
- description: ''
5162
+ description: ID of the Stripe account the transfer was sent to.
4915
5163
  type:
4916
5164
  - string
4917
5165
  destination_payment:
4918
- description: ''
5166
+ description: If the destination is a Stripe account, this will be the ID of
5167
+ the payment that the destination account received for the transfer.
4919
5168
  type:
4920
5169
  - string
4921
5170
  id:
4922
- description: ''
5171
+ description: Unique identifier for the object.
4923
5172
  type:
4924
5173
  - string
4925
5174
  livemode:
4926
- description: ''
5175
+ description: Flag indicating whether the object exists in live mode or test
5176
+ mode.
4927
5177
  type:
4928
5178
  - boolean
4929
5179
  metadata:
4930
- description: ''
5180
+ description: A set of key/value pairs that you can attach to a transfer object.
5181
+ It can be useful for storing additional information about the transfer in
5182
+ a structured format.
4931
5183
  type:
4932
5184
  - object
4933
5185
  object:
4934
- description: ''
5186
+ description: String representing the object's type. Objects of the same type
5187
+ share the same value.
4935
5188
  type:
4936
5189
  - string
4937
5190
  reversals:
@@ -4947,7 +5200,8 @@ definitions:
4947
5200
  type:
4948
5201
  - boolean
4949
5202
  object:
4950
- description: The type of object. Always has the value "list".
5203
+ description: String representing the object's type. Objects of the same
5204
+ type share the same value. Always has the value "list".
4951
5205
  enum:
4952
5206
  - list
4953
5207
  type:
@@ -4970,13 +5224,20 @@ definitions:
4970
5224
  type:
4971
5225
  - object
4972
5226
  reversed:
4973
- description: ''
5227
+ description: Whether or not the transfer has been fully reversed. If the transfer
5228
+ is only partially reversed, this attribute will still be false.
4974
5229
  type:
4975
5230
  - boolean
4976
- transfer_group:
5231
+ source_type:
4977
5232
  description: ''
4978
5233
  type:
4979
5234
  - string
5235
+ transfer_group:
5236
+ description: A string that identifies this transaction as part of a group.
5237
+ See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions)
5238
+ for details.
5239
+ type:
5240
+ - string
4980
5241
  required:
4981
5242
  - amount
4982
5243
  - amount_reversed
@@ -5009,7 +5270,8 @@ definitions:
5009
5270
  type:
5010
5271
  - boolean
5011
5272
  object:
5012
- description: The type of object. Always has the value "list".
5273
+ description: String representing the object's type. Objects of the same
5274
+ type share the same value. Always has the value "list".
5013
5275
  enum:
5014
5276
  - list
5015
5277
  type:
@@ -5032,7 +5294,8 @@ definitions:
5032
5294
  type:
5033
5295
  - object
5034
5296
  created:
5035
- description: ''
5297
+ description: Time at which the object was created. Measured in seconds since
5298
+ the Unix epoch.
5036
5299
  type:
5037
5300
  - integer
5038
5301
  default_card:
@@ -5040,7 +5303,8 @@ definitions:
5040
5303
  type:
5041
5304
  - string
5042
5305
  description:
5043
- description: ''
5306
+ description: An arbitrary string attached to the object. Often useful for
5307
+ displaying to users.
5044
5308
  type:
5045
5309
  - string
5046
5310
  email:
@@ -5048,17 +5312,18 @@ definitions:
5048
5312
  type:
5049
5313
  - string
5050
5314
  id:
5051
- description: ''
5315
+ description: Unique identifier for the object.
5052
5316
  type:
5053
5317
  - string
5054
5318
  livemode:
5055
- description: ''
5319
+ description: Flag indicating whether the object exists in live mode or test
5320
+ mode.
5056
5321
  type:
5057
5322
  - boolean
5058
5323
  metadata:
5059
- description: A set of key/value pairs that you can attach to a recipient object.
5060
- It can be useful for storing additional information about the recipient
5061
- in a structured format.
5324
+ description: Set of key/value pairs that you can attach to an object. It can
5325
+ be useful for storing additional information about the object in a structured
5326
+ format.
5062
5327
  type:
5063
5328
  - object
5064
5329
  migrated_to:
@@ -5072,7 +5337,8 @@ definitions:
5072
5337
  type:
5073
5338
  - string
5074
5339
  object:
5075
- description: ''
5340
+ description: String representing the object's type. Objects of the same type
5341
+ share the same value.
5076
5342
  type:
5077
5343
  - string
5078
5344
  tin:
@@ -5111,24 +5377,28 @@ definitions:
5111
5377
  type:
5112
5378
  - string
5113
5379
  created:
5114
- description: ''
5380
+ description: Time at which the object was created. Measured in seconds since
5381
+ the Unix epoch.
5115
5382
  type:
5116
5383
  - integer
5117
5384
  currency:
5118
- description: Three-letter ISO code representing the currency.
5385
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
5386
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
5119
5387
  type:
5120
5388
  - string
5121
5389
  id:
5122
- description: ''
5390
+ description: Unique identifier for the object.
5123
5391
  type:
5124
5392
  - string
5125
5393
  metadata:
5126
- description: A set of key/value pairs that you can attach to the object. It
5127
- can be useful for storing additional information in a structured format.
5394
+ description: Set of key/value pairs that you can attach to an object. It can
5395
+ be useful for storing additional information about the object in a structured
5396
+ format.
5128
5397
  type:
5129
5398
  - object
5130
5399
  object:
5131
- description: ''
5400
+ description: String representing the object's type. Objects of the same type
5401
+ share the same value.
5132
5402
  type:
5133
5403
  - string
5134
5404
  transfer:
@@ -5277,7 +5547,8 @@ definitions:
5277
5547
  type:
5278
5548
  - boolean
5279
5549
  currency:
5280
- description: ''
5550
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
5551
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
5281
5552
  type:
5282
5553
  - string
5283
5554
  customer:
@@ -5285,11 +5556,13 @@ definitions:
5285
5556
  type:
5286
5557
  - string
5287
5558
  date:
5288
- description: ''
5559
+ description: Time at which the object was created. Measured in seconds since
5560
+ the Unix epoch.
5289
5561
  type:
5290
5562
  - integer
5291
5563
  description:
5292
- description: ''
5564
+ description: An arbitrary string attached to the object. Often useful for
5565
+ displaying to users.
5293
5566
  type:
5294
5567
  - string
5295
5568
  discount:
@@ -5322,7 +5595,8 @@ definitions:
5322
5595
  type:
5323
5596
  - boolean
5324
5597
  object:
5325
- description: The type of object. Always has the value "list".
5598
+ description: String representing the object's type. Objects of the same
5599
+ type share the same value. Always has the value "list".
5326
5600
  enum:
5327
5601
  - list
5328
5602
  type:
@@ -5345,13 +5619,14 @@ definitions:
5345
5619
  type:
5346
5620
  - object
5347
5621
  livemode:
5348
- description: ''
5622
+ description: Flag indicating whether the object exists in live mode or test
5623
+ mode.
5349
5624
  type:
5350
5625
  - boolean
5351
5626
  metadata:
5352
- description: A set of key/value pairs that you can attach to an invoice object.
5353
- It can be useful for storing additional information about the invoice in
5354
- a structured format.
5627
+ description: Set of key/value pairs that you can attach to an object. It can
5628
+ be useful for storing additional information about the object in a structured
5629
+ format.
5355
5630
  type:
5356
5631
  - object
5357
5632
  next_payment_attempt:
@@ -5364,7 +5639,8 @@ definitions:
5364
5639
  type:
5365
5640
  - string
5366
5641
  object:
5367
- description: ''
5642
+ description: String representing the object's type. Objects of the same type
5643
+ share the same value.
5368
5644
  type:
5369
5645
  - string
5370
5646
  paid:
@@ -5468,7 +5744,7 @@ info:
5468
5744
  details.
5469
5745
  termsOfService: https://stripe.com/us/terms/
5470
5746
  title: Stripe API
5471
- version: '2017-02-14'
5747
+ version: '2017-04-06'
5472
5748
  paths:
5473
5749
  "/v1/3d_secure":
5474
5750
  post:
@@ -5494,8 +5770,8 @@ paths:
5494
5770
  type:
5495
5771
  - string
5496
5772
  currency:
5497
- description: Currency of the charge that you will create when authentication
5498
- completes.
5773
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
5774
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
5499
5775
  title: currency
5500
5776
  type:
5501
5777
  - string
@@ -5544,12 +5820,12 @@ paths:
5544
5820
  "$ref": "#/definitions/error"
5545
5821
  "/v1/account":
5546
5822
  delete:
5547
- description: |-
5548
- <p>With <a href="/docs/connect">Connect</a>, you may delete Stripe accounts you manage.</p>
5549
-
5550
- <p>Managed accounts created using test-mode keys can be deleted at any time. Managed accounts created using live-mode keys may only be deleted once all balances are zero.</p>
5551
-
5552
- <p>If you are looking to close your own account, use the <a href="http://dashboard:6090/account/data">data tab in your account settings</a> instead.</p>
5823
+ description: <p>With <a href="/docs/connect">Connect</a>, you may delete Stripe
5824
+ accounts you manage.</p><p>Managed accounts created using test-mode keys can
5825
+ be deleted at any time. Managed accounts created using live-mode keys may
5826
+ only be deleted once all balances are zero.</p><p>If you are looking to close
5827
+ your own account, use the <a href="https://dashboard.stripe.com/account/data">data
5828
+ tab in your account settings</a> instead.</p>
5553
5829
  operationId: AccountDelete
5554
5830
  parameters:
5555
5831
  - description: Body parameters for the request.
@@ -5593,10 +5869,12 @@ paths:
5593
5869
  schema:
5594
5870
  "$ref": "#/definitions/error"
5595
5871
  post:
5596
- description: |-
5597
- <p>Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
5598
-
5599
- <p><strong>You may only update accounts that you <a href="/docs/connect/managed-accounts">manage</a></strong>. To update your own account, you can currently only do so via the <a href="http://dashboard:6090/account">dashboard</a>. For more information on updating Managed Accounts, see <a href="/docs/connect/updating-accounts">our guide</a>.</p>
5872
+ description: <p>Updates an account by setting the values of the parameters passed.
5873
+ Any parameters not provided will be left unchanged.</p><p><strong>You may
5874
+ only update accounts that you <a href="/docs/connect/managed-accounts">manage</a></strong>.
5875
+ To update your own account, you can currently only do so via the <a href="https://dashboard.stripe.com/account">dashboard</a>.
5876
+ For more information on updating Managed Accounts, see <a href="/docs/connect/updating-accounts">our
5877
+ guide</a>.</p>
5600
5878
  operationId: AccountUpdate
5601
5879
  parameters:
5602
5880
  - description: Body parameters for the request.
@@ -5630,7 +5908,7 @@ paths:
5630
5908
  debit_negative_balances:
5631
5909
  description: A boolean for whether or not Stripe should try to reclaim
5632
5910
  negative balances from the account holder's bank account. See our
5633
- [managed account bank transfer guide](/docs/connect/bank-transfers#negative-balances)
5911
+ [managed account bank transfer guide](/docs/connect/account-balances)
5634
5912
  for more information.
5635
5913
  title: debit_negative_balances
5636
5914
  type:
@@ -5644,7 +5922,7 @@ paths:
5644
5922
  default_currency:
5645
5923
  description: Three-letter ISO currency code representing the default
5646
5924
  currency for the account. This must be a currency that [Stripe supports
5647
- in the account's country](http://127.0.0.1:6041/questions/which-currencies-does-stripe-support).
5925
+ in the account's country](https://support.stripe.com/questions/which-currencies-does-stripe-support).
5648
5926
  title: default_currency
5649
5927
  type:
5650
5928
  - string
@@ -5693,6 +5971,21 @@ paths:
5693
5971
  title: orders
5694
5972
  type:
5695
5973
  - object
5974
+ payout_schedule:
5975
+ description: Details on when this account will make funds from charges
5976
+ available, and when they will be paid out to the account holder's
5977
+ bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information)
5978
+ for more information.
5979
+ title: payout_schedule
5980
+ type:
5981
+ - object
5982
+ payout_statement_descriptor:
5983
+ description: The text that will appear on the account's bank account
5984
+ statement for payouts. If not set, this will default to your platform's
5985
+ bank descriptor set on the Dashboard.
5986
+ title: payout_statement_descriptor
5987
+ type:
5988
+ - string
5696
5989
  product_description:
5697
5990
  description: Internal-only description of the product being sold or
5698
5991
  service being provided by this account. It's used by Stripe for risk
@@ -5724,28 +6017,13 @@ paths:
5724
6017
  title: support_url
5725
6018
  type:
5726
6019
  - string
5727
- tos_acceptance:
5728
- description: Details on who accepted the Stripe terms of service, and
5729
- when they accepted it. See our [updating managed accounts guide](/docs/connect/updating-accounts#tos_acceptance)
5730
- for more information.
5731
- title: tos_acceptance
5732
- type:
5733
- - object
5734
- transfer_schedule:
5735
- description: Details on when this account will make funds from charges
5736
- available, and when they will be paid out to the account holder's
5737
- bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information)
6020
+ tos_acceptance:
6021
+ description: Details on who accepted the Stripe terms of service, and
6022
+ when they accepted it. See our [updating managed accounts guide](/docs/connect/updating-accounts#tos-acceptance)
5738
6023
  for more information.
5739
- title: transfer_schedule
6024
+ title: tos_acceptance
5740
6025
  type:
5741
6026
  - object
5742
- transfer_statement_descriptor:
5743
- description: The text that will appear on the account's bank account
5744
- statement for payouts. If not set, this will default to your platform's
5745
- bank descriptor set on the Dashboard.
5746
- title: transfer_statement_descriptor
5747
- type:
5748
- - string
5749
6027
  responses:
5750
6028
  '200':
5751
6029
  description: Successful response.
@@ -5899,7 +6177,8 @@ paths:
5899
6177
  type:
5900
6178
  - boolean
5901
6179
  object:
5902
- description: The type of object. Always has the value "list".
6180
+ description: String representing the object's type. Objects of the
6181
+ same type share the same value. Always has the value "list".
5903
6182
  enum:
5904
6183
  - list
5905
6184
  type:
@@ -6069,7 +6348,8 @@ paths:
6069
6348
  type:
6070
6349
  - boolean
6071
6350
  object:
6072
- description: The type of object. Always has the value "list".
6351
+ description: String representing the object's type. Objects of the
6352
+ same type share the same value. Always has the value "list".
6073
6353
  enum:
6074
6354
  - list
6075
6355
  type:
@@ -6136,7 +6416,7 @@ paths:
6136
6416
  debit_negative_balances:
6137
6417
  description: A boolean for whether or not Stripe should try to reclaim
6138
6418
  negative balances from the account holder's bank account. See our
6139
- [managed account bank transfer guide](/docs/connect/bank-transfers#negative-balances)
6419
+ [managed account bank transfer guide](/docs/connect/account-balances)
6140
6420
  for more information.
6141
6421
  title: debit_negative_balances
6142
6422
  type:
@@ -6150,7 +6430,7 @@ paths:
6150
6430
  default_currency:
6151
6431
  description: Three-letter ISO currency code representing the default
6152
6432
  currency for the account. This must be a currency that [Stripe supports
6153
- in the account's country](http://127.0.0.1:6041/questions/which-currencies-does-stripe-support).
6433
+ in the account's country](https://support.stripe.com/questions/which-currencies-does-stripe-support).
6154
6434
  title: default_currency
6155
6435
  type:
6156
6436
  - string
@@ -6204,6 +6484,21 @@ paths:
6204
6484
  title: orders
6205
6485
  type:
6206
6486
  - object
6487
+ payout_schedule:
6488
+ description: Details on when this account will make funds from charges
6489
+ available, and when they will be paid out to the account holder's
6490
+ bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information)
6491
+ for more information.
6492
+ title: payout_schedule
6493
+ type:
6494
+ - object
6495
+ payout_statement_descriptor:
6496
+ description: The text that will appear on the account's bank account
6497
+ statement for payouts. If not set, this will default to your platform's
6498
+ bank descriptor set on the Dashboard.
6499
+ title: payout_statement_descriptor
6500
+ type:
6501
+ - string
6207
6502
  platform_account:
6208
6503
  description: ''
6209
6504
  title: platform_account
@@ -6242,26 +6537,11 @@ paths:
6242
6537
  - string
6243
6538
  tos_acceptance:
6244
6539
  description: Details on who accepted the Stripe terms of service, and
6245
- when they accepted it. See our [updating managed accounts guide](/docs/connect/updating-accounts#tos_acceptance)
6540
+ when they accepted it. See our [updating managed accounts guide](/docs/connect/updating-accounts#tos-acceptance)
6246
6541
  for more information.
6247
6542
  title: tos_acceptance
6248
6543
  type:
6249
6544
  - object
6250
- transfer_schedule:
6251
- description: Details on when this account will make funds from charges
6252
- available, and when they will be paid out to the account holder's
6253
- bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information)
6254
- for more information.
6255
- title: transfer_schedule
6256
- type:
6257
- - object
6258
- transfer_statement_descriptor:
6259
- description: The text that will appear on the account's bank account
6260
- statement for payouts. If not set, this will default to your platform's
6261
- bank descriptor set on the Dashboard.
6262
- title: transfer_statement_descriptor
6263
- type:
6264
- - string
6265
6545
  responses:
6266
6546
  '200':
6267
6547
  description: Successful response.
@@ -6273,12 +6553,12 @@ paths:
6273
6553
  "$ref": "#/definitions/error"
6274
6554
  "/v1/accounts/{account}":
6275
6555
  delete:
6276
- description: |-
6277
- <p>With <a href="/docs/connect">Connect</a>, you may delete Stripe accounts you manage.</p>
6278
-
6279
- <p>Managed accounts created using test-mode keys can be deleted at any time. Managed accounts created using live-mode keys may only be deleted once all balances are zero.</p>
6280
-
6281
- <p>If you are looking to close your own account, use the <a href="http://dashboard:6090/account/data">data tab in your account settings</a> instead.</p>
6556
+ description: <p>With <a href="/docs/connect">Connect</a>, you may delete Stripe
6557
+ accounts you manage.</p><p>Managed accounts created using test-mode keys can
6558
+ be deleted at any time. Managed accounts created using live-mode keys may
6559
+ only be deleted once all balances are zero.</p><p>If you are looking to close
6560
+ your own account, use the <a href="https://dashboard.stripe.com/account/data">data
6561
+ tab in your account settings</a> instead.</p>
6282
6562
  operationId: AccountDelete
6283
6563
  parameters:
6284
6564
  - description: The identifier of the account to be deleted. If none is provided,
@@ -6316,10 +6596,12 @@ paths:
6316
6596
  schema:
6317
6597
  "$ref": "#/definitions/error"
6318
6598
  post:
6319
- description: |-
6320
- <p>Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
6321
-
6322
- <p><strong>You may only update accounts that you <a href="/docs/connect/managed-accounts">manage</a></strong>. To update your own account, you can currently only do so via the <a href="http://dashboard:6090/account">dashboard</a>. For more information on updating Managed Accounts, see <a href="/docs/connect/updating-accounts">our guide</a>.</p>
6599
+ description: <p>Updates an account by setting the values of the parameters passed.
6600
+ Any parameters not provided will be left unchanged.</p><p><strong>You may
6601
+ only update accounts that you <a href="/docs/connect/managed-accounts">manage</a></strong>.
6602
+ To update your own account, you can currently only do so via the <a href="https://dashboard.stripe.com/account">dashboard</a>.
6603
+ For more information on updating Managed Accounts, see <a href="/docs/connect/updating-accounts">our
6604
+ guide</a>.</p>
6323
6605
  operationId: AccountUpdate
6324
6606
  parameters:
6325
6607
  - description: Body parameters for the request.
@@ -6353,7 +6635,7 @@ paths:
6353
6635
  debit_negative_balances:
6354
6636
  description: A boolean for whether or not Stripe should try to reclaim
6355
6637
  negative balances from the account holder's bank account. See our
6356
- [managed account bank transfer guide](/docs/connect/bank-transfers#negative-balances)
6638
+ [managed account bank transfer guide](/docs/connect/account-balances)
6357
6639
  for more information.
6358
6640
  title: debit_negative_balances
6359
6641
  type:
@@ -6367,7 +6649,7 @@ paths:
6367
6649
  default_currency:
6368
6650
  description: Three-letter ISO currency code representing the default
6369
6651
  currency for the account. This must be a currency that [Stripe supports
6370
- in the account's country](http://127.0.0.1:6041/questions/which-currencies-does-stripe-support).
6652
+ in the account's country](https://support.stripe.com/questions/which-currencies-does-stripe-support).
6371
6653
  title: default_currency
6372
6654
  type:
6373
6655
  - string
@@ -6416,6 +6698,21 @@ paths:
6416
6698
  title: orders
6417
6699
  type:
6418
6700
  - object
6701
+ payout_schedule:
6702
+ description: Details on when this account will make funds from charges
6703
+ available, and when they will be paid out to the account holder's
6704
+ bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information)
6705
+ for more information.
6706
+ title: payout_schedule
6707
+ type:
6708
+ - object
6709
+ payout_statement_descriptor:
6710
+ description: The text that will appear on the account's bank account
6711
+ statement for payouts. If not set, this will default to your platform's
6712
+ bank descriptor set on the Dashboard.
6713
+ title: payout_statement_descriptor
6714
+ type:
6715
+ - string
6419
6716
  product_description:
6420
6717
  description: Internal-only description of the product being sold or
6421
6718
  service being provided by this account. It's used by Stripe for risk
@@ -6449,26 +6746,11 @@ paths:
6449
6746
  - string
6450
6747
  tos_acceptance:
6451
6748
  description: Details on who accepted the Stripe terms of service, and
6452
- when they accepted it. See our [updating managed accounts guide](/docs/connect/updating-accounts#tos_acceptance)
6749
+ when they accepted it. See our [updating managed accounts guide](/docs/connect/updating-accounts#tos-acceptance)
6453
6750
  for more information.
6454
6751
  title: tos_acceptance
6455
6752
  type:
6456
6753
  - object
6457
- transfer_schedule:
6458
- description: Details on when this account will make funds from charges
6459
- available, and when they will be paid out to the account holder's
6460
- bank account. See our [managed account bank transfer guide](/docs/connect/bank-transfers#payout-information)
6461
- for more information.
6462
- title: transfer_schedule
6463
- type:
6464
- - object
6465
- transfer_statement_descriptor:
6466
- description: The text that will appear on the account's bank account
6467
- statement for payouts. If not set, this will default to your platform's
6468
- bank descriptor set on the Dashboard.
6469
- title: transfer_statement_descriptor
6470
- type:
6471
- - string
6472
6754
  responses:
6473
6755
  '200':
6474
6756
  description: Successful response.
@@ -6622,7 +6904,8 @@ paths:
6622
6904
  type:
6623
6905
  - boolean
6624
6906
  object:
6625
- description: The type of object. Always has the value "list".
6907
+ description: String representing the object's type. Objects of the
6908
+ same type share the same value. Always has the value "list".
6626
6909
  enum:
6627
6910
  - list
6628
6911
  type:
@@ -6747,10 +7030,10 @@ paths:
6747
7030
  "$ref": "#/definitions/error"
6748
7031
  "/v1/accounts/{account}/reject":
6749
7032
  post:
6750
- description: |-
6751
- <p>With <a href="/docs/connect">Connect</a>, you may flag managed accounts as suspicious.</p>
6752
-
6753
- <p>Managed accounts created using test-mode keys can be rejected at any time. Managed accounts created using live-mode keys may only be rejected once all balances are zero.</p>
7033
+ description: <p>With <a href="/docs/connect">Connect</a>, you may flag managed
7034
+ accounts as suspicious.</p><p>Managed accounts created using test-mode keys
7035
+ can be rejected at any time. Managed accounts created using live-mode keys
7036
+ may only be rejected once all balances are zero.</p>
6754
7037
  operationId: AccountReject
6755
7038
  parameters:
6756
7039
  - description: The identifier of the account to be rejected.
@@ -6831,7 +7114,8 @@ paths:
6831
7114
  type:
6832
7115
  - boolean
6833
7116
  object:
6834
- description: The type of object. Always has the value "list".
7117
+ description: String representing the object's type. Objects of the
7118
+ same type share the same value. Always has the value "list".
6835
7119
  enum:
6836
7120
  - list
6837
7121
  type:
@@ -6980,7 +7264,8 @@ paths:
6980
7264
  type:
6981
7265
  - boolean
6982
7266
  object:
6983
- description: The type of object. Always has the value "list".
7267
+ description: String representing the object's type. Objects of the
7268
+ same type share the same value. Always has the value "list".
6984
7269
  enum:
6985
7270
  - list
6986
7271
  type:
@@ -7034,10 +7319,9 @@ paths:
7034
7319
  schema:
7035
7320
  "$ref": "#/definitions/error"
7036
7321
  post:
7037
- description: |-
7038
- <p>Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
7039
-
7040
- <p>This request only accepts metadata as an argument.</p>
7322
+ description: "<p>Updates the specified application fee refund by setting the
7323
+ values of the parameters passed. Any parameters not provided will be left
7324
+ unchanged.</p><p>This request only accepts metadata as an argument.</p>"
7041
7325
  operationId: UpdatePlatformEarningRefund
7042
7326
  parameters:
7043
7327
  - description: Body parameters for the request.
@@ -7172,7 +7456,8 @@ paths:
7172
7456
  type:
7173
7457
  - boolean
7174
7458
  object:
7175
- description: The type of object. Always has the value "list".
7459
+ description: String representing the object's type. Objects of the
7460
+ same type share the same value. Always has the value "list".
7176
7461
  enum:
7177
7462
  - list
7178
7463
  type:
@@ -7284,10 +7569,10 @@ paths:
7284
7569
  name: ending_before
7285
7570
  required: false
7286
7571
  type: string
7287
- - description: For automatic Stripe transfers only, only returns transactions
7288
- that were transferred out on the specified transfer ID.
7572
+ - description: For automatic Stripe payouts only, only returns transactions
7573
+ that were payed out on the specified payout ID.
7289
7574
  in: query
7290
- name: transfer
7575
+ name: payout
7291
7576
  required: false
7292
7577
  type: string
7293
7578
  - description: ''
@@ -7301,8 +7586,8 @@ paths:
7301
7586
  required: false
7302
7587
  type: integer
7303
7588
  - description: 'Only returns transactions of the given type. One of: `charge`,
7304
- `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `payment`,
7305
- `transfer`, or `transfer_failure`.'
7589
+ `refund`, `adjustment`, `application_fee`, `application_fee_refund`, `transfer`,
7590
+ `payment`, `payout`, or `payout_failure`.'
7306
7591
  in: query
7307
7592
  name: type
7308
7593
  required: false
@@ -7333,7 +7618,8 @@ paths:
7333
7618
  type:
7334
7619
  - boolean
7335
7620
  object:
7336
- description: The type of object. Always has the value "list".
7621
+ description: String representing the object's type. Objects of the
7622
+ same type share the same value. Always has the value "list".
7337
7623
  enum:
7338
7624
  - list
7339
7625
  type:
@@ -7507,7 +7793,8 @@ paths:
7507
7793
  type:
7508
7794
  - boolean
7509
7795
  object:
7510
- description: The type of object. Always has the value "list".
7796
+ description: String representing the object's type. Objects of the
7797
+ same type share the same value. Always has the value "list".
7511
7798
  enum:
7512
7799
  - list
7513
7800
  type:
@@ -7552,8 +7839,9 @@ paths:
7552
7839
  type:
7553
7840
  - integer
7554
7841
  currency:
7555
- description: The currency to which the bitcoin will be converted. You
7556
- will be paid out in this currency. Only USD is currently supported.
7842
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
7843
+ to which the bitcoin will be converted. You will be paid out in this
7844
+ currency. Only USD is currently supported.
7557
7845
  title: currency
7558
7846
  type:
7559
7847
  - string
@@ -7762,7 +8050,8 @@ paths:
7762
8050
  type:
7763
8051
  - boolean
7764
8052
  object:
7765
- description: The type of object. Always has the value "list".
8053
+ description: String representing the object's type. Objects of the
8054
+ same type share the same value. Always has the value "list".
7766
8055
  enum:
7767
8056
  - list
7768
8057
  type:
@@ -7845,7 +8134,8 @@ paths:
7845
8134
  type:
7846
8135
  - boolean
7847
8136
  object:
7848
- description: The type of object. Always has the value "list".
8137
+ description: String representing the object's type. Objects of the
8138
+ same type share the same value. Always has the value "list".
7849
8139
  enum:
7850
8140
  - list
7851
8141
  type:
@@ -7957,7 +8247,8 @@ paths:
7957
8247
  type:
7958
8248
  - boolean
7959
8249
  object:
7960
- description: The type of object. Always has the value "list".
8250
+ description: String representing the object's type. Objects of the
8251
+ same type share the same value. Always has the value "list".
7961
8252
  enum:
7962
8253
  - list
7963
8254
  type:
@@ -8176,10 +8467,10 @@ paths:
8176
8467
  schema:
8177
8468
  "$ref": "#/definitions/error"
8178
8469
  post:
8179
- description: |-
8180
- <p>Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
8181
-
8182
- <p>This request accepts only the <code>description</code>, <code>metadata</code>, <code>receipt_email</code>, <code>fraud_details</code>, and <code>shipping</code> as arguments.</p>
8470
+ description: "<p>Updates the specified charge by setting the values of the parameters
8471
+ passed. Any parameters not provided will be left unchanged.</p><p>This request
8472
+ accepts only the <code>description</code>, <code>metadata</code>, <code>receipt_email</code>,
8473
+ <code>fraud_details</code>, and <code>shipping</code> as arguments.</p>"
8183
8474
  operationId: UpdateCharge
8184
8475
  parameters:
8185
8476
  - description: Body parameters for the request.
@@ -8209,9 +8500,11 @@ paths:
8209
8500
  type:
8210
8501
  - object
8211
8502
  metadata:
8212
- description: A set of key/value pairs that you can attach to a charge
8213
- object. It can be useful for storing additional information about
8214
- the charge in a structured format.
8503
+ description: Set of key/value pairs that you can attach to an object.
8504
+ It can be useful for storing additional information about the object
8505
+ in a structured format. Individual keys can be unset by posting an
8506
+ empty value to them. All keys can be unset by posting an empty value
8507
+ to metadata.
8215
8508
  title: metadata
8216
8509
  type:
8217
8510
  - object
@@ -8247,10 +8540,12 @@ paths:
8247
8540
  "$ref": "#/definitions/error"
8248
8541
  "/v1/charges/{charge}/capture":
8249
8542
  post:
8250
- description: |-
8251
- <p>Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you <a href="#create_charge">created a charge</a> with the capture option set to false.</p>
8252
-
8253
- <p>Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.</p>
8543
+ description: <p>Capture the payment of an existing, uncaptured, charge. This
8544
+ is the second half of the two-step payment flow, where first you <a href="#create_charge">created
8545
+ a charge</a> with the capture option set to false.</p><p>Uncaptured payments
8546
+ expire exactly seven days after they are created. If they are not captured
8547
+ by that point in time, they will be marked as refunded and will no longer
8548
+ be capturable.</p>
8254
8549
  operationId: ChargeCapture
8255
8550
  parameters:
8256
8551
  - description: ''
@@ -8501,7 +8796,8 @@ paths:
8501
8796
  type:
8502
8797
  - boolean
8503
8798
  object:
8504
- description: The type of object. Always has the value "list".
8799
+ description: String representing the object's type. Objects of the
8800
+ same type share the same value. Always has the value "list".
8505
8801
  enum:
8506
8802
  - list
8507
8803
  type:
@@ -8681,7 +8977,8 @@ paths:
8681
8977
  type:
8682
8978
  - boolean
8683
8979
  object:
8684
- description: The type of object. Always has the value "list".
8980
+ description: String representing the object's type. Objects of the
8981
+ same type share the same value. Always has the value "list".
8685
8982
  enum:
8686
8983
  - list
8687
8984
  type:
@@ -8780,7 +9077,8 @@ paths:
8780
9077
  type:
8781
9078
  - boolean
8782
9079
  object:
8783
- description: The type of object. Always has the value "list".
9080
+ description: String representing the object's type. Objects of the
9081
+ same type share the same value. Always has the value "list".
8784
9082
  enum:
8785
9083
  - list
8786
9084
  type:
@@ -8808,10 +9106,17 @@ paths:
8808
9106
  schema:
8809
9107
  "$ref": "#/definitions/error"
8810
9108
  post:
8811
- description: |-
8812
- <p>You can create coupons easily via the <a href="https://dashboard.stripe.com/coupons">coupon management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.</p>
8813
-
8814
- <p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency> will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it and an invoice with a subtotal of <currency>300</currency> will have a final total of <currency>100</currency> if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied to it.</p>
9109
+ description: <p>You can create coupons easily via the <a href="https://dashboard.stripe.com/coupons">coupon
9110
+ management</a> page of the Stripe dashboard. Coupon creation is also accessible
9111
+ via the API if you need to create coupons on the fly.</p><p>A coupon has either
9112
+ a <code>percent_off</code> or an <code>amount_off</code> and <code>currency</code>.
9113
+ If you set an <code>amount_off</code>, that amount will be subtracted from
9114
+ any invoice’s subtotal. For example, an invoice with a subtotal of <currency>100</currency>
9115
+ will have a final total of <currency>0</currency> if a coupon with an <code>amount_off</code>
9116
+ of <amount>200</amount> is applied to it and an invoice with a subtotal of
9117
+ <currency>300</currency> will have a final total of <currency>100</currency>
9118
+ if a coupon with an <code>amount_off</code> of <amount>200</amount> is applied
9119
+ to it.</p>
8815
9120
  operationId: CreateCoupon
8816
9121
  parameters:
8817
9122
  - description: Body parameters for the request.
@@ -8827,8 +9132,8 @@ paths:
8827
9132
  type:
8828
9133
  - integer
8829
9134
  currency:
8830
- description: Currency of the `amount_off` parameter (required if `amount_off`
8831
- is passed).
9135
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
9136
+ of the `amount_off` parameter (required if `amount_off` is passed).
8832
9137
  title: currency
8833
9138
  type:
8834
9139
  - string
@@ -8894,7 +9199,7 @@ paths:
8894
9199
  "$ref": "#/definitions/error"
8895
9200
  "/v1/coupons/{coupon}":
8896
9201
  delete:
8897
- description: <p>You can delete coupons via the <a href="http://dashboard:6090/coupons">coupon
9202
+ description: <p>You can delete coupons via the <a href="https://dashboard.stripe.com/coupons">coupon
8898
9203
  management</a> page of the Stripe dashboard. However, deleting a coupon does
8899
9204
  not affect any customers who have already applied the coupon; it means that
8900
9205
  new customers can’t redeem the coupon. You can also delete coupons via the
@@ -9021,7 +9326,8 @@ paths:
9021
9326
  type:
9022
9327
  - boolean
9023
9328
  object:
9024
- description: The type of object. Always has the value "list".
9329
+ description: String representing the object's type. Objects of the
9330
+ same type share the same value. Always has the value "list".
9025
9331
  enum:
9026
9332
  - list
9027
9333
  type:
@@ -9328,7 +9634,8 @@ paths:
9328
9634
  type:
9329
9635
  - boolean
9330
9636
  object:
9331
- description: The type of object. Always has the value "list".
9637
+ description: String representing the object's type. Objects of the
9638
+ same type share the same value. Always has the value "list".
9332
9639
  enum:
9333
9640
  - list
9334
9641
  type:
@@ -9479,7 +9786,8 @@ paths:
9479
9786
  type:
9480
9787
  - boolean
9481
9788
  object:
9482
- description: The type of object. Always has the value "list".
9789
+ description: String representing the object's type. Objects of the
9790
+ same type share the same value. Always has the value "list".
9483
9791
  enum:
9484
9792
  - list
9485
9793
  type:
@@ -9758,7 +10066,8 @@ paths:
9758
10066
  type:
9759
10067
  - boolean
9760
10068
  object:
9761
- description: The type of object. Always has the value "list".
10069
+ description: String representing the object's type. Objects of the
10070
+ same type share the same value. Always has the value "list".
9762
10071
  enum:
9763
10072
  - list
9764
10073
  type:
@@ -10022,7 +10331,8 @@ paths:
10022
10331
  type:
10023
10332
  - boolean
10024
10333
  object:
10025
- description: The type of object. Always has the value "list".
10334
+ description: String representing the object's type. Objects of the
10335
+ same type share the same value. Always has the value "list".
10026
10336
  enum:
10027
10337
  - list
10028
10338
  type:
@@ -10297,7 +10607,8 @@ paths:
10297
10607
  type:
10298
10608
  - boolean
10299
10609
  object:
10300
- description: The type of object. Always has the value "list".
10610
+ description: String representing the object's type. Objects of the
10611
+ same type share the same value. Always has the value "list".
10301
10612
  enum:
10302
10613
  - list
10303
10614
  type:
@@ -10349,7 +10660,7 @@ paths:
10349
10660
  invoice subtotal that will be transferred to the application owner's
10350
10661
  Stripe account. The request must be made with an OAuth key in order
10351
10662
  to set an application fee percentage. For more information, see the
10352
- application fees [documentation](http://127.0.0.1:6040/docs/connect/collecting-fees#subscriptions).
10663
+ application fees [documentation]('https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
10353
10664
  title: application_fee_percent
10354
10665
  type:
10355
10666
  - number
@@ -10423,15 +10734,15 @@ paths:
10423
10734
  - boolean
10424
10735
  source:
10425
10736
  description: The source can either be a token, like the ones returned
10426
- by [Elements](http://127.0.0.1:6040/docs/elements), or a dictionary
10427
- containing a user's credit card details (with the options shown below).
10428
- You must provide a source if the customer does not already have a
10429
- valid source attached, and you are subscribing the customer for a
10430
- plan that is not free. Passing `source` will create a new source object,
10431
- make it the customer default source, and delete the old customer default
10432
- if one exists. If you want to add an additional source to use with
10433
- subscriptions, instead use the [card creation API](http://127.0.0.1:6040/docs/api#create_card)
10434
- to add the card and then the [customer update API](http://127.0.0.1:6040/docs/api#update
10737
+ by [Elements](https://stripe.com/docs/elements), or a dictionary containing
10738
+ a user's credit card details (with the options shown below). You must
10739
+ provide a source if the customer does not already have a valid source
10740
+ attached, and you are subscribing the customer for a plan that is
10741
+ not free. Passing `source` will create a new source object, make it
10742
+ the customer default source, and delete the old customer default if
10743
+ one exists. If you want to add an additional source to use with subscriptions,
10744
+ instead use the [card creation API](https://stripe.com/docs/api#create_card)
10745
+ to add the card and then the [customer update API](https://stripe.com/docs/api#update
10435
10746
  customer) to set it as the default. Whenever you attach a card to
10436
10747
  a customer, Stripe will automatically validate the card.
10437
10748
  title: source
@@ -10476,10 +10787,22 @@ paths:
10476
10787
  "$ref": "#/definitions/error"
10477
10788
  "/v1/customers/{customer}/subscriptions/{subscription_exposed_id}":
10478
10789
  delete:
10479
- description: |-
10480
- <p>Cancels a customer’s subscription. If you set the <code>at_period_end</code> parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. By default, the subscription is terminated immediately. In either case, 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 <a href="#delete_invoiceitem">deleted</a>. If you’ve set the subscription to cancel at period end, 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.</p>
10481
-
10482
- <p>By default, all unpaid invoices for the customer will be closed upon subscription cancellation. We do this in order to prevent unexpected payment retries once the customer has canceled a subscription. However, you can reopen the invoices manually after subscription cancellation to have us proceed with automatic retries, or you could even re-attempt payment yourself on all unpaid invoices before allowing the customer to cancel the subscription at all.</p>
10790
+ description: <p>Cancels a customer’s subscription. If you set the <code>at_period_end</code>
10791
+ parameter to true, the subscription will remain active until the end of the
10792
+ period, at which point it will be canceled and not renewed. By default, the
10793
+ subscription is terminated immediately. In either case, the customer will
10794
+ not be charged again for the subscription. Note, however, that any pending
10795
+ invoice items that you’ve created will still be charged for at the end of
10796
+ the period unless manually <a href="#delete_invoiceitem">deleted</a>. If you’ve
10797
+ set the subscription to cancel at period end, any pending prorations will
10798
+ also be left in place and collected at the end of the period, but if the subscription
10799
+ is set to cancel immediately, pending prorations will be removed.</p><p>By
10800
+ default, all unpaid invoices for the customer will be closed upon subscription
10801
+ cancellation. We do this in order to prevent unexpected payment retries once
10802
+ the customer has canceled a subscription. However, you can reopen the invoices
10803
+ manually after subscription cancellation to have us proceed with automatic
10804
+ retries, or you could even re-attempt payment yourself on all unpaid invoices
10805
+ before allowing the customer to cancel the subscription at all.</p>
10483
10806
  operationId: DeleteCustomerSubscription
10484
10807
  parameters:
10485
10808
  - description: Body parameters for the request.
@@ -10541,7 +10864,7 @@ paths:
10541
10864
  invoice subtotal that will be transferred to the application owner's
10542
10865
  Stripe account. The request must be made with an OAuth key in order
10543
10866
  to set an application fee percentage. For more information, see the
10544
- application fees [documentation](http://127.0.0.1:6040/docs/connect/collecting-fees#subscriptions).
10867
+ application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions')}).
10545
10868
  title: application_fee_percent
10546
10869
  type:
10547
10870
  - number
@@ -10632,15 +10955,15 @@ paths:
10632
10955
  - boolean
10633
10956
  source:
10634
10957
  description: The source can either be a token, like the ones returned
10635
- by [Elements](http://127.0.0.1:6040/docs/elements), or a dictionary
10636
- containing a user's credit card details (with the options shown below).
10637
- You must provide a source if the customer does not already have a
10638
- valid source attached, and you are subscribing the customer for a
10639
- plan that is not free. Passing `source` will create a new source object,
10640
- make it the customer default source, and delete the old customer default
10641
- if one exists. If you want to add an additional source to use with
10642
- subscriptions, instead use the [card creation API](http://127.0.0.1:6040/docs/api#create_card)
10643
- to add the card and then the [customer update API](http://127.0.0.1:6040/docs/api#update
10958
+ by [Elements](https://stripe.com/docs/elements), or a dictionary containing
10959
+ a user's credit card details (with the options shown below). You must
10960
+ provide a source if the customer does not already have a valid source
10961
+ attached, and you are subscribing the customer for a plan that is
10962
+ not free. Passing `source` will create a new source object, make it
10963
+ the customer default source, and delete the old customer default if
10964
+ one exists. If you want to add an additional source to use with subscriptions,
10965
+ instead use the [card creation API](https://stripe.com/docs/api#create_card)
10966
+ to add the card and then the [customer update API](https://stripe.com/docs/api#update
10644
10967
  customer) to set it as the default. Whenever you attach a card to
10645
10968
  a customer, Stripe will automatically validate the card.
10646
10969
  title: source
@@ -10757,7 +11080,8 @@ paths:
10757
11080
  type:
10758
11081
  - boolean
10759
11082
  object:
10760
- description: The type of object. Always has the value "list".
11083
+ description: String representing the object's type. Objects of the
11084
+ same type share the same value. Always has the value "list".
10761
11085
  enum:
10762
11086
  - list
10763
11087
  type:
@@ -10804,10 +11128,13 @@ paths:
10804
11128
  schema:
10805
11129
  "$ref": "#/definitions/error"
10806
11130
  post:
10807
- description: |-
10808
- <p>When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence in order to help us resolve the dispute in your favor. You can do this in your <a href="http://dashboard:6090/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p>
10809
-
10810
- <p>Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. You may want to consult our <a href="http://127.0.0.1:6040/help/dispute-types">guide to dispute types</a> to help you figure out which evidence fields to provide.</p>
11131
+ description: <p>When you get a dispute, contacting your customer is always the
11132
+ best first step. If that doesn’t work, you can submit evidence in order to
11133
+ help us resolve the dispute in your favor. You can do this in your <a href="https://dashboard.stripe.com/disputes">dashboard</a>,
11134
+ but if you prefer, you can use the API to submit evidence programmatically.</p><p>Depending
11135
+ on your dispute type, different evidence fields will give you a better chance
11136
+ of winning your dispute. You may want to consult our <a href="https://stripe.com/help/dispute-types">guide
11137
+ to dispute types</a> to help you figure out which evidence fields to provide.</p>
10811
11138
  operationId: UpdateDispute
10812
11139
  parameters:
10813
11140
  - description: ID of the dispute to update.
@@ -10845,10 +11172,11 @@ paths:
10845
11172
  "$ref": "#/definitions/error"
10846
11173
  "/v1/disputes/{dispute}/close":
10847
11174
  post:
10848
- description: |-
10849
- <p>Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially ‘dismissing’ the dispute, acknowledging it as lost</p>
10850
-
10851
- <p>The status of the dispute will change from <code>needs_response</code> to <code>lost</code>. <strong>Closing a dispute is irreversible</strong>.</p>
11175
+ description: "<p>Closing the dispute for a charge indicates that you do not
11176
+ have any evidence to submit and are essentially ‘dismissing’ the dispute,
11177
+ acknowledging it as lost</p><p>The status of the dispute will change from
11178
+ <code>needs_response</code> to <code>lost</code>. <strong>Closing a dispute
11179
+ is irreversible</strong>.</p>"
10852
11180
  operationId: CloseDispute
10853
11181
  parameters:
10854
11182
  - description: ID of dispute to close.
@@ -10929,7 +11257,8 @@ paths:
10929
11257
  type:
10930
11258
  - boolean
10931
11259
  object:
10932
- description: The type of object. Always has the value "list".
11260
+ description: String representing the object's type. Objects of the
11261
+ same type share the same value. Always has the value "list".
10933
11262
  enum:
10934
11263
  - list
10935
11264
  type:
@@ -11053,7 +11382,8 @@ paths:
11053
11382
  type:
11054
11383
  - boolean
11055
11384
  object:
11056
- description: The type of object. Always has the value "list".
11385
+ description: String representing the object's type. Objects of the
11386
+ same type share the same value. Always has the value "list".
11057
11387
  enum:
11058
11388
  - list
11059
11389
  type:
@@ -11099,7 +11429,8 @@ paths:
11099
11429
  type:
11100
11430
  - integer
11101
11431
  currency:
11102
- description: 3-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
11432
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
11433
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
11103
11434
  title: currency
11104
11435
  type:
11105
11436
  - string
@@ -11309,7 +11640,8 @@ paths:
11309
11640
  type:
11310
11641
  - boolean
11311
11642
  object:
11312
- description: The type of object. Always has the value "list".
11643
+ description: String representing the object's type. Objects of the
11644
+ same type share the same value. Always has the value "list".
11313
11645
  enum:
11314
11646
  - list
11315
11647
  type:
@@ -11337,10 +11669,12 @@ paths:
11337
11669
  schema:
11338
11670
  "$ref": "#/definitions/error"
11339
11671
  post:
11340
- description: |-
11341
- <p>If you need to invoice your customer outside the regular billing cycle, you can create an invoice that pulls in all pending invoice items, including prorations. The customer’s billing cycle and regular subscription won’t be affected.</p>
11342
-
11343
- <p>Once you create the invoice, it’ll be picked up and paid automatically, though you can choose to <a href="#pay_invoice">pay it right</a> away.</p>
11672
+ description: <p>If you need to invoice your customer outside the regular billing
11673
+ cycle, you can create an invoice that pulls in all pending invoice items,
11674
+ including prorations. The customer’s billing cycle and regular subscription
11675
+ won’t be affected.</p><p>Once you create the invoice, it’ll be picked up and
11676
+ paid automatically, though you can choose to <a href="#pay_invoice">pay it
11677
+ right</a> away.</p>
11344
11678
  operationId: CreateInvoice
11345
11679
  parameters:
11346
11680
  - description: Body parameters for the request.
@@ -11353,7 +11687,7 @@ paths:
11353
11687
  description: A fee in %s that will be applied to the invoice and transferred
11354
11688
  to the application owner's Stripe account. The request must be made
11355
11689
  with an OAuth key or the Stripe-Account header in order to take an
11356
- application fee. For more information, see the application fees [documentation](/docs/connect/collecting-fees#subscriptions).
11690
+ application fee. For more information, see the application fees [documentation](/docs/connect/subscriptions#working-with-invoices).
11357
11691
  title: application_fee
11358
11692
  type:
11359
11693
  - integer
@@ -11424,12 +11758,24 @@ paths:
11424
11758
  "$ref": "#/definitions/error"
11425
11759
  "/v1/invoices/upcoming":
11426
11760
  get:
11427
- description: |-
11428
- <p>At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discount that is applicable to the customer.</p>
11429
-
11430
- <p>Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.</p>
11431
-
11432
- <p>You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a <code>proration_date</code> parameter when doing the actual subscription update. The value passed in should be the same as the <code>subscription_proration_date</code> returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where <code>period[start]</code> is equal to the <code>subscription_proration_date</code> on the upcoming invoice resource.</p>
11761
+ description: "<p>At any time, you can preview the upcoming invoice for a customer.
11762
+ This will show you all the charges that are pending, including subscription
11763
+ renewal charges, invoice item charges, etc. It will also show you any discount
11764
+ that is applicable to the customer.</p><p>Note that when you are viewing an
11765
+ upcoming invoice, you are simply viewing a preview – the invoice has not yet
11766
+ been created. As such, the upcoming invoice will not show up in invoice listing
11767
+ calls, and you cannot use the API to pay or edit the invoice. If you want
11768
+ to change the amount that your customer will be billed, you can add, remove,
11769
+ or update pending invoice items, or update the customer’s discount.</p><p>You
11770
+ can preview the effects of updating a subscription, including a preview of
11771
+ what proration will take place. To ensure that the actual proration is calculated
11772
+ exactly the same as the previewed proration, you should pass a <code>proration_date</code>
11773
+ parameter when doing the actual subscription update. The value passed in should
11774
+ be the same as the <code>subscription_proration_date</code> returned on the
11775
+ upcoming invoice resource. The recommended way to get only the prorations
11776
+ being previewed is to consider only proration line items where <code>period[start]</code>
11777
+ is equal to the <code>subscription_proration_date</code> on the upcoming invoice
11778
+ resource.</p>"
11433
11779
  operationId: RetrieveCustomerUpcomingInvoice
11434
11780
  parameters:
11435
11781
  - description: The identifier of the customer whose upcoming invoice you'd like
@@ -11552,7 +11898,7 @@ paths:
11552
11898
  description: A fee in %s that will be applied to the invoice and transferred
11553
11899
  to the application owner's Stripe account. The request must be made
11554
11900
  with an OAuth key or the Stripe-Account header in order to take an
11555
- application fee. For more information, see the application fees [documentation](/docs/connect/collecting-fees#subscriptions).
11901
+ application fee. For more information, see the application fees [documentation](/docs/connect/subscriptions#working-with-invoices).
11556
11902
  title: application_fee
11557
11903
  type:
11558
11904
  - integer
@@ -11734,7 +12080,8 @@ paths:
11734
12080
  type:
11735
12081
  - boolean
11736
12082
  object:
11737
- description: The type of object. Always has the value "list".
12083
+ description: String representing the object's type. Objects of the
12084
+ same type share the same value. Always has the value "list".
11738
12085
  enum:
11739
12086
  - list
11740
12087
  type:
@@ -11764,7 +12111,7 @@ paths:
11764
12111
  post:
11765
12112
  description: <p>Stripe automatically creates and then attempts to pay invoices
11766
12113
  for customers on subscriptions. We’ll also retry unpaid invoices according
11767
- to your <a href="http://dashboard:6090/account/recurring">retry settings</a>.
12114
+ to your <a href="https://dashboard.stripe.com/account/recurring">retry settings</a>.
11768
12115
  However, if you’d like to attempt to collect payment on an invoice out of
11769
12116
  the normal retry schedule or for some other reason, you can do so.</p>
11770
12117
  operationId: PayInvoice
@@ -11839,7 +12186,8 @@ paths:
11839
12186
  type:
11840
12187
  - boolean
11841
12188
  object:
11842
- description: The type of object. Always has the value "list".
12189
+ description: String representing the object's type. Objects of the
12190
+ same type share the same value. Always has the value "list".
11843
12191
  enum:
11844
12192
  - list
11845
12193
  type:
@@ -11965,7 +12313,8 @@ paths:
11965
12313
  type:
11966
12314
  - boolean
11967
12315
  object:
11968
- description: The type of object. Always has the value "list".
12316
+ description: String representing the object's type. Objects of the
12317
+ same type share the same value. Always has the value "list".
11969
12318
  enum:
11970
12319
  - list
11971
12320
  type:
@@ -12010,10 +12359,8 @@ paths:
12010
12359
  type:
12011
12360
  - string
12012
12361
  currency:
12013
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
12014
- representing the currency in which the order should be made. Stripe
12015
- will validate that all entries in `items` match the currency specified
12016
- here.
12362
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
12363
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
12017
12364
  title: currency
12018
12365
  type:
12019
12366
  - string
@@ -12297,7 +12644,8 @@ paths:
12297
12644
  type:
12298
12645
  - boolean
12299
12646
  object:
12300
- description: The type of object. Always has the value "list".
12647
+ description: String representing the object's type. Objects of the
12648
+ same type share the same value. Always has the value "list".
12301
12649
  enum:
12302
12650
  - list
12303
12651
  type:
@@ -12343,6 +12691,258 @@ paths:
12343
12691
  description: Error response.
12344
12692
  schema:
12345
12693
  "$ref": "#/definitions/error"
12694
+ "/v1/payouts":
12695
+ get:
12696
+ description: "<p>Returns a list of existing payouts sent to third-party bank
12697
+ accounts or that Stripe has sent you. The payouts are returned in sorted order,
12698
+ with the most recently created payouts appearing first.</p>"
12699
+ operationId: PayoutAll
12700
+ parameters:
12701
+ - description: A limit on the number of objects to be returned. Limit can range
12702
+ between 1 and 100 items.
12703
+ in: query
12704
+ name: limit
12705
+ required: false
12706
+ type: integer
12707
+ - description: A cursor for use in pagination. `starting_after` is an object
12708
+ ID that defines your place in the list. For instance, if you make a list
12709
+ request and receive 100 objects, ending with `obj_foo`, your subsequent
12710
+ call can include `starting_after=obj_foo` in order to fetch the next page
12711
+ of the list.
12712
+ in: query
12713
+ name: starting_after
12714
+ required: false
12715
+ type: string
12716
+ - description: A cursor for use in pagination. `ending_before` is an object
12717
+ ID that defines your place in the list. For instance, if you make a list
12718
+ request and receive 100 objects, starting with `obj_bar`, your subsequent
12719
+ call can include `ending_before=obj_bar` in order to fetch the previous
12720
+ page of the list.
12721
+ in: query
12722
+ name: ending_before
12723
+ required: false
12724
+ type: string
12725
+ - description: ''
12726
+ in: query
12727
+ name: arrival_date
12728
+ required: false
12729
+ type: integer
12730
+ - description: ''
12731
+ in: query
12732
+ name: created
12733
+ required: false
12734
+ type: integer
12735
+ - description: The ID of an external account - only return payouts sent to this
12736
+ external account.
12737
+ in: query
12738
+ name: destination
12739
+ required: false
12740
+ type: string
12741
+ - description: 'Only return payouts that have the given status: `pending`, `paid`,
12742
+ `failed`, `in_transit`, or `canceled`.'
12743
+ in: query
12744
+ name: status
12745
+ required: false
12746
+ type: string
12747
+ responses:
12748
+ '200':
12749
+ description: Successful response.
12750
+ schema:
12751
+ properties:
12752
+ data:
12753
+ items:
12754
+ "$ref": "#/definitions/payout"
12755
+ type:
12756
+ - array
12757
+ has_more:
12758
+ description: True if this list has another page of items after this
12759
+ one that can be fetched.
12760
+ type:
12761
+ - boolean
12762
+ object:
12763
+ description: String representing the object's type. Objects of the
12764
+ same type share the same value. Always has the value "list".
12765
+ enum:
12766
+ - list
12767
+ type:
12768
+ - string
12769
+ total_count:
12770
+ description: The total number of items available. This value is not
12771
+ included by default, but you can request it by specifying ?include[]=total_count.
12772
+ type:
12773
+ - integer
12774
+ url:
12775
+ description: The URL where this list can be accessed.
12776
+ enum:
12777
+ - "/v1/payouts"
12778
+ type:
12779
+ - string
12780
+ required:
12781
+ - data
12782
+ - has_more
12783
+ - object
12784
+ - url
12785
+ title: PayoutList
12786
+ type:
12787
+ - object
12788
+ default:
12789
+ description: Error response.
12790
+ schema:
12791
+ "$ref": "#/definitions/error"
12792
+ post:
12793
+ description: <p>To send funds to your own bank account, you create a new payout
12794
+ object. Your <a href="#balance">Stripe balance</a> must be able to cover the
12795
+ payout amount, or you’ll receive an “Insufficient Funds” error.</p><p>If your
12796
+ API key is in test mode, money won’t actually be sent, though everything else
12797
+ will occur as if in live mode.</p><p>If you are creating a manual payout on
12798
+ a Stripe account that uses multiple payment source types, you’ll need to specify
12799
+ the source type balance that the payout should draw from. The <a href="#balance_object">balance
12800
+ object</a> details available and pending amounts by source type.</p>
12801
+ operationId: PayoutCreate
12802
+ parameters:
12803
+ - description: Body parameters for the request.
12804
+ in: body
12805
+ name: payload
12806
+ required: true
12807
+ schema:
12808
+ properties:
12809
+ amount:
12810
+ description: A positive integer in cents representing how much to payout.
12811
+ title: amount
12812
+ type:
12813
+ - integer
12814
+ currency:
12815
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
12816
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
12817
+ title: currency
12818
+ type:
12819
+ - string
12820
+ destination:
12821
+ description: The id of a bank account or a card to send the payout to.
12822
+ If no destination is supplied, the default external account for the
12823
+ specified currency will be used.
12824
+ title: destination
12825
+ type:
12826
+ - string
12827
+ metadata:
12828
+ description: A set of key/value pairs that you can attach to a payout
12829
+ object. It can be useful for storing additional information about
12830
+ the payout in a structured format.
12831
+ title: metadata
12832
+ type:
12833
+ - object
12834
+ method:
12835
+ description: The method used to send this payout, which can be `standard`
12836
+ or `instant`. `instant` is only supported for payouts to debit cards.
12837
+ (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).)
12838
+ title: method
12839
+ type:
12840
+ - string
12841
+ source_type:
12842
+ description: 'The source balance to draw this payout from. Balances
12843
+ for different payment sources are kept separately. You can find the
12844
+ amounts with the balances API. Valid options are: `alipay_account`,
12845
+ `bank_account`, `bitcoin_receiver`, and `card`.'
12846
+ title: source_type
12847
+ type:
12848
+ - string
12849
+ statement_descriptor:
12850
+ description: 'A string to be displayed on the recipient''s bank or card
12851
+ statement. This may be at most 22 characters. Attempting to use a
12852
+ `statement_descriptor` longer than 22 characters will return an error.
12853
+ Note: Most banks will truncate this information and/or display it
12854
+ inconsistently. Some may not display it at all.'
12855
+ title: statement_descriptor
12856
+ type:
12857
+ - string
12858
+ required:
12859
+ - amount
12860
+ - currency
12861
+ responses:
12862
+ '200':
12863
+ description: Successful response.
12864
+ schema:
12865
+ "$ref": "#/definitions/payout"
12866
+ default:
12867
+ description: Error response.
12868
+ schema:
12869
+ "$ref": "#/definitions/error"
12870
+ "/v1/payouts/{id}":
12871
+ get:
12872
+ description: "<p>Retrieves the details of an existing payout. Supply the unique
12873
+ payout ID from either a payout creation request or the payout list, and Stripe
12874
+ will return the corresponding payout information.</p>"
12875
+ operationId: PayoutRetrieve
12876
+ parameters:
12877
+ - description: The identifier of the payout to be retrieved.
12878
+ in: path
12879
+ name: id
12880
+ required: true
12881
+ type: string
12882
+ responses:
12883
+ '200':
12884
+ description: Successful response.
12885
+ schema:
12886
+ "$ref": "#/definitions/payout"
12887
+ default:
12888
+ description: Error response.
12889
+ schema:
12890
+ "$ref": "#/definitions/error"
12891
+ post:
12892
+ description: "<p>Updates the specified payout by setting the values of the parameters
12893
+ passed. Any parameters not provided will be left unchanged. This request accepts
12894
+ only the metadata as arguments.</p>"
12895
+ operationId: PayoutUpdate
12896
+ parameters:
12897
+ - description: The identifier of the payout to be updated.
12898
+ in: path
12899
+ name: id
12900
+ required: true
12901
+ type: string
12902
+ - description: Body parameters for the request.
12903
+ in: body
12904
+ name: payload
12905
+ required: false
12906
+ schema:
12907
+ properties:
12908
+ metadata:
12909
+ description: A set of key/value pairs that you can attach to a payout
12910
+ object. It can be useful for storing additional information about
12911
+ the payout in a structured format.
12912
+ title: metadata
12913
+ type:
12914
+ - object
12915
+ responses:
12916
+ '200':
12917
+ description: Successful response.
12918
+ schema:
12919
+ "$ref": "#/definitions/payout"
12920
+ default:
12921
+ description: Error response.
12922
+ schema:
12923
+ "$ref": "#/definitions/error"
12924
+ "/v1/payouts/{id}/cancel":
12925
+ post:
12926
+ description: "<p>A previously created payout can be canceled if it has not yet
12927
+ been paid out. Funds will be refunded to your available balance, and the fees
12928
+ you were originally charged on the payout will be refunded. You may not cancel
12929
+ automatic Stripe payouts.</p>"
12930
+ operationId: PayoutCancel
12931
+ parameters:
12932
+ - description: The identifier of the payout to be canceled.
12933
+ in: path
12934
+ name: id
12935
+ required: true
12936
+ type: string
12937
+ responses:
12938
+ '200':
12939
+ description: Successful response.
12940
+ schema:
12941
+ "$ref": "#/definitions/payout"
12942
+ default:
12943
+ description: Error response.
12944
+ schema:
12945
+ "$ref": "#/definitions/error"
12346
12946
  "/v1/plans":
12347
12947
  get:
12348
12948
  description: "<p>Returns a list of your plans.</p>"
@@ -12395,7 +12995,8 @@ paths:
12395
12995
  type:
12396
12996
  - boolean
12397
12997
  object:
12398
- description: The type of object. Always has the value "list".
12998
+ description: String representing the object's type. Objects of the
12999
+ same type share the same value. Always has the value "list".
12399
13000
  enum:
12400
13001
  - list
12401
13002
  type:
@@ -12441,7 +13042,8 @@ paths:
12441
13042
  type:
12442
13043
  - integer
12443
13044
  currency:
12444
- description: 3-letter [ISO code for currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
13045
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
13046
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
12445
13047
  title: currency
12446
13048
  type:
12447
13049
  - string
@@ -12517,7 +13119,7 @@ paths:
12517
13119
  "$ref": "#/definitions/error"
12518
13120
  "/v1/plans/{plan}":
12519
13121
  delete:
12520
- description: <p>You can delete plans via the <a href="http://dashboard:6090/plans">plan
13122
+ description: <p>You can delete plans via the <a href="https://dashboard.stripe.com/plans">plan
12521
13123
  management</a> page of the Stripe dashboard. However, deleting a plan does
12522
13124
  not affect any current subscribers to the plan; it merely means that new subscribers
12523
13125
  can’t be added to that plan. You can also delete plans via the API.</p>
@@ -12683,7 +13285,8 @@ paths:
12683
13285
  type:
12684
13286
  - boolean
12685
13287
  object:
12686
- description: The type of object. Always has the value "list".
13288
+ description: String representing the object's type. Objects of the
13289
+ same type share the same value. Always has the value "list".
12687
13290
  enum:
12688
13291
  - list
12689
13292
  type:
@@ -12844,10 +13447,11 @@ paths:
12844
13447
  schema:
12845
13448
  "$ref": "#/definitions/error"
12846
13449
  post:
12847
- description: |-
12848
- <p>Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
12849
-
12850
- <p>Note that a product’s <code>attributes</code> are not editable. Instead, you would need to deactivate the existing product and create a new one with the new attribute values.</p>
13450
+ description: "<p>Updates the specific product by setting the values of the parameters
13451
+ passed. Any parameters not provided will be left unchanged.</p><p>Note that
13452
+ a product’s <code>attributes</code> are not editable. Instead, you would need
13453
+ to deactivate the existing product and create a new one with the new attribute
13454
+ values.</p>"
12851
13455
  operationId: UpdateProduct
12852
13456
  parameters:
12853
13457
  - description: Body parameters for the request.
@@ -12998,7 +13602,8 @@ paths:
12998
13602
  type:
12999
13603
  - boolean
13000
13604
  object:
13001
- description: The type of object. Always has the value "list".
13605
+ description: String representing the object's type. Objects of the
13606
+ same type share the same value. Always has the value "list".
13002
13607
  enum:
13003
13608
  - list
13004
13609
  type:
@@ -13338,7 +13943,8 @@ paths:
13338
13943
  type:
13339
13944
  - boolean
13340
13945
  object:
13341
- description: The type of object. Always has the value "list".
13946
+ description: String representing the object's type. Objects of the
13947
+ same type share the same value. Always has the value "list".
13342
13948
  enum:
13343
13949
  - list
13344
13950
  type:
@@ -13559,7 +14165,8 @@ paths:
13559
14165
  type:
13560
14166
  - boolean
13561
14167
  object:
13562
- description: The type of object. Always has the value "list".
14168
+ description: String representing the object's type. Objects of the
14169
+ same type share the same value. Always has the value "list".
13563
14170
  enum:
13564
14171
  - list
13565
14172
  type:
@@ -13662,10 +14269,9 @@ paths:
13662
14269
  schema:
13663
14270
  "$ref": "#/definitions/error"
13664
14271
  post:
13665
- description: |-
13666
- <p>Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
13667
-
13668
- <p>This request only accepts <code>metadata</code> as an argument.</p>
14272
+ description: "<p>Updates the specified refund by setting the values of the parameters
14273
+ passed. Any parameters not provided will be left unchanged.</p><p>This request
14274
+ only accepts <code>metadata</code> as an argument.</p>"
13669
14275
  operationId: UpdateRefund
13670
14276
  parameters:
13671
14277
  - description: Body parameters for the request.
@@ -13768,7 +14374,8 @@ paths:
13768
14374
  type:
13769
14375
  - boolean
13770
14376
  object:
13771
- description: The type of object. Always has the value "list".
14377
+ description: String representing the object's type. Objects of the
14378
+ same type share the same value. Always has the value "list".
13772
14379
  enum:
13773
14380
  - list
13774
14381
  type:
@@ -13820,8 +14427,8 @@ paths:
13820
14427
  type:
13821
14428
  - object
13822
14429
  currency:
13823
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
13824
- for currency.
14430
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
14431
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
13825
14432
  title: currency
13826
14433
  type:
13827
14434
  - string
@@ -13926,10 +14533,11 @@ paths:
13926
14533
  schema:
13927
14534
  "$ref": "#/definitions/error"
13928
14535
  post:
13929
- description: |-
13930
- <p>Updates the specific SKU by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
13931
-
13932
- <p>Note that a SKU’s <code>attributes</code> are not editable. Instead, you would need to deactivate the existing SKU and create a new one with the new attribute values.</p>
14536
+ description: "<p>Updates the specific SKU by setting the values of the parameters
14537
+ passed. Any parameters not provided will be left unchanged.</p><p>Note that
14538
+ a SKU’s <code>attributes</code> are not editable. Instead, you would need
14539
+ to deactivate the existing SKU and create a new one with the new attribute
14540
+ values.</p>"
13933
14541
  operationId: UpdateSKU
13934
14542
  parameters:
13935
14543
  - description: Body parameters for the request.
@@ -13954,8 +14562,8 @@ paths:
13954
14562
  type:
13955
14563
  - object
13956
14564
  currency:
13957
- description: 3-letter [ISO code](https://support.stripe.com/questions/which-currencies-does-stripe-support)
13958
- for currency.
14565
+ description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
14566
+ in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
13959
14567
  title: currency
13960
14568
  type:
13961
14569
  - string
@@ -14021,11 +14629,6 @@ paths:
14021
14629
  required: false
14022
14630
  schema:
14023
14631
  properties:
14024
- alipay:
14025
- description: ''
14026
- title: alipay
14027
- type:
14028
- - object
14029
14632
  amount:
14030
14633
  description: Amount associated with the source. This is the amount for
14031
14634
  which the source will be chargeable once ready. Required for `single-use`
@@ -14034,8 +14637,9 @@ paths:
14034
14637
  type:
14035
14638
  - integer
14036
14639
  currency:
14037
- description: The currency associated with the source. This is the currency
14038
- for which the source will be chargeable once ready.
14640
+ description: Three-letter [ISO code for the currency](https://support.stripe.com/questions/which-currencies-does-stripe-support)
14641
+ associated with the source. This is the currency for which the source
14642
+ will be chargeable once ready.
14039
14643
  title: currency
14040
14644
  type:
14041
14645
  - string
@@ -14123,10 +14727,9 @@ paths:
14123
14727
  schema:
14124
14728
  "$ref": "#/definitions/error"
14125
14729
  post:
14126
- description: |-
14127
- <p>Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
14128
-
14129
- <p>This request accepts only the <code>metadata</code> and <code>owner</code> as arguments.</p>
14730
+ description: "<p>Updates the specified source by setting the values of the parameters
14731
+ passed. Any parameters not provided will be left unchanged.</p><p>This request
14732
+ accepts only the <code>metadata</code> and <code>owner</code> as arguments.</p>"
14130
14733
  operationId: SourceUpdate
14131
14734
  parameters:
14132
14735
  - description: Body parameters for the request.
@@ -14239,7 +14842,8 @@ paths:
14239
14842
  type:
14240
14843
  - boolean
14241
14844
  object:
14242
- description: The type of object. Always has the value "list".
14845
+ description: String representing the object's type. Objects of the
14846
+ same type share the same value. Always has the value "list".
14243
14847
  enum:
14244
14848
  - list
14245
14849
  type:
@@ -14496,7 +15100,8 @@ paths:
14496
15100
  type:
14497
15101
  - boolean
14498
15102
  object:
14499
- description: The type of object. Always has the value "list".
15103
+ description: String representing the object's type. Objects of the
15104
+ same type share the same value. Always has the value "list".
14500
15105
  enum:
14501
15106
  - list
14502
15107
  type:
@@ -14544,7 +15149,7 @@ paths:
14544
15149
  invoice subtotal that will be transferred to the application owner's
14545
15150
  Stripe account. The request must be made with an OAuth key in order
14546
15151
  to set an application fee percentage. For more information, see the
14547
- application fees [documentation](http://127.0.0.1:6040/docs/connect/collecting-fees#subscriptions).
15152
+ application fees [documentation]('https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
14548
15153
  title: application_fee_percent
14549
15154
  type:
14550
15155
  - number
@@ -14623,15 +15228,15 @@ paths:
14623
15228
  - boolean
14624
15229
  source:
14625
15230
  description: The source can either be a token, like the ones returned
14626
- by [Elements](http://127.0.0.1:6040/docs/elements), or a dictionary
14627
- containing a user's credit card details (with the options shown below).
14628
- You must provide a source if the customer does not already have a
14629
- valid source attached, and you are subscribing the customer for a
14630
- plan that is not free. Passing `source` will create a new source object,
14631
- make it the customer default source, and delete the old customer default
14632
- if one exists. If you want to add an additional source to use with
14633
- subscriptions, instead use the [card creation API](http://127.0.0.1:6040/docs/api#create_card)
14634
- to add the card and then the [customer update API](http://127.0.0.1:6040/docs/api#update
15231
+ by [Elements](https://stripe.com/docs/elements), or a dictionary containing
15232
+ a user's credit card details (with the options shown below). You must
15233
+ provide a source if the customer does not already have a valid source
15234
+ attached, and you are subscribing the customer for a plan that is
15235
+ not free. Passing `source` will create a new source object, make it
15236
+ the customer default source, and delete the old customer default if
15237
+ one exists. If you want to add an additional source to use with subscriptions,
15238
+ instead use the [card creation API](https://stripe.com/docs/api#create_card)
15239
+ to add the card and then the [customer update API](https://stripe.com/docs/api#update
14635
15240
  customer) to set it as the default. Whenever you attach a card to
14636
15241
  a customer, Stripe will automatically validate the card.
14637
15242
  title: source
@@ -14678,10 +15283,22 @@ paths:
14678
15283
  "$ref": "#/definitions/error"
14679
15284
  "/v1/subscriptions/{subscription_exposed_id}":
14680
15285
  delete:
14681
- description: |-
14682
- <p>Cancels a customer’s subscription. If you set the <code>at_period_end</code> parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. By default, the subscription is terminated immediately. In either case, 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 <a href="#delete_invoiceitem">deleted</a>. If you’ve set the subscription to cancel at period end, 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.</p>
14683
-
14684
- <p>By default, all unpaid invoices for the customer will be closed upon subscription cancellation. We do this in order to prevent unexpected payment retries once the customer has canceled a subscription. However, you can reopen the invoices manually after subscription cancellation to have us proceed with automatic retries, or you could even re-attempt payment yourself on all unpaid invoices before allowing the customer to cancel the subscription at all.</p>
15286
+ description: <p>Cancels a customer’s subscription. If you set the <code>at_period_end</code>
15287
+ parameter to true, the subscription will remain active until the end of the
15288
+ period, at which point it will be canceled and not renewed. By default, the
15289
+ subscription is terminated immediately. In either case, the customer will
15290
+ not be charged again for the subscription. Note, however, that any pending
15291
+ invoice items that you’ve created will still be charged for at the end of
15292
+ the period unless manually <a href="#delete_invoiceitem">deleted</a>. If you’ve
15293
+ set the subscription to cancel at period end, any pending prorations will
15294
+ also be left in place and collected at the end of the period, but if the subscription
15295
+ is set to cancel immediately, pending prorations will be removed.</p><p>By
15296
+ default, all unpaid invoices for the customer will be closed upon subscription
15297
+ cancellation. We do this in order to prevent unexpected payment retries once
15298
+ the customer has canceled a subscription. However, you can reopen the invoices
15299
+ manually after subscription cancellation to have us proceed with automatic
15300
+ retries, or you could even re-attempt payment yourself on all unpaid invoices
15301
+ before allowing the customer to cancel the subscription at all.</p>
14685
15302
  operationId: DeleteCustomerSubscription
14686
15303
  parameters:
14687
15304
  - description: Body parameters for the request.
@@ -14743,7 +15360,7 @@ paths:
14743
15360
  invoice subtotal that will be transferred to the application owner's
14744
15361
  Stripe account. The request must be made with an OAuth key in order
14745
15362
  to set an application fee percentage. For more information, see the
14746
- application fees [documentation](http://127.0.0.1:6040/docs/connect/collecting-fees#subscriptions).
15363
+ application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions')}).
14747
15364
  title: application_fee_percent
14748
15365
  type:
14749
15366
  - number
@@ -14834,15 +15451,15 @@ paths:
14834
15451
  - boolean
14835
15452
  source:
14836
15453
  description: The source can either be a token, like the ones returned
14837
- by [Elements](http://127.0.0.1:6040/docs/elements), or a dictionary
14838
- containing a user's credit card details (with the options shown below).
14839
- You must provide a source if the customer does not already have a
14840
- valid source attached, and you are subscribing the customer for a
14841
- plan that is not free. Passing `source` will create a new source object,
14842
- make it the customer default source, and delete the old customer default
14843
- if one exists. If you want to add an additional source to use with
14844
- subscriptions, instead use the [card creation API](http://127.0.0.1:6040/docs/api#create_card)
14845
- to add the card and then the [customer update API](http://127.0.0.1:6040/docs/api#update
15454
+ by [Elements](https://stripe.com/docs/elements), or a dictionary containing
15455
+ a user's credit card details (with the options shown below). You must
15456
+ provide a source if the customer does not already have a valid source
15457
+ attached, and you are subscribing the customer for a plan that is
15458
+ not free. Passing `source` will create a new source object, make it
15459
+ the customer default source, and delete the old customer default if
15460
+ one exists. If you want to add an additional source to use with subscriptions,
15461
+ instead use the [card creation API](https://stripe.com/docs/api#create_card)
15462
+ to add the card and then the [customer update API](https://stripe.com/docs/api#update
14846
15463
  customer) to set it as the default. Whenever you attach a card to
14847
15464
  a customer, Stripe will automatically validate the card.
14848
15465
  title: source
@@ -14948,7 +15565,9 @@ paths:
14948
15565
  "$ref": "#/definitions/error"
14949
15566
  "/v1/transfers":
14950
15567
  get:
14951
- description: ''
15568
+ description: "<p>Returns a list of existing transfers sent to connected accounts.
15569
+ The transfers are returned in sorted order, with the most recently created
15570
+ transfers appearing first.</p>"
14952
15571
  operationId: AllTransfers
14953
15572
  parameters:
14954
15573
  - description: A limit on the number of objects to be returned. Limit can range
@@ -14975,31 +15594,22 @@ paths:
14975
15594
  name: ending_before
14976
15595
  required: false
14977
15596
  type: string
14978
- - description: ''
14979
- in: query
14980
- name: amount
14981
- required: false
14982
- type: integer
14983
15597
  - description: ''
14984
15598
  in: query
14985
15599
  name: created
14986
15600
  required: false
14987
15601
  type: integer
14988
- - description: ''
15602
+ - description: Only return transfers for the destination specified by this account
15603
+ ID.
14989
15604
  in: query
14990
15605
  name: destination
14991
15606
  required: false
14992
15607
  type: string
14993
- - description: ''
15608
+ - description: Only return transfers with the specified transfer group.
14994
15609
  in: query
14995
15610
  name: transfer_group
14996
15611
  required: false
14997
15612
  type: string
14998
- - description: ''
14999
- in: query
15000
- name: currency
15001
- required: false
15002
- type: string
15003
15613
  responses:
15004
15614
  '200':
15005
15615
  description: Successful response.
@@ -15016,7 +15626,8 @@ paths:
15016
15626
  type:
15017
15627
  - boolean
15018
15628
  object:
15019
- description: The type of object. Always has the value "list".
15629
+ description: String representing the object's type. Objects of the
15630
+ same type share the same value. Always has the value "list".
15020
15631
  enum:
15021
15632
  - list
15022
15633
  type:
@@ -15079,6 +15690,11 @@ paths:
15079
15690
  title: source_transaction
15080
15691
  type:
15081
15692
  - string
15693
+ source_type:
15694
+ description: ''
15695
+ title: source_type
15696
+ type:
15697
+ - string
15082
15698
  transfer_group:
15083
15699
  description: ''
15084
15700
  title: transfer_group
@@ -15098,10 +15714,12 @@ paths:
15098
15714
  "$ref": "#/definitions/error"
15099
15715
  "/v1/transfers/{id}":
15100
15716
  get:
15101
- description: ''
15717
+ description: "<p>Retrieves the details of an existing transfer. Supply the unique
15718
+ transfer ID from either a transfer creation request or the transfer list,
15719
+ and Stripe will return the corresponding transfer information.</p>"
15102
15720
  operationId: RetrieveTransfer
15103
15721
  parameters:
15104
- - description: ''
15722
+ - description: The identifier of the transfer to be retrieved.
15105
15723
  in: path
15106
15724
  name: id
15107
15725
  required: true
@@ -15217,7 +15835,8 @@ paths:
15217
15835
  type:
15218
15836
  - boolean
15219
15837
  object:
15220
- description: The type of object. Always has the value "list".
15838
+ description: String representing the object's type. Objects of the
15839
+ same type share the same value. Always has the value "list".
15221
15840
  enum:
15222
15841
  - list
15223
15842
  type:
@@ -15314,10 +15933,9 @@ paths:
15314
15933
  schema:
15315
15934
  "$ref": "#/definitions/error"
15316
15935
  post:
15317
- description: |-
15318
- <p>Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
15319
-
15320
- <p>This request only accepts metadata and description as arguments.</p>
15936
+ description: "<p>Updates the specified reversal by setting the values of the
15937
+ parameters passed. Any parameters not provided will be left unchanged.</p><p>This
15938
+ request only accepts metadata and description as arguments.</p>"
15321
15939
  operationId: UpdateTransferReversal
15322
15940
  parameters:
15323
15941
  - description: ''