stripe 2.11.0 → 2.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/History.txt +4 -0
- data/README.md +2 -2
- data/VERSION +1 -1
- data/lib/stripe.rb +1 -0
- data/lib/stripe/ephemeral_key.rb +18 -0
- data/lib/stripe/util.rb +1 -0
- data/lib/stripe/version.rb +1 -1
- data/openapi/fixtures.json +508 -104
- data/openapi/fixtures.yaml +369 -92
- data/openapi/spec2.json +1210 -1015
- data/openapi/spec2.yaml +777 -605
- data/test/stripe/account_test.rb +1 -1
- data/test/stripe/api_resource_test.rb +2 -2
- data/test/stripe/ephemeral_key_test.rb +88 -0
- data/test/stripe/transfer_test.rb +0 -8
- metadata +5 -3
data/openapi/spec2.json
CHANGED
@@ -45,7 +45,7 @@
|
|
45
45
|
]
|
46
46
|
},
|
47
47
|
"details_submitted": {
|
48
|
-
"description": "Whether or not account details have been submitted yet.
|
48
|
+
"description": "Whether or not account details have been submitted yet. Standard accounts cannot receive transfers before this is true.",
|
49
49
|
"type": [
|
50
50
|
"boolean"
|
51
51
|
]
|
@@ -123,12 +123,6 @@
|
|
123
123
|
"legal_entity": {
|
124
124
|
"$ref": "#/definitions/legal_entity"
|
125
125
|
},
|
126
|
-
"managed": {
|
127
|
-
"description": "Whether or not the account is [managed](/docs/connect/managed-accounts) by your platform. Returns null if the account was not created by a platform.",
|
128
|
-
"type": [
|
129
|
-
"boolean"
|
130
|
-
]
|
131
|
-
},
|
132
126
|
"metadata": {
|
133
127
|
"description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.",
|
134
128
|
"type": [
|
@@ -189,6 +183,12 @@
|
|
189
183
|
"tos_acceptance": {
|
190
184
|
"$ref": "#/definitions/account_tos_acceptance"
|
191
185
|
},
|
186
|
+
"type": {
|
187
|
+
"description": "The type of the Stripe account. Can be 'standard', 'express', or 'custom'.",
|
188
|
+
"type": [
|
189
|
+
"string"
|
190
|
+
]
|
191
|
+
},
|
192
192
|
"verification": {
|
193
193
|
"$ref": "#/definitions/account_verification"
|
194
194
|
}
|
@@ -203,11 +203,11 @@
|
|
203
203
|
"external_accounts",
|
204
204
|
"id",
|
205
205
|
"legal_entity",
|
206
|
-
"managed",
|
207
206
|
"object",
|
208
207
|
"payout_schedule",
|
209
208
|
"payouts_enabled",
|
210
209
|
"tos_acceptance",
|
210
|
+
"type",
|
211
211
|
"verification"
|
212
212
|
],
|
213
213
|
"title": "Account",
|
@@ -308,7 +308,7 @@
|
|
308
308
|
"account_verification": {
|
309
309
|
"properties": {
|
310
310
|
"disabled_reason": {
|
311
|
-
"description": "A string describing the reason for this account being unable to charge and/or transfer, if that is the case. Possible values are `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `fields_needed`, `listed`, or `other`.",
|
311
|
+
"description": "A string describing the reason for this account being unable to charge and/or transfer, if that is the case. Possible values are `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `fields_needed`, `listed`, `under_review`, or `other`.",
|
312
312
|
"type": [
|
313
313
|
"string"
|
314
314
|
]
|
@@ -380,7 +380,7 @@
|
|
380
380
|
]
|
381
381
|
},
|
382
382
|
"details_submitted": {
|
383
|
-
"description": "Whether or not account details have been submitted yet.
|
383
|
+
"description": "Whether or not account details have been submitted yet. Standard accounts cannot receive transfers before this is true.",
|
384
384
|
"type": [
|
385
385
|
"boolean"
|
386
386
|
]
|
@@ -464,12 +464,6 @@
|
|
464
464
|
"legal_entity": {
|
465
465
|
"$ref": "#/definitions/legal_entity"
|
466
466
|
},
|
467
|
-
"managed": {
|
468
|
-
"description": "Whether or not the account is [managed](/docs/connect/managed-accounts) by your platform. Returns null if the account was not created by a platform.",
|
469
|
-
"type": [
|
470
|
-
"boolean"
|
471
|
-
]
|
472
|
-
},
|
473
467
|
"metadata": {
|
474
468
|
"description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.",
|
475
469
|
"type": [
|
@@ -530,6 +524,12 @@
|
|
530
524
|
"tos_acceptance": {
|
531
525
|
"$ref": "#/definitions/account_tos_acceptance"
|
532
526
|
},
|
527
|
+
"type": {
|
528
|
+
"description": "The type of the Stripe account. Can be 'standard', 'express', or 'custom'.",
|
529
|
+
"type": [
|
530
|
+
"string"
|
531
|
+
]
|
532
|
+
},
|
533
533
|
"verification": {
|
534
534
|
"$ref": "#/definitions/account_verification"
|
535
535
|
}
|
@@ -545,11 +545,11 @@
|
|
545
545
|
"id",
|
546
546
|
"keys",
|
547
547
|
"legal_entity",
|
548
|
-
"managed",
|
549
548
|
"object",
|
550
549
|
"payout_schedule",
|
551
550
|
"payouts_enabled",
|
552
551
|
"tos_acceptance",
|
552
|
+
"type",
|
553
553
|
"verification"
|
554
554
|
],
|
555
555
|
"title": "AccountWithKeys",
|
@@ -818,13 +818,19 @@
|
|
818
818
|
"x-expansionResources": {
|
819
819
|
"oneOf": [
|
820
820
|
{
|
821
|
-
"$ref": "#/definitions/
|
821
|
+
"$ref": "#/definitions/card"
|
822
822
|
}
|
823
823
|
]
|
824
824
|
}
|
825
825
|
},
|
826
|
+
"created": {
|
827
|
+
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
828
|
+
"type": [
|
829
|
+
"integer"
|
830
|
+
]
|
831
|
+
},
|
826
832
|
"currency": {
|
827
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
833
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
828
834
|
"type": [
|
829
835
|
"string"
|
830
836
|
]
|
@@ -867,6 +873,7 @@
|
|
867
873
|
"amount",
|
868
874
|
"balance_transactions",
|
869
875
|
"card",
|
876
|
+
"created",
|
870
877
|
"currency",
|
871
878
|
"held_amount",
|
872
879
|
"held_currency",
|
@@ -957,7 +964,7 @@
|
|
957
964
|
]
|
958
965
|
},
|
959
966
|
"currency": {
|
960
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
967
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
961
968
|
"type": [
|
962
969
|
"string"
|
963
970
|
]
|
@@ -1092,7 +1099,7 @@
|
|
1092
1099
|
]
|
1093
1100
|
},
|
1094
1101
|
"connect_reserved": {
|
1095
|
-
"description": "Funds held due to negative balances on connected
|
1102
|
+
"description": "Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property.",
|
1096
1103
|
"type": [
|
1097
1104
|
"array"
|
1098
1105
|
]
|
@@ -1152,7 +1159,7 @@
|
|
1152
1159
|
]
|
1153
1160
|
},
|
1154
1161
|
"currency": {
|
1155
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
1162
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
1156
1163
|
"type": [
|
1157
1164
|
"string"
|
1158
1165
|
]
|
@@ -1220,9 +1227,6 @@
|
|
1220
1227
|
{
|
1221
1228
|
"$ref": "#/definitions/transaction"
|
1222
1229
|
},
|
1223
|
-
{
|
1224
|
-
"$ref": "#/definitions/legacy_transfer"
|
1225
|
-
},
|
1226
1230
|
{
|
1227
1231
|
"$ref": "#/definitions/payout"
|
1228
1232
|
},
|
@@ -1322,7 +1326,7 @@
|
|
1322
1326
|
]
|
1323
1327
|
},
|
1324
1328
|
"currency": {
|
1325
|
-
"description": "Three-letter [ISO code for the currency](https://
|
1329
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
|
1326
1330
|
"type": [
|
1327
1331
|
"string"
|
1328
1332
|
]
|
@@ -1452,7 +1456,7 @@
|
|
1452
1456
|
]
|
1453
1457
|
},
|
1454
1458
|
"currency": {
|
1455
|
-
"description": "Three-letter [ISO code for the currency](https://
|
1459
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted.",
|
1456
1460
|
"type": [
|
1457
1461
|
"string"
|
1458
1462
|
]
|
@@ -1636,7 +1640,7 @@
|
|
1636
1640
|
]
|
1637
1641
|
},
|
1638
1642
|
"currency": {
|
1639
|
-
"description": "Three-letter [ISO code for the currency](https://
|
1643
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which this transaction was converted.",
|
1640
1644
|
"type": [
|
1641
1645
|
"string"
|
1642
1646
|
]
|
@@ -1760,7 +1764,7 @@
|
|
1760
1764
|
]
|
1761
1765
|
},
|
1762
1766
|
"currency": {
|
1763
|
-
"description": "Three-letter [ISO code for currency](https://
|
1767
|
+
"description": "Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.",
|
1764
1768
|
"type": [
|
1765
1769
|
"string"
|
1766
1770
|
]
|
@@ -1894,7 +1898,7 @@
|
|
1894
1898
|
"charge": {
|
1895
1899
|
"properties": {
|
1896
1900
|
"amount": {
|
1897
|
-
"description": "A positive integer in the [smallest currency unit](https://
|
1901
|
+
"description": "A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency) representing how much to charge. The minimum amount is $0.50 US or [equivalent in charge currency](https://support.stripe.com/questions/what-is-the-minimum-amount-i-can-charge-with-stripe).",
|
1898
1902
|
"type": [
|
1899
1903
|
"integer"
|
1900
1904
|
]
|
@@ -1960,7 +1964,7 @@
|
|
1960
1964
|
]
|
1961
1965
|
},
|
1962
1966
|
"currency": {
|
1963
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
1967
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
1964
1968
|
"type": [
|
1965
1969
|
"string"
|
1966
1970
|
]
|
@@ -2107,7 +2111,7 @@
|
|
2107
2111
|
]
|
2108
2112
|
},
|
2109
2113
|
"receipt_number": {
|
2110
|
-
"description": "This is the transaction number that appears on email receipts sent for this charge.",
|
2114
|
+
"description": "This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.",
|
2111
2115
|
"type": [
|
2112
2116
|
"string"
|
2113
2117
|
]
|
@@ -2402,7 +2406,7 @@
|
|
2402
2406
|
]
|
2403
2407
|
},
|
2404
2408
|
"currency": {
|
2405
|
-
"description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://
|
2409
|
+
"description": "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off.",
|
2406
2410
|
"type": [
|
2407
2411
|
"string"
|
2408
2412
|
]
|
@@ -2514,7 +2518,7 @@
|
|
2514
2518
|
]
|
2515
2519
|
},
|
2516
2520
|
"currency": {
|
2517
|
-
"description": "Three-letter [ISO code for the currency](https://
|
2521
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.",
|
2518
2522
|
"type": [
|
2519
2523
|
"string"
|
2520
2524
|
]
|
@@ -2874,7 +2878,7 @@
|
|
2874
2878
|
}
|
2875
2879
|
},
|
2876
2880
|
"end": {
|
2877
|
-
"description": "If the coupon has a duration of `
|
2881
|
+
"description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.",
|
2878
2882
|
"type": [
|
2879
2883
|
"integer"
|
2880
2884
|
]
|
@@ -2948,22 +2952,16 @@
|
|
2948
2952
|
]
|
2949
2953
|
},
|
2950
2954
|
"currency": {
|
2951
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
2955
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
2952
2956
|
"type": [
|
2953
2957
|
"string"
|
2954
2958
|
]
|
2955
2959
|
},
|
2956
2960
|
"evidence": {
|
2957
|
-
"
|
2958
|
-
"type": [
|
2959
|
-
"object"
|
2960
|
-
]
|
2961
|
+
"$ref": "#/definitions/dispute_evidence"
|
2961
2962
|
},
|
2962
2963
|
"evidence_details": {
|
2963
|
-
"
|
2964
|
-
"type": [
|
2965
|
-
"object"
|
2966
|
-
]
|
2964
|
+
"$ref": "#/definitions/dispute_evidence_details"
|
2967
2965
|
},
|
2968
2966
|
"id": {
|
2969
2967
|
"description": "Unique identifier for the object.",
|
@@ -3033,367 +3031,316 @@
|
|
3033
3031
|
],
|
3034
3032
|
"x-resourceId": "dispute"
|
3035
3033
|
},
|
3036
|
-
"
|
3037
|
-
"description": "An error response from the Stripe API.",
|
3034
|
+
"dispute_evidence": {
|
3038
3035
|
"properties": {
|
3039
|
-
"
|
3040
|
-
"description": "
|
3036
|
+
"access_activity_log": {
|
3037
|
+
"description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.",
|
3041
3038
|
"type": [
|
3042
3039
|
"string"
|
3043
3040
|
]
|
3044
3041
|
},
|
3045
|
-
"
|
3046
|
-
"description": "
|
3042
|
+
"billing_address": {
|
3043
|
+
"description": "The billing address provided by the customer.",
|
3047
3044
|
"type": [
|
3048
3045
|
"string"
|
3049
3046
|
]
|
3050
3047
|
},
|
3051
|
-
"
|
3052
|
-
"description": "
|
3048
|
+
"cancellation_policy": {
|
3049
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.",
|
3053
3050
|
"type": [
|
3054
3051
|
"string"
|
3055
|
-
]
|
3052
|
+
],
|
3053
|
+
"x-expansionResources": {
|
3054
|
+
"oneOf": [
|
3055
|
+
{
|
3056
|
+
"$ref": "#/definitions/file"
|
3057
|
+
}
|
3058
|
+
]
|
3059
|
+
}
|
3056
3060
|
},
|
3057
|
-
"
|
3058
|
-
"description": "
|
3061
|
+
"cancellation_policy_disclosure": {
|
3062
|
+
"description": "An explanation of how and when the customer was shown your refund policy prior to purchase.",
|
3059
3063
|
"type": [
|
3060
3064
|
"string"
|
3061
3065
|
]
|
3062
3066
|
},
|
3063
|
-
"
|
3064
|
-
"description": "
|
3067
|
+
"cancellation_rebuttal": {
|
3068
|
+
"description": "A justification for why the customer's subscription was not canceled.",
|
3065
3069
|
"type": [
|
3066
3070
|
"string"
|
3067
3071
|
]
|
3068
3072
|
},
|
3069
|
-
"
|
3070
|
-
"description": "
|
3071
|
-
"enum": [
|
3072
|
-
"api_connection_error",
|
3073
|
-
"api_error",
|
3074
|
-
"authentication_error",
|
3075
|
-
"card_error",
|
3076
|
-
"invalid_request_error",
|
3077
|
-
"rate_limit_error"
|
3078
|
-
],
|
3073
|
+
"customer_communication": {
|
3074
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case (for example emails proving that they received the product or service, or demonstrating their use of or satisfaction with the product or service).",
|
3079
3075
|
"type": [
|
3080
3076
|
"string"
|
3081
|
-
]
|
3082
|
-
|
3083
|
-
|
3084
|
-
|
3085
|
-
|
3086
|
-
|
3087
|
-
|
3088
|
-
|
3089
|
-
|
3090
|
-
|
3091
|
-
|
3092
|
-
"properties": {
|
3093
|
-
"api_version": {
|
3094
|
-
"description": "The Stripe API version used to render `data`. *Note: this property is populated for events on or after October 31, 2014*.",
|
3077
|
+
],
|
3078
|
+
"x-expansionResources": {
|
3079
|
+
"oneOf": [
|
3080
|
+
{
|
3081
|
+
"$ref": "#/definitions/file"
|
3082
|
+
}
|
3083
|
+
]
|
3084
|
+
}
|
3085
|
+
},
|
3086
|
+
"customer_email_address": {
|
3087
|
+
"description": "The email address of the customer.",
|
3095
3088
|
"type": [
|
3096
3089
|
"string"
|
3097
3090
|
]
|
3098
3091
|
},
|
3099
|
-
"
|
3100
|
-
"description": "
|
3092
|
+
"customer_name": {
|
3093
|
+
"description": "The name of the customer.",
|
3101
3094
|
"type": [
|
3102
|
-
"
|
3095
|
+
"string"
|
3103
3096
|
]
|
3104
3097
|
},
|
3105
|
-
"
|
3106
|
-
"
|
3107
|
-
},
|
3108
|
-
"id": {
|
3109
|
-
"description": "Unique identifier for the object.",
|
3098
|
+
"customer_purchase_ip": {
|
3099
|
+
"description": "The IP address that the customer used when making the purchase.",
|
3110
3100
|
"type": [
|
3111
3101
|
"string"
|
3112
3102
|
]
|
3113
3103
|
},
|
3114
|
-
"
|
3115
|
-
"description": "
|
3104
|
+
"customer_signature": {
|
3105
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.",
|
3116
3106
|
"type": [
|
3117
|
-
"
|
3118
|
-
]
|
3107
|
+
"string"
|
3108
|
+
],
|
3109
|
+
"x-expansionResources": {
|
3110
|
+
"oneOf": [
|
3111
|
+
{
|
3112
|
+
"$ref": "#/definitions/file"
|
3113
|
+
}
|
3114
|
+
]
|
3115
|
+
}
|
3119
3116
|
},
|
3120
|
-
"
|
3121
|
-
"description": "
|
3117
|
+
"duplicate_charge_documentation": {
|
3118
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.",
|
3122
3119
|
"type": [
|
3123
3120
|
"string"
|
3124
|
-
]
|
3121
|
+
],
|
3122
|
+
"x-expansionResources": {
|
3123
|
+
"oneOf": [
|
3124
|
+
{
|
3125
|
+
"$ref": "#/definitions/file"
|
3126
|
+
}
|
3127
|
+
]
|
3128
|
+
}
|
3125
3129
|
},
|
3126
|
-
"
|
3127
|
-
"description": "
|
3130
|
+
"duplicate_charge_explanation": {
|
3131
|
+
"description": "An explanation of the difference between the disputed charge and the prior charge that appears to be a duplicate.",
|
3128
3132
|
"type": [
|
3129
|
-
"
|
3133
|
+
"string"
|
3130
3134
|
]
|
3131
3135
|
},
|
3132
|
-
"
|
3133
|
-
"description": "
|
3136
|
+
"duplicate_charge_id": {
|
3137
|
+
"description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.",
|
3134
3138
|
"type": [
|
3135
3139
|
"string"
|
3136
3140
|
]
|
3137
3141
|
},
|
3138
|
-
"
|
3139
|
-
"description": "
|
3142
|
+
"product_description": {
|
3143
|
+
"description": "A description of the product or service which was sold.",
|
3140
3144
|
"type": [
|
3141
3145
|
"string"
|
3142
3146
|
]
|
3143
|
-
}
|
3144
|
-
},
|
3145
|
-
"required": [
|
3146
|
-
"created",
|
3147
|
-
"data",
|
3148
|
-
"id",
|
3149
|
-
"livemode",
|
3150
|
-
"object",
|
3151
|
-
"pending_webhooks",
|
3152
|
-
"type"
|
3153
|
-
],
|
3154
|
-
"title": "Event",
|
3155
|
-
"type": [
|
3156
|
-
"object"
|
3157
|
-
],
|
3158
|
-
"x-expandableFields": [
|
3159
|
-
|
3160
|
-
],
|
3161
|
-
"x-resourceId": "event"
|
3162
|
-
},
|
3163
|
-
"event_data": {
|
3164
|
-
"properties": {
|
3165
|
-
"object": {
|
3166
|
-
"description": "Static string describing the type of the object described by this change. For example, an `invoice.created` event will have a full invoice object as the value of the object key.",
|
3167
|
-
"type": [
|
3168
|
-
"object"
|
3169
|
-
]
|
3170
3147
|
},
|
3171
|
-
"
|
3172
|
-
"description": "
|
3148
|
+
"receipt": {
|
3149
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.",
|
3173
3150
|
"type": [
|
3174
|
-
"
|
3175
|
-
]
|
3176
|
-
|
3177
|
-
|
3178
|
-
|
3179
|
-
|
3180
|
-
|
3181
|
-
|
3182
|
-
|
3183
|
-
|
3184
|
-
|
3185
|
-
|
3186
|
-
|
3187
|
-
],
|
3188
|
-
"x-resourceId": "event_data"
|
3189
|
-
},
|
3190
|
-
"external_account_source": {
|
3191
|
-
"properties": {
|
3192
|
-
"account": {
|
3193
|
-
"description": "",
|
3151
|
+
"string"
|
3152
|
+
],
|
3153
|
+
"x-expansionResources": {
|
3154
|
+
"oneOf": [
|
3155
|
+
{
|
3156
|
+
"$ref": "#/definitions/file"
|
3157
|
+
}
|
3158
|
+
]
|
3159
|
+
}
|
3160
|
+
},
|
3161
|
+
"refund_policy": {
|
3162
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.",
|
3194
3163
|
"type": [
|
3195
3164
|
"string"
|
3196
3165
|
],
|
3197
3166
|
"x-expansionResources": {
|
3198
3167
|
"oneOf": [
|
3199
3168
|
{
|
3200
|
-
"$ref": "#/definitions/
|
3169
|
+
"$ref": "#/definitions/file"
|
3201
3170
|
}
|
3202
3171
|
]
|
3203
3172
|
}
|
3204
3173
|
},
|
3205
|
-
"
|
3206
|
-
"description": "
|
3174
|
+
"refund_policy_disclosure": {
|
3175
|
+
"description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase.",
|
3207
3176
|
"type": [
|
3208
3177
|
"string"
|
3209
3178
|
]
|
3210
3179
|
},
|
3211
|
-
"
|
3212
|
-
"description": "
|
3180
|
+
"refund_refusal_explanation": {
|
3181
|
+
"description": "A justification for why the customer is not entitled to a refund.",
|
3213
3182
|
"type": [
|
3214
3183
|
"string"
|
3215
3184
|
]
|
3216
3185
|
},
|
3217
|
-
"
|
3218
|
-
"description": "",
|
3186
|
+
"service_date": {
|
3187
|
+
"description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.",
|
3188
|
+
"type": [
|
3189
|
+
"string"
|
3190
|
+
]
|
3191
|
+
},
|
3192
|
+
"service_documentation": {
|
3193
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.",
|
3219
3194
|
"type": [
|
3220
3195
|
"string"
|
3221
3196
|
],
|
3222
3197
|
"x-expansionResources": {
|
3223
3198
|
"oneOf": [
|
3224
3199
|
{
|
3225
|
-
"$ref": "#/definitions/
|
3200
|
+
"$ref": "#/definitions/file"
|
3226
3201
|
}
|
3227
3202
|
]
|
3228
3203
|
}
|
3229
3204
|
},
|
3230
|
-
"
|
3231
|
-
"description": "
|
3205
|
+
"shipping_address": {
|
3206
|
+
"description": "The address to which a physical product was shipped. You should try to include as much complete address information as possible.",
|
3232
3207
|
"type": [
|
3233
|
-
"
|
3208
|
+
"string"
|
3234
3209
|
]
|
3235
3210
|
},
|
3236
|
-
"
|
3237
|
-
"description": "
|
3211
|
+
"shipping_carrier": {
|
3212
|
+
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.",
|
3238
3213
|
"type": [
|
3239
3214
|
"string"
|
3240
3215
|
]
|
3241
3216
|
},
|
3242
|
-
"
|
3243
|
-
"description": "
|
3217
|
+
"shipping_date": {
|
3218
|
+
"description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.",
|
3244
3219
|
"type": [
|
3245
3220
|
"string"
|
3246
3221
|
]
|
3247
3222
|
},
|
3248
|
-
"
|
3249
|
-
"description": "",
|
3223
|
+
"shipping_documentation": {
|
3224
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc, and should show the full shipping address of the customer, if possible.",
|
3250
3225
|
"type": [
|
3251
3226
|
"string"
|
3252
|
-
]
|
3227
|
+
],
|
3228
|
+
"x-expansionResources": {
|
3229
|
+
"oneOf": [
|
3230
|
+
{
|
3231
|
+
"$ref": "#/definitions/file"
|
3232
|
+
}
|
3233
|
+
]
|
3234
|
+
}
|
3253
3235
|
},
|
3254
|
-
"
|
3255
|
-
"description": "
|
3236
|
+
"shipping_tracking_number": {
|
3237
|
+
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
|
3256
3238
|
"type": [
|
3257
|
-
"
|
3239
|
+
"string"
|
3258
3240
|
]
|
3259
3241
|
},
|
3260
|
-
"
|
3261
|
-
"description": "
|
3242
|
+
"uncategorized_file": {
|
3243
|
+
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.",
|
3244
|
+
"type": [
|
3245
|
+
"string"
|
3246
|
+
],
|
3247
|
+
"x-expansionResources": {
|
3248
|
+
"oneOf": [
|
3249
|
+
{
|
3250
|
+
"$ref": "#/definitions/file"
|
3251
|
+
}
|
3252
|
+
]
|
3253
|
+
}
|
3254
|
+
},
|
3255
|
+
"uncategorized_text": {
|
3256
|
+
"description": "Any additional evidence or statements.",
|
3262
3257
|
"type": [
|
3263
3258
|
"string"
|
3264
3259
|
]
|
3265
3260
|
}
|
3266
3261
|
},
|
3267
|
-
"
|
3268
|
-
"country",
|
3269
|
-
"currency",
|
3270
|
-
"id",
|
3271
|
-
"last4",
|
3272
|
-
"object"
|
3273
|
-
],
|
3274
|
-
"title": "Polymorphic",
|
3262
|
+
"title": "DisputeEvidence",
|
3275
3263
|
"type": [
|
3276
3264
|
"object"
|
3277
3265
|
],
|
3278
3266
|
"x-expandableFields": [
|
3279
|
-
"
|
3280
|
-
"
|
3267
|
+
"cancellation_policy",
|
3268
|
+
"customer_communication",
|
3269
|
+
"customer_signature",
|
3270
|
+
"duplicate_charge_documentation",
|
3271
|
+
"receipt",
|
3272
|
+
"refund_policy",
|
3273
|
+
"service_documentation",
|
3274
|
+
"shipping_documentation",
|
3275
|
+
"uncategorized_file"
|
3281
3276
|
],
|
3282
|
-
"x-
|
3283
|
-
"oneOf": [
|
3284
|
-
{
|
3285
|
-
"$ref": "#/definitions/bank_account"
|
3286
|
-
},
|
3287
|
-
{
|
3288
|
-
"$ref": "#/definitions/card"
|
3289
|
-
}
|
3290
|
-
]
|
3291
|
-
},
|
3292
|
-
"x-resourceId": "external_account_source"
|
3277
|
+
"x-resourceId": "dispute_evidence"
|
3293
3278
|
},
|
3294
|
-
"
|
3279
|
+
"dispute_evidence_details": {
|
3295
3280
|
"properties": {
|
3296
|
-
"
|
3297
|
-
"description": "
|
3281
|
+
"due_by": {
|
3282
|
+
"description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be null if the customer's bank or credit card company doesn't allow a response for this particular dispute.",
|
3298
3283
|
"type": [
|
3299
3284
|
"integer"
|
3300
3285
|
]
|
3301
3286
|
},
|
3302
|
-
"
|
3303
|
-
"description": "",
|
3304
|
-
"type": [
|
3305
|
-
"string"
|
3306
|
-
]
|
3307
|
-
},
|
3308
|
-
"currency": {
|
3309
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).",
|
3287
|
+
"has_evidence": {
|
3288
|
+
"description": "Whether or not evidence has been staged for this dispute.",
|
3310
3289
|
"type": [
|
3311
|
-
"
|
3290
|
+
"boolean"
|
3312
3291
|
]
|
3313
3292
|
},
|
3314
|
-
"
|
3315
|
-
"description": "
|
3293
|
+
"past_due": {
|
3294
|
+
"description": "Whether or not the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If true, then delivery of the latest evidence is not guaranteed.",
|
3316
3295
|
"type": [
|
3317
|
-
"
|
3296
|
+
"boolean"
|
3318
3297
|
]
|
3319
3298
|
},
|
3320
|
-
"
|
3321
|
-
"description": "
|
3299
|
+
"submission_count": {
|
3300
|
+
"description": "The number of times evidence has been submitted. Typically, you may only submit evidence once.",
|
3322
3301
|
"type": [
|
3323
|
-
"
|
3302
|
+
"integer"
|
3324
3303
|
]
|
3325
3304
|
}
|
3326
3305
|
},
|
3327
3306
|
"required": [
|
3328
|
-
"
|
3329
|
-
"
|
3330
|
-
"
|
3307
|
+
"has_evidence",
|
3308
|
+
"past_due",
|
3309
|
+
"submission_count"
|
3331
3310
|
],
|
3332
|
-
"title": "
|
3311
|
+
"title": "DisputeEvidenceDetails",
|
3333
3312
|
"type": [
|
3334
3313
|
"object"
|
3335
3314
|
],
|
3336
3315
|
"x-expandableFields": [
|
3337
3316
|
|
3338
3317
|
],
|
3339
|
-
"x-resourceId": "
|
3318
|
+
"x-resourceId": "dispute_evidence_details"
|
3340
3319
|
},
|
3341
|
-
"
|
3320
|
+
"ephemeral_key": {
|
3342
3321
|
"properties": {
|
3343
|
-
"amount": {
|
3344
|
-
"description": "Amount, in %s.",
|
3345
|
-
"type": [
|
3346
|
-
"integer"
|
3347
|
-
]
|
3348
|
-
},
|
3349
|
-
"balance_transaction": {
|
3350
|
-
"description": "Balance transaction that describes the impact on your account balance.",
|
3351
|
-
"type": [
|
3352
|
-
"string"
|
3353
|
-
],
|
3354
|
-
"x-expansionResources": {
|
3355
|
-
"oneOf": [
|
3356
|
-
{
|
3357
|
-
"$ref": "#/definitions/balance_transaction"
|
3358
|
-
}
|
3359
|
-
]
|
3360
|
-
}
|
3361
|
-
},
|
3362
3322
|
"created": {
|
3363
3323
|
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
3364
3324
|
"type": [
|
3365
3325
|
"integer"
|
3366
3326
|
]
|
3367
3327
|
},
|
3368
|
-
"
|
3369
|
-
"description": "
|
3328
|
+
"expires": {
|
3329
|
+
"description": "Time at which the key will expire. Measured in seconds since the Unix epoch.",
|
3370
3330
|
"type": [
|
3371
|
-
"
|
3331
|
+
"integer"
|
3372
3332
|
]
|
3373
3333
|
},
|
3374
|
-
"fee": {
|
3375
|
-
"description": "ID of the application fee that was refunded.",
|
3376
|
-
"type": [
|
3377
|
-
"string"
|
3378
|
-
],
|
3379
|
-
"x-expansionResources": {
|
3380
|
-
"oneOf": [
|
3381
|
-
{
|
3382
|
-
"$ref": "#/definitions/platform_fee"
|
3383
|
-
}
|
3384
|
-
]
|
3385
|
-
}
|
3386
|
-
},
|
3387
3334
|
"id": {
|
3388
3335
|
"description": "Unique identifier for the object.",
|
3389
3336
|
"type": [
|
3390
3337
|
"string"
|
3391
3338
|
]
|
3392
3339
|
},
|
3393
|
-
"
|
3394
|
-
"description": "
|
3340
|
+
"livemode": {
|
3341
|
+
"description": "Flag indicating whether the object exists in live mode or test mode.",
|
3395
3342
|
"type": [
|
3396
|
-
"
|
3343
|
+
"boolean"
|
3397
3344
|
]
|
3398
3345
|
},
|
3399
3346
|
"object": {
|
@@ -3404,25 +3351,22 @@
|
|
3404
3351
|
}
|
3405
3352
|
},
|
3406
3353
|
"required": [
|
3407
|
-
"amount",
|
3408
3354
|
"created",
|
3409
|
-
"
|
3410
|
-
"fee",
|
3355
|
+
"expires",
|
3411
3356
|
"id",
|
3412
|
-
"
|
3357
|
+
"livemode",
|
3413
3358
|
"object"
|
3414
3359
|
],
|
3415
|
-
"title": "
|
3360
|
+
"title": "EphemeralKey",
|
3416
3361
|
"type": [
|
3417
3362
|
"object"
|
3418
3363
|
],
|
3419
3364
|
"x-expandableFields": [
|
3420
|
-
|
3421
|
-
"fee"
|
3365
|
+
|
3422
3366
|
],
|
3423
|
-
"x-resourceId": "
|
3367
|
+
"x-resourceId": "ephemeral_key"
|
3424
3368
|
},
|
3425
|
-
"
|
3369
|
+
"ephemeral_key_with_secret": {
|
3426
3370
|
"properties": {
|
3427
3371
|
"created": {
|
3428
3372
|
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
@@ -3430,38 +3374,32 @@
|
|
3430
3374
|
"integer"
|
3431
3375
|
]
|
3432
3376
|
},
|
3433
|
-
"
|
3434
|
-
"description": "
|
3435
|
-
"type": [
|
3436
|
-
"string"
|
3437
|
-
]
|
3438
|
-
},
|
3439
|
-
"object": {
|
3440
|
-
"description": "String representing the object's type. Objects of the same type share the same value.",
|
3377
|
+
"expires": {
|
3378
|
+
"description": "Time at which the key will expire. Measured in seconds since the Unix epoch.",
|
3441
3379
|
"type": [
|
3442
|
-
"
|
3380
|
+
"integer"
|
3443
3381
|
]
|
3444
3382
|
},
|
3445
|
-
"
|
3446
|
-
"description": "
|
3383
|
+
"id": {
|
3384
|
+
"description": "Unique identifier for the object.",
|
3447
3385
|
"type": [
|
3448
3386
|
"string"
|
3449
3387
|
]
|
3450
3388
|
},
|
3451
|
-
"
|
3452
|
-
"description": "
|
3389
|
+
"livemode": {
|
3390
|
+
"description": "Flag indicating whether the object exists in live mode or test mode.",
|
3453
3391
|
"type": [
|
3454
|
-
"
|
3392
|
+
"boolean"
|
3455
3393
|
]
|
3456
3394
|
},
|
3457
|
-
"
|
3458
|
-
"description": "
|
3395
|
+
"object": {
|
3396
|
+
"description": "String representing the object's type. Objects of the same type share the same value.",
|
3459
3397
|
"type": [
|
3460
3398
|
"string"
|
3461
3399
|
]
|
3462
3400
|
},
|
3463
|
-
"
|
3464
|
-
"description": "
|
3401
|
+
"secret": {
|
3402
|
+
"description": "The key's secret. You can use this value to make authorized requests to the Stripe API.",
|
3465
3403
|
"type": [
|
3466
3404
|
"string"
|
3467
3405
|
]
|
@@ -3469,36 +3407,64 @@
|
|
3469
3407
|
},
|
3470
3408
|
"required": [
|
3471
3409
|
"created",
|
3410
|
+
"expires",
|
3472
3411
|
"id",
|
3412
|
+
"livemode",
|
3473
3413
|
"object",
|
3474
|
-
"
|
3475
|
-
"size"
|
3414
|
+
"secret"
|
3476
3415
|
],
|
3477
|
-
"title": "
|
3416
|
+
"title": "EphemeralKeyWithSecret",
|
3478
3417
|
"type": [
|
3479
3418
|
"object"
|
3480
3419
|
],
|
3481
3420
|
"x-expandableFields": [
|
3482
3421
|
|
3483
3422
|
],
|
3484
|
-
"x-resourceId": "
|
3423
|
+
"x-resourceId": "ephemeral_key_with_secret"
|
3485
3424
|
},
|
3486
|
-
"
|
3425
|
+
"error": {
|
3426
|
+
"description": "An error response from the Stripe API.",
|
3487
3427
|
"properties": {
|
3488
|
-
"
|
3489
|
-
"description": "The
|
3428
|
+
"charge": {
|
3429
|
+
"description": "The ID of the failed charge.",
|
3490
3430
|
"type": [
|
3491
|
-
"
|
3431
|
+
"string"
|
3492
3432
|
]
|
3493
3433
|
},
|
3494
|
-
"
|
3495
|
-
"description": "
|
3434
|
+
"code": {
|
3435
|
+
"description": "For card errors, a short string from amongst those listed on the right describing the kind of card error that occurred. ",
|
3496
3436
|
"type": [
|
3497
3437
|
"string"
|
3498
3438
|
]
|
3499
3439
|
},
|
3500
|
-
"
|
3501
|
-
"description": "
|
3440
|
+
"decline_code": {
|
3441
|
+
"description": "For card errors resulting from a bank decline, a short string indicating the bank's reason for the decline if they provide one. See https://stripe.com/docs/declines#bank-declines",
|
3442
|
+
"type": [
|
3443
|
+
"string"
|
3444
|
+
]
|
3445
|
+
},
|
3446
|
+
"message": {
|
3447
|
+
"description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.",
|
3448
|
+
"type": [
|
3449
|
+
"string"
|
3450
|
+
]
|
3451
|
+
},
|
3452
|
+
"param": {
|
3453
|
+
"description": "The parameter the error relates to if the error is parameter-specific. You can use this to display a message near the correct form field, for example.",
|
3454
|
+
"type": [
|
3455
|
+
"string"
|
3456
|
+
]
|
3457
|
+
},
|
3458
|
+
"type": {
|
3459
|
+
"description": "The type of error returned.",
|
3460
|
+
"enum": [
|
3461
|
+
"api_connection_error",
|
3462
|
+
"api_error",
|
3463
|
+
"authentication_error",
|
3464
|
+
"card_error",
|
3465
|
+
"invalid_request_error",
|
3466
|
+
"rate_limit_error"
|
3467
|
+
],
|
3502
3468
|
"type": [
|
3503
3469
|
"string"
|
3504
3470
|
]
|
@@ -3507,373 +3473,331 @@
|
|
3507
3473
|
"required": [
|
3508
3474
|
"type"
|
3509
3475
|
],
|
3510
|
-
"title": "Inventory",
|
3511
3476
|
"type": [
|
3512
3477
|
"object"
|
3513
|
-
]
|
3514
|
-
"x-expandableFields": [
|
3515
|
-
|
3516
|
-
],
|
3517
|
-
"x-resourceId": "inventory"
|
3478
|
+
]
|
3518
3479
|
},
|
3519
|
-
"
|
3480
|
+
"event": {
|
3520
3481
|
"properties": {
|
3521
|
-
"
|
3522
|
-
"description": "
|
3523
|
-
"type": [
|
3524
|
-
"integer"
|
3525
|
-
]
|
3526
|
-
},
|
3527
|
-
"application_fee": {
|
3528
|
-
"description": "The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.",
|
3482
|
+
"api_version": {
|
3483
|
+
"description": "The Stripe API version used to render `data`. *Note: this property is populated for events on or after October 31, 2014*.",
|
3529
3484
|
"type": [
|
3530
|
-
"
|
3485
|
+
"string"
|
3531
3486
|
]
|
3532
3487
|
},
|
3533
|
-
"
|
3534
|
-
"description": "
|
3488
|
+
"created": {
|
3489
|
+
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
3535
3490
|
"type": [
|
3536
3491
|
"integer"
|
3537
3492
|
]
|
3538
3493
|
},
|
3539
|
-
"
|
3540
|
-
"
|
3541
|
-
"type": [
|
3542
|
-
"boolean"
|
3543
|
-
]
|
3544
|
-
},
|
3545
|
-
"charge": {
|
3546
|
-
"description": "ID of the latest charge generated for this invoice, if any.",
|
3547
|
-
"type": [
|
3548
|
-
"string"
|
3549
|
-
],
|
3550
|
-
"x-expansionResources": {
|
3551
|
-
"oneOf": [
|
3552
|
-
{
|
3553
|
-
"$ref": "#/definitions/charge"
|
3554
|
-
}
|
3555
|
-
]
|
3556
|
-
}
|
3557
|
-
},
|
3558
|
-
"closed": {
|
3559
|
-
"description": "Whether or not the invoice is still trying to collect payment. An invoice is closed if it's either paid or it has been marked closed. A closed invoice will no longer attempt to collect payment.",
|
3560
|
-
"type": [
|
3561
|
-
"boolean"
|
3562
|
-
]
|
3494
|
+
"data": {
|
3495
|
+
"$ref": "#/definitions/event_data"
|
3563
3496
|
},
|
3564
|
-
"
|
3565
|
-
"description": "
|
3497
|
+
"id": {
|
3498
|
+
"description": "Unique identifier for the object.",
|
3566
3499
|
"type": [
|
3567
3500
|
"string"
|
3568
3501
|
]
|
3569
3502
|
},
|
3570
|
-
"
|
3571
|
-
"description": "",
|
3572
|
-
"type": [
|
3573
|
-
"string"
|
3574
|
-
],
|
3575
|
-
"x-expansionResources": {
|
3576
|
-
"oneOf": [
|
3577
|
-
{
|
3578
|
-
"$ref": "#/definitions/customer"
|
3579
|
-
}
|
3580
|
-
]
|
3581
|
-
}
|
3582
|
-
},
|
3583
|
-
"date": {
|
3584
|
-
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
3503
|
+
"livemode": {
|
3504
|
+
"description": "Flag indicating whether the object exists in live mode or test mode.",
|
3585
3505
|
"type": [
|
3586
|
-
"
|
3506
|
+
"boolean"
|
3587
3507
|
]
|
3588
3508
|
},
|
3589
|
-
"
|
3590
|
-
"description": "
|
3509
|
+
"object": {
|
3510
|
+
"description": "String representing the object's type. Objects of the same type share the same value.",
|
3591
3511
|
"type": [
|
3592
3512
|
"string"
|
3593
3513
|
]
|
3594
3514
|
},
|
3595
|
-
"
|
3596
|
-
"
|
3597
|
-
},
|
3598
|
-
"ending_balance": {
|
3599
|
-
"description": "Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null.",
|
3515
|
+
"pending_webhooks": {
|
3516
|
+
"description": "Number of webhooks yet to be delivered successfully (return a 20x response) to the URLs you've specified.",
|
3600
3517
|
"type": [
|
3601
3518
|
"integer"
|
3602
3519
|
]
|
3603
3520
|
},
|
3604
|
-
"
|
3605
|
-
"
|
3606
|
-
"type": [
|
3607
|
-
"boolean"
|
3608
|
-
]
|
3521
|
+
"request": {
|
3522
|
+
"$ref": "#/definitions/event_request"
|
3609
3523
|
},
|
3610
|
-
"
|
3611
|
-
"description": "
|
3524
|
+
"type": {
|
3525
|
+
"description": "Description of the event: e.g. `invoice.created`, `charge.refunded`, etc.",
|
3612
3526
|
"type": [
|
3613
3527
|
"string"
|
3614
3528
|
]
|
3615
|
-
}
|
3616
|
-
|
3617
|
-
|
3618
|
-
|
3619
|
-
|
3620
|
-
|
3621
|
-
|
3622
|
-
|
3623
|
-
|
3624
|
-
|
3625
|
-
|
3626
|
-
|
3627
|
-
|
3628
|
-
|
3629
|
-
|
3630
|
-
|
3631
|
-
},
|
3632
|
-
"object": {
|
3633
|
-
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value \"list\".",
|
3634
|
-
"enum": [
|
3635
|
-
"list"
|
3636
|
-
],
|
3637
|
-
"type": [
|
3638
|
-
"string"
|
3639
|
-
]
|
3640
|
-
},
|
3641
|
-
"total_count": {
|
3642
|
-
"description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.",
|
3643
|
-
"type": [
|
3644
|
-
"integer"
|
3645
|
-
]
|
3646
|
-
},
|
3647
|
-
"url": {
|
3648
|
-
"description": "The URL where this list can be accessed.",
|
3649
|
-
"type": [
|
3650
|
-
"string"
|
3651
|
-
]
|
3652
|
-
}
|
3653
|
-
},
|
3654
|
-
"required": [
|
3655
|
-
"data",
|
3656
|
-
"has_more",
|
3657
|
-
"object",
|
3658
|
-
"url"
|
3659
|
-
],
|
3660
|
-
"title": "InvoiceLinesList",
|
3661
|
-
"type": [
|
3662
|
-
"object"
|
3663
|
-
],
|
3664
|
-
"x-expandableFields": [
|
3529
|
+
}
|
3530
|
+
},
|
3531
|
+
"required": [
|
3532
|
+
"created",
|
3533
|
+
"data",
|
3534
|
+
"id",
|
3535
|
+
"livemode",
|
3536
|
+
"object",
|
3537
|
+
"pending_webhooks",
|
3538
|
+
"type"
|
3539
|
+
],
|
3540
|
+
"title": "Event",
|
3541
|
+
"type": [
|
3542
|
+
"object"
|
3543
|
+
],
|
3544
|
+
"x-expandableFields": [
|
3665
3545
|
|
3666
|
-
|
3667
|
-
|
3668
|
-
|
3669
|
-
|
3670
|
-
|
3671
|
-
|
3672
|
-
]
|
3673
|
-
},
|
3674
|
-
"metadata": {
|
3675
|
-
"description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.",
|
3546
|
+
],
|
3547
|
+
"x-resourceId": "event"
|
3548
|
+
},
|
3549
|
+
"event_data": {
|
3550
|
+
"properties": {
|
3551
|
+
"object": {
|
3552
|
+
"description": "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](#invoice_object) as the value of the object key.",
|
3676
3553
|
"type": [
|
3677
3554
|
"object"
|
3678
3555
|
]
|
3679
3556
|
},
|
3680
|
-
"
|
3681
|
-
"description": "
|
3557
|
+
"previous_attributes": {
|
3558
|
+
"description": "Object containing the names of the attributes that have changed and their previous values (only sent along with *.updated events)",
|
3682
3559
|
"type": [
|
3683
|
-
"
|
3560
|
+
"object"
|
3684
3561
|
]
|
3685
|
-
}
|
3686
|
-
|
3687
|
-
|
3562
|
+
}
|
3563
|
+
},
|
3564
|
+
"required": [
|
3565
|
+
"object"
|
3566
|
+
],
|
3567
|
+
"title": "EventData",
|
3568
|
+
"type": [
|
3569
|
+
"object"
|
3570
|
+
],
|
3571
|
+
"x-expandableFields": [
|
3572
|
+
|
3573
|
+
],
|
3574
|
+
"x-resourceId": "event_data"
|
3575
|
+
},
|
3576
|
+
"event_request": {
|
3577
|
+
"properties": {
|
3578
|
+
"id": {
|
3579
|
+
"description": "ID of the API request that caused the event. If null, the event was automatic (e.g. Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs) but currently not in the API.",
|
3688
3580
|
"type": [
|
3689
3581
|
"string"
|
3690
3582
|
]
|
3691
3583
|
},
|
3692
|
-
"
|
3693
|
-
"description": "
|
3694
|
-
"type": [
|
3695
|
-
"boolean"
|
3696
|
-
]
|
3697
|
-
},
|
3698
|
-
"period_end": {
|
3699
|
-
"description": "End of the usage period during which invoice items were added to this invoice.",
|
3584
|
+
"idempotency_key": {
|
3585
|
+
"description": "The idempotency key transmitted during the request, if any. *Note: this proprety is only populated for events on or after May 23, 2017*.",
|
3700
3586
|
"type": [
|
3701
|
-
"
|
3702
|
-
]
|
3703
|
-
},
|
3704
|
-
"period_start": {
|
3705
|
-
"description": "Start of the usage period during which invoice items were added to this invoice.",
|
3706
|
-
"type": [
|
3707
|
-
"integer"
|
3587
|
+
"string"
|
3708
3588
|
]
|
3709
|
-
}
|
3710
|
-
|
3711
|
-
|
3589
|
+
}
|
3590
|
+
},
|
3591
|
+
"title": "EventRequest",
|
3592
|
+
"type": [
|
3593
|
+
"object"
|
3594
|
+
],
|
3595
|
+
"x-expandableFields": [
|
3596
|
+
|
3597
|
+
],
|
3598
|
+
"x-resourceId": "event_request"
|
3599
|
+
},
|
3600
|
+
"external_account_source": {
|
3601
|
+
"properties": {
|
3602
|
+
"account": {
|
3603
|
+
"description": "",
|
3712
3604
|
"type": [
|
3713
3605
|
"string"
|
3714
|
-
]
|
3606
|
+
],
|
3607
|
+
"x-expansionResources": {
|
3608
|
+
"oneOf": [
|
3609
|
+
{
|
3610
|
+
"$ref": "#/definitions/account"
|
3611
|
+
}
|
3612
|
+
]
|
3613
|
+
}
|
3715
3614
|
},
|
3716
|
-
"
|
3717
|
-
"description": "
|
3615
|
+
"country": {
|
3616
|
+
"description": "Two-letter ISO code representing the country the bank account is located in.",
|
3718
3617
|
"type": [
|
3719
|
-
"
|
3618
|
+
"string"
|
3720
3619
|
]
|
3721
3620
|
},
|
3722
|
-
"
|
3723
|
-
"description": "
|
3621
|
+
"currency": {
|
3622
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
|
3724
3623
|
"type": [
|
3725
3624
|
"string"
|
3726
3625
|
]
|
3727
3626
|
},
|
3728
|
-
"
|
3729
|
-
"description": "
|
3627
|
+
"customer": {
|
3628
|
+
"description": "",
|
3730
3629
|
"type": [
|
3731
3630
|
"string"
|
3732
3631
|
],
|
3733
3632
|
"x-expansionResources": {
|
3734
3633
|
"oneOf": [
|
3735
3634
|
{
|
3736
|
-
"$ref": "#/definitions/
|
3635
|
+
"$ref": "#/definitions/customer"
|
3737
3636
|
}
|
3738
3637
|
]
|
3739
3638
|
}
|
3740
3639
|
},
|
3741
|
-
"
|
3742
|
-
"description": "
|
3640
|
+
"default_for_currency": {
|
3641
|
+
"description": "Whether this external account is the default account for its currency.",
|
3743
3642
|
"type": [
|
3744
|
-
"
|
3643
|
+
"boolean"
|
3745
3644
|
]
|
3746
3645
|
},
|
3747
|
-
"
|
3748
|
-
"description": "
|
3646
|
+
"fingerprint": {
|
3647
|
+
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
|
3749
3648
|
"type": [
|
3750
|
-
"
|
3649
|
+
"string"
|
3751
3650
|
]
|
3752
3651
|
},
|
3753
|
-
"
|
3754
|
-
"description": "
|
3652
|
+
"id": {
|
3653
|
+
"description": "Unique identifier for the object.",
|
3755
3654
|
"type": [
|
3756
|
-
"
|
3655
|
+
"string"
|
3757
3656
|
]
|
3758
3657
|
},
|
3759
|
-
"
|
3760
|
-
"description": "
|
3658
|
+
"last4": {
|
3659
|
+
"description": "",
|
3761
3660
|
"type": [
|
3762
|
-
"
|
3661
|
+
"string"
|
3763
3662
|
]
|
3764
3663
|
},
|
3765
|
-
"
|
3766
|
-
"description": "
|
3664
|
+
"metadata": {
|
3665
|
+
"description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.",
|
3767
3666
|
"type": [
|
3768
|
-
"
|
3667
|
+
"object"
|
3769
3668
|
]
|
3770
3669
|
},
|
3771
|
-
"
|
3772
|
-
"description": "
|
3670
|
+
"object": {
|
3671
|
+
"description": "String representing the object's type. Objects of the same type share the same value.",
|
3773
3672
|
"type": [
|
3774
|
-
"
|
3673
|
+
"string"
|
3775
3674
|
]
|
3776
3675
|
}
|
3777
3676
|
},
|
3778
3677
|
"required": [
|
3779
|
-
"
|
3780
|
-
"attempt_count",
|
3781
|
-
"attempted",
|
3782
|
-
"closed",
|
3678
|
+
"country",
|
3783
3679
|
"currency",
|
3784
|
-
"customer",
|
3785
|
-
"date",
|
3786
|
-
"forgiven",
|
3787
3680
|
"id",
|
3788
|
-
"
|
3789
|
-
"
|
3790
|
-
"object",
|
3791
|
-
"paid",
|
3792
|
-
"period_end",
|
3793
|
-
"period_start",
|
3794
|
-
"starting_balance",
|
3795
|
-
"subtotal",
|
3796
|
-
"total"
|
3681
|
+
"last4",
|
3682
|
+
"object"
|
3797
3683
|
],
|
3798
|
-
"title": "
|
3684
|
+
"title": "Polymorphic",
|
3799
3685
|
"type": [
|
3800
3686
|
"object"
|
3801
3687
|
],
|
3802
3688
|
"x-expandableFields": [
|
3803
|
-
"
|
3804
|
-
"customer"
|
3805
|
-
"subscription"
|
3689
|
+
"account",
|
3690
|
+
"customer"
|
3806
3691
|
],
|
3807
|
-
"x-
|
3692
|
+
"x-polymorphicResources": {
|
3693
|
+
"oneOf": [
|
3694
|
+
{
|
3695
|
+
"$ref": "#/definitions/bank_account"
|
3696
|
+
},
|
3697
|
+
{
|
3698
|
+
"$ref": "#/definitions/card"
|
3699
|
+
}
|
3700
|
+
]
|
3701
|
+
},
|
3702
|
+
"x-resourceId": "external_account_source"
|
3808
3703
|
},
|
3809
|
-
"
|
3704
|
+
"fee": {
|
3810
3705
|
"properties": {
|
3811
3706
|
"amount": {
|
3812
|
-
"description": "Amount
|
3707
|
+
"description": "Amount of the fee, in cents.",
|
3813
3708
|
"type": [
|
3814
3709
|
"integer"
|
3815
3710
|
]
|
3816
3711
|
},
|
3712
|
+
"application": {
|
3713
|
+
"description": "",
|
3714
|
+
"type": [
|
3715
|
+
"string"
|
3716
|
+
]
|
3717
|
+
},
|
3817
3718
|
"currency": {
|
3818
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
3719
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
3819
3720
|
"type": [
|
3820
3721
|
"string"
|
3821
3722
|
]
|
3822
3723
|
},
|
3823
|
-
"
|
3824
|
-
"description": "
|
3724
|
+
"description": {
|
3725
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
3726
|
+
"type": [
|
3727
|
+
"string"
|
3728
|
+
]
|
3729
|
+
},
|
3730
|
+
"type": {
|
3731
|
+
"description": "Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`.",
|
3732
|
+
"type": [
|
3733
|
+
"string"
|
3734
|
+
]
|
3735
|
+
}
|
3736
|
+
},
|
3737
|
+
"required": [
|
3738
|
+
"amount",
|
3739
|
+
"currency",
|
3740
|
+
"type"
|
3741
|
+
],
|
3742
|
+
"title": "Fee",
|
3743
|
+
"type": [
|
3744
|
+
"object"
|
3745
|
+
],
|
3746
|
+
"x-expandableFields": [
|
3747
|
+
|
3748
|
+
],
|
3749
|
+
"x-resourceId": "fee"
|
3750
|
+
},
|
3751
|
+
"fee_refund": {
|
3752
|
+
"properties": {
|
3753
|
+
"amount": {
|
3754
|
+
"description": "Amount, in %s.",
|
3755
|
+
"type": [
|
3756
|
+
"integer"
|
3757
|
+
]
|
3758
|
+
},
|
3759
|
+
"balance_transaction": {
|
3760
|
+
"description": "Balance transaction that describes the impact on your account balance.",
|
3825
3761
|
"type": [
|
3826
3762
|
"string"
|
3827
3763
|
],
|
3828
3764
|
"x-expansionResources": {
|
3829
3765
|
"oneOf": [
|
3830
3766
|
{
|
3831
|
-
"$ref": "#/definitions/
|
3767
|
+
"$ref": "#/definitions/balance_transaction"
|
3832
3768
|
}
|
3833
3769
|
]
|
3834
3770
|
}
|
3835
3771
|
},
|
3836
|
-
"
|
3837
|
-
"description": "",
|
3772
|
+
"created": {
|
3773
|
+
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
3838
3774
|
"type": [
|
3839
3775
|
"integer"
|
3840
3776
|
]
|
3841
3777
|
},
|
3842
|
-
"
|
3843
|
-
"description": "
|
3844
|
-
"type": [
|
3845
|
-
"string"
|
3846
|
-
]
|
3847
|
-
},
|
3848
|
-
"discountable": {
|
3849
|
-
"description": "If true, discounts will apply to this invoice item. Always false for prorations.",
|
3850
|
-
"type": [
|
3851
|
-
"boolean"
|
3852
|
-
]
|
3853
|
-
},
|
3854
|
-
"id": {
|
3855
|
-
"description": "Unique identifier for the object.",
|
3778
|
+
"currency": {
|
3779
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
3856
3780
|
"type": [
|
3857
3781
|
"string"
|
3858
3782
|
]
|
3859
3783
|
},
|
3860
|
-
"
|
3861
|
-
"description": "
|
3784
|
+
"fee": {
|
3785
|
+
"description": "ID of the application fee that was refunded.",
|
3862
3786
|
"type": [
|
3863
3787
|
"string"
|
3864
3788
|
],
|
3865
3789
|
"x-expansionResources": {
|
3866
3790
|
"oneOf": [
|
3867
3791
|
{
|
3868
|
-
"$ref": "#/definitions/
|
3792
|
+
"$ref": "#/definitions/platform_fee"
|
3869
3793
|
}
|
3870
3794
|
]
|
3871
3795
|
}
|
3872
3796
|
},
|
3873
|
-
"
|
3874
|
-
"description": "
|
3797
|
+
"id": {
|
3798
|
+
"description": "Unique identifier for the object.",
|
3875
3799
|
"type": [
|
3876
|
-
"
|
3800
|
+
"string"
|
3877
3801
|
]
|
3878
3802
|
},
|
3879
3803
|
"metadata": {
|
@@ -3887,93 +3811,208 @@
|
|
3887
3811
|
"type": [
|
3888
3812
|
"string"
|
3889
3813
|
]
|
3814
|
+
}
|
3815
|
+
},
|
3816
|
+
"required": [
|
3817
|
+
"amount",
|
3818
|
+
"created",
|
3819
|
+
"currency",
|
3820
|
+
"fee",
|
3821
|
+
"id",
|
3822
|
+
"metadata",
|
3823
|
+
"object"
|
3824
|
+
],
|
3825
|
+
"title": "FeeRefund",
|
3826
|
+
"type": [
|
3827
|
+
"object"
|
3828
|
+
],
|
3829
|
+
"x-expandableFields": [
|
3830
|
+
"balance_transaction",
|
3831
|
+
"fee"
|
3832
|
+
],
|
3833
|
+
"x-resourceId": "fee_refund"
|
3834
|
+
},
|
3835
|
+
"file": {
|
3836
|
+
"properties": {
|
3837
|
+
"created": {
|
3838
|
+
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
3839
|
+
"type": [
|
3840
|
+
"integer"
|
3841
|
+
]
|
3890
3842
|
},
|
3891
|
-
"
|
3892
|
-
"description": "",
|
3843
|
+
"id": {
|
3844
|
+
"description": "Unique identifier for the object.",
|
3893
3845
|
"type": [
|
3894
|
-
"
|
3846
|
+
"string"
|
3895
3847
|
]
|
3896
3848
|
},
|
3897
|
-
"
|
3898
|
-
"
|
3849
|
+
"object": {
|
3850
|
+
"description": "String representing the object's type. Objects of the same type share the same value.",
|
3851
|
+
"type": [
|
3852
|
+
"string"
|
3853
|
+
]
|
3899
3854
|
},
|
3900
|
-
"
|
3901
|
-
"description": "
|
3855
|
+
"purpose": {
|
3856
|
+
"description": "The purpose of the uploaded file. Possible values are `business_logo`, `dispute_evidence`, `identity_document`, `incorporation_article`, `incorporation_document`, `invoice_statement`, `payment_provider_transfer`, or `product_feed`.",
|
3902
3857
|
"type": [
|
3903
|
-
"
|
3858
|
+
"string"
|
3904
3859
|
]
|
3905
3860
|
},
|
3906
|
-
"
|
3907
|
-
"description": "
|
3861
|
+
"size": {
|
3862
|
+
"description": "The size in bytes of the file upload object.",
|
3908
3863
|
"type": [
|
3909
3864
|
"integer"
|
3910
3865
|
]
|
3911
3866
|
},
|
3912
|
-
"
|
3913
|
-
"description": "The
|
3867
|
+
"type": {
|
3868
|
+
"description": "The type of the file returned. Returns one of the following: `pdf`, `xml`, `jpg`, `png`, `csv`, or `tsv`.",
|
3914
3869
|
"type": [
|
3915
3870
|
"string"
|
3916
|
-
]
|
3917
|
-
"x-expansionResources": {
|
3918
|
-
"oneOf": [
|
3919
|
-
{
|
3920
|
-
"$ref": "#/definitions/subscription"
|
3921
|
-
}
|
3922
|
-
]
|
3923
|
-
}
|
3871
|
+
]
|
3924
3872
|
},
|
3925
|
-
"
|
3926
|
-
"description": "",
|
3873
|
+
"url": {
|
3874
|
+
"description": "A read-only URL where the uploaded file can be accessed. Will be nil unless the uploaded file has one of the following purposes: `business_logo`, `dispute_evidence`, `incorporation_document`, `invoice_statement`, `payment_provider_transfer`, or `product_feed`. Also nil if retrieved with the publishable API key.",
|
3927
3875
|
"type": [
|
3928
3876
|
"string"
|
3929
3877
|
]
|
3930
3878
|
}
|
3931
3879
|
},
|
3932
3880
|
"required": [
|
3933
|
-
"
|
3934
|
-
"currency",
|
3935
|
-
"customer",
|
3936
|
-
"date",
|
3937
|
-
"discountable",
|
3881
|
+
"created",
|
3938
3882
|
"id",
|
3939
|
-
"livemode",
|
3940
|
-
"metadata",
|
3941
3883
|
"object",
|
3942
|
-
"
|
3884
|
+
"purpose",
|
3885
|
+
"size"
|
3943
3886
|
],
|
3944
|
-
"title": "
|
3887
|
+
"title": "File",
|
3945
3888
|
"type": [
|
3946
3889
|
"object"
|
3947
3890
|
],
|
3948
3891
|
"x-expandableFields": [
|
3949
|
-
|
3950
|
-
"invoice",
|
3951
|
-
"subscription"
|
3892
|
+
|
3952
3893
|
],
|
3953
|
-
"x-resourceId": "
|
3894
|
+
"x-resourceId": "file"
|
3954
3895
|
},
|
3955
|
-
"
|
3896
|
+
"inventory": {
|
3956
3897
|
"properties": {
|
3957
|
-
"
|
3958
|
-
"description": "The
|
3898
|
+
"quantity": {
|
3899
|
+
"description": "The count of inventory available. Will be present if and only if `type` is `finite`.",
|
3959
3900
|
"type": [
|
3960
3901
|
"integer"
|
3961
3902
|
]
|
3962
3903
|
},
|
3904
|
+
"type": {
|
3905
|
+
"description": "Inventory type. Possible values are `finite`, `bucket` (not quantified), and `infinite`.",
|
3906
|
+
"type": [
|
3907
|
+
"string"
|
3908
|
+
]
|
3909
|
+
},
|
3910
|
+
"value": {
|
3911
|
+
"description": "An indicator of the inventory available. Possible values are `in_stock`, `limited`, and `out_of_stock`. Will be present if and only if `type` is `bucket`.",
|
3912
|
+
"type": [
|
3913
|
+
"string"
|
3914
|
+
]
|
3915
|
+
}
|
3916
|
+
},
|
3917
|
+
"required": [
|
3918
|
+
"type"
|
3919
|
+
],
|
3920
|
+
"title": "Inventory",
|
3921
|
+
"type": [
|
3922
|
+
"object"
|
3923
|
+
],
|
3924
|
+
"x-expandableFields": [
|
3925
|
+
|
3926
|
+
],
|
3927
|
+
"x-resourceId": "inventory"
|
3928
|
+
},
|
3929
|
+
"invoice": {
|
3930
|
+
"properties": {
|
3931
|
+
"amount_due": {
|
3932
|
+
"description": "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.",
|
3933
|
+
"type": [
|
3934
|
+
"integer"
|
3935
|
+
]
|
3936
|
+
},
|
3937
|
+
"application_fee": {
|
3938
|
+
"description": "The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.",
|
3939
|
+
"type": [
|
3940
|
+
"integer"
|
3941
|
+
]
|
3942
|
+
},
|
3943
|
+
"attempt_count": {
|
3944
|
+
"description": "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.",
|
3945
|
+
"type": [
|
3946
|
+
"integer"
|
3947
|
+
]
|
3948
|
+
},
|
3949
|
+
"attempted": {
|
3950
|
+
"description": "Whether or not an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.",
|
3951
|
+
"type": [
|
3952
|
+
"boolean"
|
3953
|
+
]
|
3954
|
+
},
|
3955
|
+
"charge": {
|
3956
|
+
"description": "ID of the latest charge generated for this invoice, if any.",
|
3957
|
+
"type": [
|
3958
|
+
"string"
|
3959
|
+
],
|
3960
|
+
"x-expansionResources": {
|
3961
|
+
"oneOf": [
|
3962
|
+
{
|
3963
|
+
"$ref": "#/definitions/charge"
|
3964
|
+
}
|
3965
|
+
]
|
3966
|
+
}
|
3967
|
+
},
|
3968
|
+
"closed": {
|
3969
|
+
"description": "Whether or not the invoice is still trying to collect payment. An invoice is closed if it's either paid or it has been marked closed. A closed invoice will no longer attempt to collect payment.",
|
3970
|
+
"type": [
|
3971
|
+
"boolean"
|
3972
|
+
]
|
3973
|
+
},
|
3963
3974
|
"currency": {
|
3964
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
3975
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
3965
3976
|
"type": [
|
3966
3977
|
"string"
|
3967
3978
|
]
|
3968
3979
|
},
|
3969
|
-
"
|
3970
|
-
"description": "
|
3980
|
+
"customer": {
|
3981
|
+
"description": "",
|
3982
|
+
"type": [
|
3983
|
+
"string"
|
3984
|
+
],
|
3985
|
+
"x-expansionResources": {
|
3986
|
+
"oneOf": [
|
3987
|
+
{
|
3988
|
+
"$ref": "#/definitions/customer"
|
3989
|
+
}
|
3990
|
+
]
|
3991
|
+
}
|
3992
|
+
},
|
3993
|
+
"date": {
|
3994
|
+
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
3995
|
+
"type": [
|
3996
|
+
"integer"
|
3997
|
+
]
|
3998
|
+
},
|
3999
|
+
"description": {
|
4000
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
4001
|
+
"type": [
|
4002
|
+
"string"
|
4003
|
+
]
|
4004
|
+
},
|
4005
|
+
"discount": {
|
4006
|
+
"$ref": "#/definitions/discount"
|
4007
|
+
},
|
4008
|
+
"ending_balance": {
|
4009
|
+
"description": "Ending customer balance after attempting to pay invoice. If the invoice has not been attempted yet, this will be null.",
|
3971
4010
|
"type": [
|
3972
|
-
"
|
4011
|
+
"integer"
|
3973
4012
|
]
|
3974
4013
|
},
|
3975
|
-
"
|
3976
|
-
"description": "
|
4014
|
+
"forgiven": {
|
4015
|
+
"description": "Whether or not the invoice has been forgiven. Forgiving an invoice instructs us to update the subscription status as if the invoice were successfully paid. Once an invoice has been forgiven, it cannot be unforgiven or reopened.",
|
3977
4016
|
"type": [
|
3978
4017
|
"boolean"
|
3979
4018
|
]
|
@@ -3984,8 +4023,60 @@
|
|
3984
4023
|
"string"
|
3985
4024
|
]
|
3986
4025
|
},
|
4026
|
+
"lines": {
|
4027
|
+
"properties": {
|
4028
|
+
"data": {
|
4029
|
+
"items": {
|
4030
|
+
"$ref": "#/definitions/invoice_line_item"
|
4031
|
+
},
|
4032
|
+
"type": [
|
4033
|
+
"array"
|
4034
|
+
]
|
4035
|
+
},
|
4036
|
+
"has_more": {
|
4037
|
+
"description": "True if this list has another page of items after this one that can be fetched.",
|
4038
|
+
"type": [
|
4039
|
+
"boolean"
|
4040
|
+
]
|
4041
|
+
},
|
4042
|
+
"object": {
|
4043
|
+
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value \"list\".",
|
4044
|
+
"enum": [
|
4045
|
+
"list"
|
4046
|
+
],
|
4047
|
+
"type": [
|
4048
|
+
"string"
|
4049
|
+
]
|
4050
|
+
},
|
4051
|
+
"total_count": {
|
4052
|
+
"description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.",
|
4053
|
+
"type": [
|
4054
|
+
"integer"
|
4055
|
+
]
|
4056
|
+
},
|
4057
|
+
"url": {
|
4058
|
+
"description": "The URL where this list can be accessed.",
|
4059
|
+
"type": [
|
4060
|
+
"string"
|
4061
|
+
]
|
4062
|
+
}
|
4063
|
+
},
|
4064
|
+
"required": [
|
4065
|
+
"data",
|
4066
|
+
"has_more",
|
4067
|
+
"object",
|
4068
|
+
"url"
|
4069
|
+
],
|
4070
|
+
"title": "InvoiceLinesList",
|
4071
|
+
"type": [
|
4072
|
+
"object"
|
4073
|
+
],
|
4074
|
+
"x-expandableFields": [
|
4075
|
+
|
4076
|
+
]
|
4077
|
+
},
|
3987
4078
|
"livemode": {
|
3988
|
-
"description": "
|
4079
|
+
"description": "Flag indicating whether the object exists in live mode or test mode.",
|
3989
4080
|
"type": [
|
3990
4081
|
"boolean"
|
3991
4082
|
]
|
@@ -3996,244 +4087,307 @@
|
|
3996
4087
|
"object"
|
3997
4088
|
]
|
3998
4089
|
},
|
4090
|
+
"next_payment_attempt": {
|
4091
|
+
"description": "The time at which payment will next be attempted.",
|
4092
|
+
"type": [
|
4093
|
+
"integer"
|
4094
|
+
]
|
4095
|
+
},
|
3999
4096
|
"object": {
|
4000
4097
|
"description": "String representing the object's type. Objects of the same type share the same value.",
|
4001
4098
|
"type": [
|
4002
4099
|
"string"
|
4003
4100
|
]
|
4004
4101
|
},
|
4005
|
-
"
|
4006
|
-
"description": "
|
4102
|
+
"paid": {
|
4103
|
+
"description": "Whether or not payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.",
|
4007
4104
|
"type": [
|
4008
|
-
"
|
4105
|
+
"boolean"
|
4009
4106
|
]
|
4010
4107
|
},
|
4011
|
-
"
|
4012
|
-
"
|
4013
|
-
},
|
4014
|
-
"proration": {
|
4015
|
-
"description": "Whether or not this is a proration.",
|
4108
|
+
"period_end": {
|
4109
|
+
"description": "End of the usage period during which invoice items were added to this invoice.",
|
4016
4110
|
"type": [
|
4017
|
-
"
|
4111
|
+
"integer"
|
4018
4112
|
]
|
4019
4113
|
},
|
4020
|
-
"
|
4021
|
-
"description": "
|
4114
|
+
"period_start": {
|
4115
|
+
"description": "Start of the usage period during which invoice items were added to this invoice.",
|
4022
4116
|
"type": [
|
4023
4117
|
"integer"
|
4024
4118
|
]
|
4025
4119
|
},
|
4026
|
-
"
|
4027
|
-
"description": "
|
4120
|
+
"receipt_number": {
|
4121
|
+
"description": "This is the transaction number that appears on email receipts sent for this invoice.",
|
4028
4122
|
"type": [
|
4029
4123
|
"string"
|
4030
4124
|
]
|
4031
4125
|
},
|
4032
|
-
"
|
4033
|
-
"description": "",
|
4126
|
+
"starting_balance": {
|
4127
|
+
"description": "Starting customer balance before attempting to pay invoice. If the invoice has not been attempted yet, this will be the current customer balance.",
|
4034
4128
|
"type": [
|
4035
|
-
"
|
4129
|
+
"integer"
|
4036
4130
|
]
|
4037
4131
|
},
|
4038
|
-
"
|
4039
|
-
"description": "
|
4132
|
+
"statement_descriptor": {
|
4133
|
+
"description": "Extra information about an invoice for the customer's credit card statement.",
|
4040
4134
|
"type": [
|
4041
4135
|
"string"
|
4042
4136
|
]
|
4043
|
-
}
|
4044
|
-
},
|
4045
|
-
"required": [
|
4046
|
-
"amount",
|
4047
|
-
"currency",
|
4048
|
-
"discountable",
|
4049
|
-
"id",
|
4050
|
-
"livemode",
|
4051
|
-
"metadata",
|
4052
|
-
"object",
|
4053
|
-
"period",
|
4054
|
-
"proration",
|
4055
|
-
"type"
|
4056
|
-
],
|
4057
|
-
"title": "InvoiceLineItem",
|
4058
|
-
"type": [
|
4059
|
-
"object"
|
4060
|
-
],
|
4061
|
-
"x-expandableFields": [
|
4062
|
-
|
4063
|
-
],
|
4064
|
-
"x-resourceId": "invoice_line_item"
|
4065
|
-
},
|
4066
|
-
"issued_card": {
|
4067
|
-
"properties": {
|
4068
|
-
"available_balance": {
|
4069
|
-
"description": "",
|
4070
|
-
"type": [
|
4071
|
-
"integer"
|
4072
|
-
]
|
4073
4137
|
},
|
4074
|
-
"
|
4075
|
-
"description": "",
|
4138
|
+
"subscription": {
|
4139
|
+
"description": "The subscription that this invoice was prepared for, if any.",
|
4076
4140
|
"type": [
|
4077
4141
|
"string"
|
4078
4142
|
],
|
4079
4143
|
"x-expansionResources": {
|
4080
4144
|
"oneOf": [
|
4081
4145
|
{
|
4082
|
-
"$ref": "#/definitions/
|
4146
|
+
"$ref": "#/definitions/subscription"
|
4083
4147
|
}
|
4084
4148
|
]
|
4085
4149
|
}
|
4086
4150
|
},
|
4087
|
-
"
|
4088
|
-
"description": "
|
4151
|
+
"subscription_proration_date": {
|
4152
|
+
"description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.",
|
4089
4153
|
"type": [
|
4090
|
-
"
|
4154
|
+
"integer"
|
4091
4155
|
]
|
4092
4156
|
},
|
4093
|
-
"
|
4094
|
-
"description": "
|
4157
|
+
"subtotal": {
|
4158
|
+
"description": "Total of all subscriptions, invoice items, and prorations on the invoice before any discount is applied.",
|
4095
4159
|
"type": [
|
4096
|
-
"
|
4160
|
+
"integer"
|
4097
4161
|
]
|
4098
4162
|
},
|
4099
|
-
"
|
4100
|
-
"description": "
|
4163
|
+
"tax": {
|
4164
|
+
"description": "The amount of tax included in the total, calculated from `tax_percent` and the subtotal. If no `tax_percent` is defined, this value will be null.",
|
4101
4165
|
"type": [
|
4102
|
-
"
|
4166
|
+
"integer"
|
4103
4167
|
]
|
4104
4168
|
},
|
4105
|
-
"
|
4106
|
-
"description": "",
|
4169
|
+
"tax_percent": {
|
4170
|
+
"description": "This percentage of the subtotal has been added to the total amount of the invoice, including invoice line items and discounts. This field is inherited from the subscription's `tax_percent` field, but can be changed before the invoice is paid. This field defaults to null.",
|
4107
4171
|
"type": [
|
4108
|
-
"
|
4172
|
+
"number"
|
4173
|
+
]
|
4174
|
+
},
|
4175
|
+
"total": {
|
4176
|
+
"description": "Total after discount.",
|
4177
|
+
"type": [
|
4178
|
+
"integer"
|
4179
|
+
]
|
4180
|
+
},
|
4181
|
+
"webhooks_delivered_at": {
|
4182
|
+
"description": "The time at which webhooks for this invoice were successfully delivered (if the invoice had no webhooks to deliver, this will match `date`). Invoice payment is delayed until webhooks are delivered, or until all webhook delivery attempts have been exhausted.",
|
4183
|
+
"type": [
|
4184
|
+
"integer"
|
4109
4185
|
]
|
4110
4186
|
}
|
4111
4187
|
},
|
4112
4188
|
"required": [
|
4113
|
-
"
|
4114
|
-
"
|
4189
|
+
"amount_due",
|
4190
|
+
"attempt_count",
|
4191
|
+
"attempted",
|
4192
|
+
"closed",
|
4115
4193
|
"currency",
|
4194
|
+
"customer",
|
4195
|
+
"date",
|
4196
|
+
"forgiven",
|
4116
4197
|
"id",
|
4198
|
+
"lines",
|
4199
|
+
"livemode",
|
4117
4200
|
"object",
|
4118
|
-
"
|
4201
|
+
"paid",
|
4202
|
+
"period_end",
|
4203
|
+
"period_start",
|
4204
|
+
"starting_balance",
|
4205
|
+
"subtotal",
|
4206
|
+
"total"
|
4119
4207
|
],
|
4120
|
-
"title": "
|
4208
|
+
"title": "Invoice",
|
4121
4209
|
"type": [
|
4122
4210
|
"object"
|
4123
4211
|
],
|
4124
4212
|
"x-expandableFields": [
|
4125
|
-
"
|
4213
|
+
"charge",
|
4214
|
+
"customer",
|
4215
|
+
"subscription"
|
4126
4216
|
],
|
4127
|
-
"x-resourceId": "
|
4217
|
+
"x-resourceId": "invoice"
|
4128
4218
|
},
|
4129
|
-
"
|
4219
|
+
"invoice_item": {
|
4130
4220
|
"properties": {
|
4131
4221
|
"amount": {
|
4132
|
-
"description": "Amount (in
|
4222
|
+
"description": "Amount (in the `currency` specified) of the invoice item.",
|
4133
4223
|
"type": [
|
4134
4224
|
"integer"
|
4135
4225
|
]
|
4136
4226
|
},
|
4137
|
-
"
|
4138
|
-
"description": "
|
4227
|
+
"currency": {
|
4228
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
4139
4229
|
"type": [
|
4140
|
-
"
|
4230
|
+
"string"
|
4141
4231
|
]
|
4142
4232
|
},
|
4143
|
-
"
|
4144
|
-
"description": "",
|
4233
|
+
"customer": {
|
4234
|
+
"description": "The ID of the customer who will be billed when this invoice item is billed.",
|
4145
4235
|
"type": [
|
4146
4236
|
"string"
|
4147
4237
|
],
|
4148
4238
|
"x-expansionResources": {
|
4149
4239
|
"oneOf": [
|
4150
4240
|
{
|
4151
|
-
"$ref": "#/definitions/
|
4241
|
+
"$ref": "#/definitions/customer"
|
4152
4242
|
}
|
4153
4243
|
]
|
4154
4244
|
}
|
4155
4245
|
},
|
4156
|
-
"
|
4157
|
-
"description": "
|
4246
|
+
"date": {
|
4247
|
+
"description": "",
|
4248
|
+
"type": [
|
4249
|
+
"integer"
|
4250
|
+
]
|
4251
|
+
},
|
4252
|
+
"description": {
|
4253
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
4254
|
+
"type": [
|
4255
|
+
"string"
|
4256
|
+
]
|
4257
|
+
},
|
4258
|
+
"discountable": {
|
4259
|
+
"description": "If true, discounts will apply to this invoice item. Always false for prorations.",
|
4260
|
+
"type": [
|
4261
|
+
"boolean"
|
4262
|
+
]
|
4263
|
+
},
|
4264
|
+
"id": {
|
4265
|
+
"description": "Unique identifier for the object.",
|
4266
|
+
"type": [
|
4267
|
+
"string"
|
4268
|
+
]
|
4269
|
+
},
|
4270
|
+
"invoice": {
|
4271
|
+
"description": "The ID of the invoice this invoice item belongs to.",
|
4158
4272
|
"type": [
|
4159
4273
|
"string"
|
4160
4274
|
],
|
4161
4275
|
"x-expansionResources": {
|
4162
4276
|
"oneOf": [
|
4163
4277
|
{
|
4164
|
-
"$ref": "#/definitions/
|
4278
|
+
"$ref": "#/definitions/invoice"
|
4165
4279
|
}
|
4166
4280
|
]
|
4167
4281
|
}
|
4168
4282
|
},
|
4169
|
-
"
|
4170
|
-
"description": "
|
4283
|
+
"livemode": {
|
4284
|
+
"description": "Flag indicating whether the object exists in live mode or test mode.",
|
4285
|
+
"type": [
|
4286
|
+
"boolean"
|
4287
|
+
]
|
4288
|
+
},
|
4289
|
+
"metadata": {
|
4290
|
+
"description": "Set of key/value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.",
|
4291
|
+
"type": [
|
4292
|
+
"object"
|
4293
|
+
]
|
4294
|
+
},
|
4295
|
+
"object": {
|
4296
|
+
"description": "String representing the object's type. Objects of the same type share the same value.",
|
4171
4297
|
"type": [
|
4172
|
-
"
|
4298
|
+
"string"
|
4173
4299
|
]
|
4174
4300
|
},
|
4175
|
-
"
|
4176
|
-
"description": "
|
4301
|
+
"period": {
|
4302
|
+
"description": "",
|
4177
4303
|
"type": [
|
4178
|
-
"
|
4304
|
+
"object"
|
4179
4305
|
]
|
4180
4306
|
},
|
4181
|
-
"
|
4182
|
-
"
|
4307
|
+
"plan": {
|
4308
|
+
"$ref": "#/definitions/plan"
|
4309
|
+
},
|
4310
|
+
"proration": {
|
4311
|
+
"description": "Whether or not the invoice item was created automatically as a proration adjustment when the customer switched plans.",
|
4183
4312
|
"type": [
|
4184
|
-
"
|
4313
|
+
"boolean"
|
4185
4314
|
]
|
4186
4315
|
},
|
4187
|
-
"
|
4188
|
-
"description": "
|
4316
|
+
"quantity": {
|
4317
|
+
"description": "If the invoice item is a proration, the quantity of the subscription that the proration was computed for.",
|
4189
4318
|
"type": [
|
4190
|
-
"
|
4319
|
+
"integer"
|
4191
4320
|
]
|
4192
4321
|
},
|
4193
|
-
"
|
4194
|
-
"description": "
|
4322
|
+
"subscription": {
|
4323
|
+
"description": "The subscription that this invoice item has been created for, if any.",
|
4195
4324
|
"type": [
|
4196
4325
|
"string"
|
4197
4326
|
],
|
4198
4327
|
"x-expansionResources": {
|
4199
4328
|
"oneOf": [
|
4200
4329
|
{
|
4201
|
-
"$ref": "#/definitions/
|
4202
|
-
},
|
4203
|
-
{
|
4204
|
-
"$ref": "#/definitions/bank_account"
|
4205
|
-
},
|
4206
|
-
{
|
4207
|
-
"$ref": "#/definitions/card"
|
4330
|
+
"$ref": "#/definitions/subscription"
|
4208
4331
|
}
|
4209
4332
|
]
|
4210
4333
|
}
|
4211
4334
|
},
|
4212
|
-
"
|
4213
|
-
"description": "
|
4335
|
+
"subscription_item": {
|
4336
|
+
"description": "",
|
4214
4337
|
"type": [
|
4215
4338
|
"string"
|
4216
|
-
]
|
4217
|
-
|
4218
|
-
|
4219
|
-
|
4220
|
-
|
4221
|
-
|
4222
|
-
|
4223
|
-
|
4339
|
+
]
|
4340
|
+
}
|
4341
|
+
},
|
4342
|
+
"required": [
|
4343
|
+
"amount",
|
4344
|
+
"currency",
|
4345
|
+
"customer",
|
4346
|
+
"date",
|
4347
|
+
"discountable",
|
4348
|
+
"id",
|
4349
|
+
"livemode",
|
4350
|
+
"metadata",
|
4351
|
+
"object",
|
4352
|
+
"proration"
|
4353
|
+
],
|
4354
|
+
"title": "InvoiceItem",
|
4355
|
+
"type": [
|
4356
|
+
"object"
|
4357
|
+
],
|
4358
|
+
"x-expandableFields": [
|
4359
|
+
"customer",
|
4360
|
+
"invoice",
|
4361
|
+
"subscription"
|
4362
|
+
],
|
4363
|
+
"x-resourceId": "invoice_item"
|
4364
|
+
},
|
4365
|
+
"invoice_line_item": {
|
4366
|
+
"properties": {
|
4367
|
+
"amount": {
|
4368
|
+
"description": "The amount, in %s.",
|
4369
|
+
"type": [
|
4370
|
+
"integer"
|
4371
|
+
]
|
4224
4372
|
},
|
4225
|
-
"
|
4226
|
-
"description": "
|
4373
|
+
"currency": {
|
4374
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
4227
4375
|
"type": [
|
4228
4376
|
"string"
|
4229
4377
|
]
|
4230
4378
|
},
|
4231
|
-
"
|
4232
|
-
"description": "
|
4379
|
+
"description": {
|
4380
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
4233
4381
|
"type": [
|
4234
4382
|
"string"
|
4235
4383
|
]
|
4236
4384
|
},
|
4385
|
+
"discountable": {
|
4386
|
+
"description": "If true, discounts will apply to this line item. Always false for prorations.",
|
4387
|
+
"type": [
|
4388
|
+
"boolean"
|
4389
|
+
]
|
4390
|
+
},
|
4237
4391
|
"id": {
|
4238
4392
|
"description": "Unique identifier for the object.",
|
4239
4393
|
"type": [
|
@@ -4241,7 +4395,7 @@
|
|
4241
4395
|
]
|
4242
4396
|
},
|
4243
4397
|
"livemode": {
|
4244
|
-
"description": "
|
4398
|
+
"description": "Whether or not this is a test line item.",
|
4245
4399
|
"type": [
|
4246
4400
|
"boolean"
|
4247
4401
|
]
|
@@ -4252,121 +4406,47 @@
|
|
4252
4406
|
"object"
|
4253
4407
|
]
|
4254
4408
|
},
|
4255
|
-
"method": {
|
4256
|
-
"description": "The method used to send this transfer, which can be `standard` or `instant`. `instant` is only supported for transfers to debit cards. (See [Instant payouts for marketplaces](/blog/instant-payouts-for-marketplaces) for more information.)",
|
4257
|
-
"type": [
|
4258
|
-
"string"
|
4259
|
-
]
|
4260
|
-
},
|
4261
4409
|
"object": {
|
4262
4410
|
"description": "String representing the object's type. Objects of the same type share the same value.",
|
4263
4411
|
"type": [
|
4264
4412
|
"string"
|
4265
4413
|
]
|
4266
4414
|
},
|
4267
|
-
"
|
4268
|
-
"
|
4269
|
-
"data": {
|
4270
|
-
"items": {
|
4271
|
-
"$ref": "#/definitions/transfer_reversal"
|
4272
|
-
},
|
4273
|
-
"type": [
|
4274
|
-
"array"
|
4275
|
-
]
|
4276
|
-
},
|
4277
|
-
"has_more": {
|
4278
|
-
"description": "True if this list has another page of items after this one that can be fetched.",
|
4279
|
-
"type": [
|
4280
|
-
"boolean"
|
4281
|
-
]
|
4282
|
-
},
|
4283
|
-
"object": {
|
4284
|
-
"description": "String representing the object's type. Objects of the same type share the same value. Always has the value \"list\".",
|
4285
|
-
"enum": [
|
4286
|
-
"list"
|
4287
|
-
],
|
4288
|
-
"type": [
|
4289
|
-
"string"
|
4290
|
-
]
|
4291
|
-
},
|
4292
|
-
"total_count": {
|
4293
|
-
"description": "The total number of items available. This value is not included by default, but you can request it by specifying ?include[]=total_count.",
|
4294
|
-
"type": [
|
4295
|
-
"integer"
|
4296
|
-
]
|
4297
|
-
},
|
4298
|
-
"url": {
|
4299
|
-
"description": "The URL where this list can be accessed.",
|
4300
|
-
"type": [
|
4301
|
-
"string"
|
4302
|
-
]
|
4303
|
-
}
|
4304
|
-
},
|
4305
|
-
"required": [
|
4306
|
-
"data",
|
4307
|
-
"has_more",
|
4308
|
-
"object",
|
4309
|
-
"url"
|
4310
|
-
],
|
4311
|
-
"title": "TransferReversalList",
|
4415
|
+
"period": {
|
4416
|
+
"description": "The period this line_item covers. For subscription line items, this is the subscription period. For prorations, this starts when the proration was calculated, and ends at the period end of the subscription. For invoice items, this is the time at which the invoice item was created, so the period start and end are the same time.",
|
4312
4417
|
"type": [
|
4313
4418
|
"object"
|
4314
|
-
],
|
4315
|
-
"x-expandableFields": [
|
4316
|
-
|
4317
|
-
]
|
4318
|
-
},
|
4319
|
-
"reversed": {
|
4320
|
-
"description": "Whether or not the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.",
|
4321
|
-
"type": [
|
4322
|
-
"boolean"
|
4323
4419
|
]
|
4324
4420
|
},
|
4325
|
-
"
|
4326
|
-
"
|
4327
|
-
"type": [
|
4328
|
-
"string"
|
4329
|
-
],
|
4330
|
-
"x-expansionResources": {
|
4331
|
-
"oneOf": [
|
4332
|
-
{
|
4333
|
-
"$ref": "#/definitions/charge"
|
4334
|
-
},
|
4335
|
-
{
|
4336
|
-
"$ref": "#/definitions/platform_fee"
|
4337
|
-
},
|
4338
|
-
{
|
4339
|
-
"$ref": "#/definitions/transfer_reversal"
|
4340
|
-
}
|
4341
|
-
]
|
4342
|
-
}
|
4421
|
+
"plan": {
|
4422
|
+
"$ref": "#/definitions/plan"
|
4343
4423
|
},
|
4344
|
-
"
|
4345
|
-
"description": "
|
4424
|
+
"proration": {
|
4425
|
+
"description": "Whether or not this is a proration.",
|
4346
4426
|
"type": [
|
4347
|
-
"
|
4427
|
+
"boolean"
|
4348
4428
|
]
|
4349
4429
|
},
|
4350
|
-
"
|
4351
|
-
"description": "
|
4430
|
+
"quantity": {
|
4431
|
+
"description": "The quantity of the subscription, if the line item is a subscription or a proration.",
|
4352
4432
|
"type": [
|
4353
|
-
"
|
4433
|
+
"integer"
|
4354
4434
|
]
|
4355
4435
|
},
|
4356
|
-
"
|
4357
|
-
"description": "
|
4436
|
+
"subscription": {
|
4437
|
+
"description": "When type is `invoiceitem`, the subscription that the invoice item pertains to, if any. Left blank when `type` is already subscription, as it'd be redundant with `id`.",
|
4358
4438
|
"type": [
|
4359
4439
|
"string"
|
4360
4440
|
]
|
4361
4441
|
},
|
4362
|
-
"
|
4363
|
-
"description": "
|
4442
|
+
"subscription_item": {
|
4443
|
+
"description": "",
|
4364
4444
|
"type": [
|
4365
4445
|
"string"
|
4366
4446
|
]
|
4367
4447
|
},
|
4368
4448
|
"type": {
|
4369
|
-
"description": "
|
4449
|
+
"description": "A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.",
|
4370
4450
|
"type": [
|
4371
4451
|
"string"
|
4372
4452
|
]
|
@@ -4374,31 +4454,24 @@
|
|
4374
4454
|
},
|
4375
4455
|
"required": [
|
4376
4456
|
"amount",
|
4377
|
-
"amount_reversed",
|
4378
|
-
"created",
|
4379
4457
|
"currency",
|
4380
|
-
"
|
4458
|
+
"discountable",
|
4381
4459
|
"id",
|
4382
4460
|
"livemode",
|
4383
4461
|
"metadata",
|
4384
4462
|
"object",
|
4385
|
-
"
|
4386
|
-
"
|
4387
|
-
"status",
|
4463
|
+
"period",
|
4464
|
+
"proration",
|
4388
4465
|
"type"
|
4389
4466
|
],
|
4390
|
-
"title": "
|
4467
|
+
"title": "InvoiceLineItem",
|
4391
4468
|
"type": [
|
4392
4469
|
"object"
|
4393
4470
|
],
|
4394
4471
|
"x-expandableFields": [
|
4395
|
-
|
4396
|
-
"balance_transaction",
|
4397
|
-
"destination",
|
4398
|
-
"destination_payment",
|
4399
|
-
"source_transaction"
|
4472
|
+
|
4400
4473
|
],
|
4401
|
-
"x-resourceId": "
|
4474
|
+
"x-resourceId": "invoice_line_item"
|
4402
4475
|
},
|
4403
4476
|
"legal_entity": {
|
4404
4477
|
"properties": {
|
@@ -4527,6 +4600,12 @@
|
|
4527
4600
|
"boolean"
|
4528
4601
|
]
|
4529
4602
|
},
|
4603
|
+
"tax_id_registrar": {
|
4604
|
+
"description": "",
|
4605
|
+
"type": [
|
4606
|
+
"string"
|
4607
|
+
]
|
4608
|
+
},
|
4530
4609
|
"type": {
|
4531
4610
|
"description": "Either \"individual\" or \"company\", for what kind of legal entity the account owner is for.",
|
4532
4611
|
"type": [
|
@@ -4855,7 +4934,7 @@
|
|
4855
4934
|
"order": {
|
4856
4935
|
"properties": {
|
4857
4936
|
"amount": {
|
4858
|
-
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
4937
|
+
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order.",
|
4859
4938
|
"type": [
|
4860
4939
|
"integer"
|
4861
4940
|
]
|
@@ -4898,7 +4977,7 @@
|
|
4898
4977
|
]
|
4899
4978
|
},
|
4900
4979
|
"currency": {
|
4901
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
4980
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
4902
4981
|
"type": [
|
4903
4982
|
"string"
|
4904
4983
|
]
|
@@ -5065,13 +5144,13 @@
|
|
5065
5144
|
"order_item": {
|
5066
5145
|
"properties": {
|
5067
5146
|
"amount": {
|
5068
|
-
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
5147
|
+
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.",
|
5069
5148
|
"type": [
|
5070
5149
|
"integer"
|
5071
5150
|
]
|
5072
5151
|
},
|
5073
5152
|
"currency": {
|
5074
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
5153
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
5075
5154
|
"type": [
|
5076
5155
|
"string"
|
5077
5156
|
]
|
@@ -5136,7 +5215,7 @@
|
|
5136
5215
|
"order_return": {
|
5137
5216
|
"properties": {
|
5138
5217
|
"amount": {
|
5139
|
-
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
5218
|
+
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the returned line item.",
|
5140
5219
|
"type": [
|
5141
5220
|
"integer"
|
5142
5221
|
]
|
@@ -5148,7 +5227,7 @@
|
|
5148
5227
|
]
|
5149
5228
|
},
|
5150
5229
|
"currency": {
|
5151
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
5230
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
5152
5231
|
"type": [
|
5153
5232
|
"string"
|
5154
5233
|
]
|
@@ -5296,7 +5375,13 @@
|
|
5296
5375
|
]
|
5297
5376
|
},
|
5298
5377
|
"currency": {
|
5299
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
5378
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
5379
|
+
"type": [
|
5380
|
+
"string"
|
5381
|
+
]
|
5382
|
+
},
|
5383
|
+
"description": {
|
5384
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
5300
5385
|
"type": [
|
5301
5386
|
"string"
|
5302
5387
|
]
|
@@ -5438,7 +5523,7 @@
|
|
5438
5523
|
]
|
5439
5524
|
},
|
5440
5525
|
"currency": {
|
5441
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
5526
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
5442
5527
|
"type": [
|
5443
5528
|
"string"
|
5444
5529
|
]
|
@@ -5592,7 +5677,7 @@
|
|
5592
5677
|
]
|
5593
5678
|
},
|
5594
5679
|
"currency": {
|
5595
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
5680
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
5596
5681
|
"type": [
|
5597
5682
|
"string"
|
5598
5683
|
]
|
@@ -5791,7 +5876,7 @@
|
|
5791
5876
|
]
|
5792
5877
|
},
|
5793
5878
|
"currency": {
|
5794
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
5879
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
5795
5880
|
"type": [
|
5796
5881
|
"string"
|
5797
5882
|
]
|
@@ -6128,7 +6213,7 @@
|
|
6128
6213
|
]
|
6129
6214
|
},
|
6130
6215
|
"currency": {
|
6131
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
6216
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
6132
6217
|
"type": [
|
6133
6218
|
"string"
|
6134
6219
|
]
|
@@ -6203,7 +6288,7 @@
|
|
6203
6288
|
]
|
6204
6289
|
},
|
6205
6290
|
"currency": {
|
6206
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
6291
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
6207
6292
|
"type": [
|
6208
6293
|
"string"
|
6209
6294
|
]
|
@@ -6393,13 +6478,13 @@
|
|
6393
6478
|
"shipping_method": {
|
6394
6479
|
"properties": {
|
6395
6480
|
"amount": {
|
6396
|
-
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
6481
|
+
"description": "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.",
|
6397
6482
|
"type": [
|
6398
6483
|
"integer"
|
6399
6484
|
]
|
6400
6485
|
},
|
6401
6486
|
"currency": {
|
6402
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
6487
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
6403
6488
|
"type": [
|
6404
6489
|
"string"
|
6405
6490
|
]
|
@@ -6456,7 +6541,7 @@
|
|
6456
6541
|
]
|
6457
6542
|
},
|
6458
6543
|
"currency": {
|
6459
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
6544
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
6460
6545
|
"type": [
|
6461
6546
|
"string"
|
6462
6547
|
]
|
@@ -6498,7 +6583,7 @@
|
|
6498
6583
|
"$ref": "#/definitions/package_dimensions"
|
6499
6584
|
},
|
6500
6585
|
"price": {
|
6501
|
-
"description": "The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a
|
6586
|
+
"description": "The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
|
6502
6587
|
"type": [
|
6503
6588
|
"integer"
|
6504
6589
|
]
|
@@ -6555,7 +6640,7 @@
|
|
6555
6640
|
]
|
6556
6641
|
},
|
6557
6642
|
"client_secret": {
|
6558
|
-
"description": "The client secret of the source. Used for client-side
|
6643
|
+
"description": "The client secret of the source. Used for client-side retrieval using a publishable key.",
|
6559
6644
|
"type": [
|
6560
6645
|
"string"
|
6561
6646
|
]
|
@@ -6570,7 +6655,7 @@
|
|
6570
6655
|
]
|
6571
6656
|
},
|
6572
6657
|
"currency": {
|
6573
|
-
"description": "Three-letter [ISO code for the currency](https://
|
6658
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources.",
|
6574
6659
|
"type": [
|
6575
6660
|
"string"
|
6576
6661
|
]
|
@@ -7112,7 +7197,7 @@
|
|
7112
7197
|
]
|
7113
7198
|
},
|
7114
7199
|
"currency": {
|
7115
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
7200
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
7116
7201
|
"type": [
|
7117
7202
|
"string"
|
7118
7203
|
]
|
@@ -7263,7 +7348,7 @@
|
|
7263
7348
|
]
|
7264
7349
|
},
|
7265
7350
|
"currency": {
|
7266
|
-
"description": "Three-letter [ISO code for the currency](https://
|
7351
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
|
7267
7352
|
"type": [
|
7268
7353
|
"string"
|
7269
7354
|
]
|
@@ -7385,7 +7470,7 @@
|
|
7385
7470
|
]
|
7386
7471
|
},
|
7387
7472
|
"currency": {
|
7388
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
7473
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
7389
7474
|
"type": [
|
7390
7475
|
"string"
|
7391
7476
|
]
|
@@ -7524,13 +7609,19 @@
|
|
7524
7609
|
"x-expansionResources": {
|
7525
7610
|
"oneOf": [
|
7526
7611
|
{
|
7527
|
-
"$ref": "#/definitions/
|
7612
|
+
"$ref": "#/definitions/card"
|
7528
7613
|
}
|
7529
7614
|
]
|
7530
7615
|
}
|
7531
7616
|
},
|
7617
|
+
"created": {
|
7618
|
+
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
|
7619
|
+
"type": [
|
7620
|
+
"integer"
|
7621
|
+
]
|
7622
|
+
},
|
7532
7623
|
"currency": {
|
7533
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
7624
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
7534
7625
|
"type": [
|
7535
7626
|
"string"
|
7536
7627
|
]
|
@@ -7561,6 +7652,7 @@
|
|
7561
7652
|
"amount",
|
7562
7653
|
"balance_transaction",
|
7563
7654
|
"card",
|
7655
|
+
"created",
|
7564
7656
|
"currency",
|
7565
7657
|
"id",
|
7566
7658
|
"merchant_data",
|
@@ -7612,7 +7704,13 @@
|
|
7612
7704
|
]
|
7613
7705
|
},
|
7614
7706
|
"currency": {
|
7615
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
7707
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
7708
|
+
"type": [
|
7709
|
+
"string"
|
7710
|
+
]
|
7711
|
+
},
|
7712
|
+
"description": {
|
7713
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
7616
7714
|
"type": [
|
7617
7715
|
"string"
|
7618
7716
|
]
|
@@ -7882,7 +7980,7 @@
|
|
7882
7980
|
]
|
7883
7981
|
},
|
7884
7982
|
"migrated_to": {
|
7885
|
-
"description": "The ID of the [
|
7983
|
+
"description": "The ID of the [Custom account](/docs/connect/custom-accounts) this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.",
|
7886
7984
|
"type": [
|
7887
7985
|
"string"
|
7888
7986
|
],
|
@@ -7978,7 +8076,7 @@
|
|
7978
8076
|
]
|
7979
8077
|
},
|
7980
8078
|
"currency": {
|
7981
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
8079
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
7982
8080
|
"type": [
|
7983
8081
|
"string"
|
7984
8082
|
]
|
@@ -8233,7 +8331,7 @@
|
|
8233
8331
|
]
|
8234
8332
|
},
|
8235
8333
|
"currency": {
|
8236
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
8334
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
8237
8335
|
"type": [
|
8238
8336
|
"string"
|
8239
8337
|
]
|
@@ -8263,9 +8361,6 @@
|
|
8263
8361
|
],
|
8264
8362
|
"x-expansionResources": {
|
8265
8363
|
"oneOf": [
|
8266
|
-
{
|
8267
|
-
"$ref": "#/definitions/legacy_transfer"
|
8268
|
-
},
|
8269
8364
|
{
|
8270
8365
|
"$ref": "#/definitions/transfer"
|
8271
8366
|
}
|
@@ -8378,7 +8473,7 @@
|
|
8378
8473
|
]
|
8379
8474
|
},
|
8380
8475
|
"currency": {
|
8381
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
8476
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
8382
8477
|
"type": [
|
8383
8478
|
"string"
|
8384
8479
|
]
|
@@ -8626,7 +8721,7 @@
|
|
8626
8721
|
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
|
8627
8722
|
"termsOfService": "https://stripe.com/us/terms/",
|
8628
8723
|
"title": "Stripe API",
|
8629
|
-
"version": "2017-
|
8724
|
+
"version": "2017-06-05"
|
8630
8725
|
},
|
8631
8726
|
"paths": {
|
8632
8727
|
"/v1/3d_secure": {
|
@@ -8656,7 +8751,7 @@
|
|
8656
8751
|
]
|
8657
8752
|
},
|
8658
8753
|
"currency": {
|
8659
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
8754
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
8660
8755
|
"title": "currency",
|
8661
8756
|
"type": [
|
8662
8757
|
"string"
|
@@ -8752,7 +8847,7 @@
|
|
8752
8847
|
},
|
8753
8848
|
"/v1/account": {
|
8754
8849
|
"delete": {
|
8755
|
-
"description": "<p>With <a href=\"/docs/connect\">Connect</a>, you may delete
|
8850
|
+
"description": "<p>With <a href=\"/docs/connect\">Connect</a>, you may delete Custom accounts you manage.</p><p>Custom accounts created using test-mode keys can be deleted at any time. Custom accounts created using live-mode keys may only be deleted once all balances are zero.</p><p>If you are looking to close your own account, use the <a href=\"https://dashboard.stripe.com/account/data\">data tab in your account settings</a> instead.</p>",
|
8756
8851
|
"operationId": "AccountDelete",
|
8757
8852
|
"parameters": [
|
8758
8853
|
{
|
@@ -8836,7 +8931,7 @@
|
|
8836
8931
|
}
|
8837
8932
|
},
|
8838
8933
|
"post": {
|
8839
|
-
"description": "<p>Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p><p><strong>You may only update
|
8934
|
+
"description": "<p>Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p><p><strong>You may only update <a href=\"/docs/connect/updating-accounts\">Custom and Express accounts that you manage</a></strong>. To update your own account, you can currently only do so via the <a href=\"https://dashboard.stripe.com/account\">dashboard</a>.</p>",
|
8840
8935
|
"operationId": "AccountUpdate",
|
8841
8936
|
"parameters": [
|
8842
8937
|
{
|
@@ -8875,7 +8970,7 @@
|
|
8875
8970
|
]
|
8876
8971
|
},
|
8877
8972
|
"debit_negative_balances": {
|
8878
|
-
"description": "A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [
|
8973
|
+
"description": "A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [Connect account bank transfer guide](/docs/connect/account-balances) for more information.",
|
8879
8974
|
"title": "debit_negative_balances",
|
8880
8975
|
"type": [
|
8881
8976
|
"boolean"
|
@@ -8889,14 +8984,14 @@
|
|
8889
8984
|
]
|
8890
8985
|
},
|
8891
8986
|
"default_currency": {
|
8892
|
-
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://
|
8987
|
+
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).",
|
8893
8988
|
"title": "default_currency",
|
8894
8989
|
"type": [
|
8895
8990
|
"string"
|
8896
8991
|
]
|
8897
8992
|
},
|
8898
8993
|
"email": {
|
8899
|
-
"description": "Email address of the account holder. For
|
8994
|
+
"description": "Email address of the account holder. For Standard accounts, this is used to email them asking them to claim their Stripe account. For Custom accounts, this is only to make the account easier to identify to you: Stripe will not email the account holder.",
|
8900
8995
|
"title": "email",
|
8901
8996
|
"type": [
|
8902
8997
|
"string"
|
@@ -8938,7 +9033,7 @@
|
|
8938
9033
|
]
|
8939
9034
|
},
|
8940
9035
|
"payout_schedule": {
|
8941
|
-
"description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [
|
9036
|
+
"description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [Connect account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information.",
|
8942
9037
|
"title": "payout_schedule",
|
8943
9038
|
"type": [
|
8944
9039
|
"object"
|
@@ -8987,7 +9082,7 @@
|
|
8987
9082
|
]
|
8988
9083
|
},
|
8989
9084
|
"tos_acceptance": {
|
8990
|
-
"description": "Details on who accepted the Stripe terms of service, and when they accepted it. See our [updating
|
9085
|
+
"description": "Details on who accepted the Stripe terms of service, and when they accepted it. See our [updating accounts guide](/docs/connect/updating-accounts#tos-acceptance) for more information.",
|
8991
9086
|
"title": "tos_acceptance",
|
8992
9087
|
"type": [
|
8993
9088
|
"object"
|
@@ -9169,7 +9264,7 @@
|
|
9169
9264
|
}
|
9170
9265
|
},
|
9171
9266
|
"post": {
|
9172
|
-
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/
|
9267
|
+
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/custom-accounts\">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p><p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>",
|
9173
9268
|
"operationId": "UpdateAccountBankAccount",
|
9174
9269
|
"parameters": [
|
9175
9270
|
{
|
@@ -9246,7 +9341,7 @@
|
|
9246
9341
|
"type": "string"
|
9247
9342
|
},
|
9248
9343
|
{
|
9249
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
9344
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
9250
9345
|
"in": "query",
|
9251
9346
|
"name": "limit",
|
9252
9347
|
"required": false,
|
@@ -9486,7 +9581,7 @@
|
|
9486
9581
|
}
|
9487
9582
|
},
|
9488
9583
|
"post": {
|
9489
|
-
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/
|
9584
|
+
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/custom-accounts\">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p><p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>",
|
9490
9585
|
"operationId": "UpdateAccountBankAccount",
|
9491
9586
|
"parameters": [
|
9492
9587
|
{
|
@@ -9552,7 +9647,7 @@
|
|
9552
9647
|
},
|
9553
9648
|
"/v1/account/login_links": {
|
9554
9649
|
"post": {
|
9555
|
-
"description": "",
|
9650
|
+
"description": "<p>Creates a single-use login link for an Express account to access their Stripe dashboard.</p><p><strong>You may only create login links for <a href=\"/docs/connect/express-accounts\">Express accounts</a> connected to your platform</strong>.</p>",
|
9556
9651
|
"operationId": "LoginLinkCreate",
|
9557
9652
|
"parameters": [
|
9558
9653
|
{
|
@@ -9572,29 +9667,15 @@
|
|
9572
9667
|
"expand": {
|
9573
9668
|
"description": "Specifies which fields in the response should be expanded.",
|
9574
9669
|
"items": {
|
9575
|
-
"type": [
|
9576
|
-
"string"
|
9577
|
-
]
|
9578
|
-
},
|
9579
|
-
"title": "expand",
|
9580
|
-
"type": [
|
9581
|
-
"array",
|
9582
|
-
"string"
|
9583
|
-
]
|
9584
|
-
},
|
9585
|
-
"id": {
|
9586
|
-
"description": "",
|
9587
|
-
"title": "id",
|
9670
|
+
"type": [
|
9671
|
+
"string"
|
9672
|
+
]
|
9673
|
+
},
|
9674
|
+
"title": "expand",
|
9588
9675
|
"type": [
|
9676
|
+
"array",
|
9589
9677
|
"string"
|
9590
9678
|
]
|
9591
|
-
},
|
9592
|
-
"percent_off": {
|
9593
|
-
"description": "",
|
9594
|
-
"title": "percent_off",
|
9595
|
-
"type": [
|
9596
|
-
"integer"
|
9597
|
-
]
|
9598
9679
|
}
|
9599
9680
|
},
|
9600
9681
|
"required": [
|
@@ -9632,7 +9713,7 @@
|
|
9632
9713
|
"type": "string"
|
9633
9714
|
},
|
9634
9715
|
{
|
9635
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
9716
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
9636
9717
|
"in": "query",
|
9637
9718
|
"name": "limit",
|
9638
9719
|
"required": false,
|
@@ -9727,7 +9808,7 @@
|
|
9727
9808
|
"description": "Body parameters for the request.",
|
9728
9809
|
"in": "body",
|
9729
9810
|
"name": "payload",
|
9730
|
-
"required":
|
9811
|
+
"required": true,
|
9731
9812
|
"schema": {
|
9732
9813
|
"properties": {
|
9733
9814
|
"business_logo": {
|
@@ -9766,7 +9847,7 @@
|
|
9766
9847
|
]
|
9767
9848
|
},
|
9768
9849
|
"debit_negative_balances": {
|
9769
|
-
"description": "A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [
|
9850
|
+
"description": "A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [Connect account bank transfer guide](/docs/connect/account-balances) for more information.",
|
9770
9851
|
"title": "debit_negative_balances",
|
9771
9852
|
"type": [
|
9772
9853
|
"boolean"
|
@@ -9780,14 +9861,14 @@
|
|
9780
9861
|
]
|
9781
9862
|
},
|
9782
9863
|
"default_currency": {
|
9783
|
-
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://
|
9864
|
+
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).",
|
9784
9865
|
"title": "default_currency",
|
9785
9866
|
"type": [
|
9786
9867
|
"string"
|
9787
9868
|
]
|
9788
9869
|
},
|
9789
9870
|
"email": {
|
9790
|
-
"description": "Email address of the account holder. For
|
9871
|
+
"description": "Email address of the account holder. For Standard accounts, this is used to email them asking them to claim their Stripe account. For Custom accounts, this is only to make the account easier to identify to you: Stripe will not email the account holder.",
|
9791
9872
|
"title": "email",
|
9792
9873
|
"type": [
|
9793
9874
|
"string"
|
@@ -9821,13 +9902,6 @@
|
|
9821
9902
|
"object"
|
9822
9903
|
]
|
9823
9904
|
},
|
9824
|
-
"managed": {
|
9825
|
-
"description": "",
|
9826
|
-
"title": "managed",
|
9827
|
-
"type": [
|
9828
|
-
"boolean"
|
9829
|
-
]
|
9830
|
-
},
|
9831
9905
|
"metadata": {
|
9832
9906
|
"description": "A set of key/value pairs that you can attach to an account object. It can be useful for storing additional information about the account in a structured format.",
|
9833
9907
|
"title": "metadata",
|
@@ -9836,7 +9910,7 @@
|
|
9836
9910
|
]
|
9837
9911
|
},
|
9838
9912
|
"payout_schedule": {
|
9839
|
-
"description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [
|
9913
|
+
"description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [Connect account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information.",
|
9840
9914
|
"title": "payout_schedule",
|
9841
9915
|
"type": [
|
9842
9916
|
"object"
|
@@ -9885,13 +9959,23 @@
|
|
9885
9959
|
]
|
9886
9960
|
},
|
9887
9961
|
"tos_acceptance": {
|
9888
|
-
"description": "Details on who accepted the Stripe terms of service, and when they accepted it. See our [updating
|
9962
|
+
"description": "Details on who accepted the Stripe terms of service, and when they accepted it. See our [updating accounts guide](/docs/connect/updating-accounts#tos-acceptance) for more information.",
|
9889
9963
|
"title": "tos_acceptance",
|
9890
9964
|
"type": [
|
9891
9965
|
"object"
|
9892
9966
|
]
|
9967
|
+
},
|
9968
|
+
"type": {
|
9969
|
+
"description": "",
|
9970
|
+
"title": "type",
|
9971
|
+
"type": [
|
9972
|
+
"string"
|
9973
|
+
]
|
9893
9974
|
}
|
9894
|
-
}
|
9975
|
+
},
|
9976
|
+
"required": [
|
9977
|
+
"type"
|
9978
|
+
]
|
9895
9979
|
}
|
9896
9980
|
}
|
9897
9981
|
],
|
@@ -9913,7 +9997,7 @@
|
|
9913
9997
|
},
|
9914
9998
|
"/v1/accounts/{account}": {
|
9915
9999
|
"delete": {
|
9916
|
-
"description": "<p>With <a href=\"/docs/connect\">Connect</a>, you may delete
|
10000
|
+
"description": "<p>With <a href=\"/docs/connect\">Connect</a>, you may delete Custom accounts you manage.</p><p>Custom accounts created using test-mode keys can be deleted at any time. Custom accounts created using live-mode keys may only be deleted once all balances are zero.</p><p>If you are looking to close your own account, use the <a href=\"https://dashboard.stripe.com/account/data\">data tab in your account settings</a> instead.</p>",
|
9917
10001
|
"operationId": "AccountDelete",
|
9918
10002
|
"parameters": [
|
9919
10003
|
{
|
@@ -9997,7 +10081,7 @@
|
|
9997
10081
|
}
|
9998
10082
|
},
|
9999
10083
|
"post": {
|
10000
|
-
"description": "<p>Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p><p><strong>You may only update
|
10084
|
+
"description": "<p>Updates an account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p><p><strong>You may only update <a href=\"/docs/connect/updating-accounts\">Custom and Express accounts that you manage</a></strong>. To update your own account, you can currently only do so via the <a href=\"https://dashboard.stripe.com/account\">dashboard</a>.</p>",
|
10001
10085
|
"operationId": "AccountUpdate",
|
10002
10086
|
"parameters": [
|
10003
10087
|
{
|
@@ -10036,7 +10120,7 @@
|
|
10036
10120
|
]
|
10037
10121
|
},
|
10038
10122
|
"debit_negative_balances": {
|
10039
|
-
"description": "A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [
|
10123
|
+
"description": "A boolean for whether or not Stripe should try to reclaim negative balances from the account holder's bank account. See our [Connect account bank transfer guide](/docs/connect/account-balances) for more information.",
|
10040
10124
|
"title": "debit_negative_balances",
|
10041
10125
|
"type": [
|
10042
10126
|
"boolean"
|
@@ -10050,14 +10134,14 @@
|
|
10050
10134
|
]
|
10051
10135
|
},
|
10052
10136
|
"default_currency": {
|
10053
|
-
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://
|
10137
|
+
"description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).",
|
10054
10138
|
"title": "default_currency",
|
10055
10139
|
"type": [
|
10056
10140
|
"string"
|
10057
10141
|
]
|
10058
10142
|
},
|
10059
10143
|
"email": {
|
10060
|
-
"description": "Email address of the account holder. For
|
10144
|
+
"description": "Email address of the account holder. For Standard accounts, this is used to email them asking them to claim their Stripe account. For Custom accounts, this is only to make the account easier to identify to you: Stripe will not email the account holder.",
|
10061
10145
|
"title": "email",
|
10062
10146
|
"type": [
|
10063
10147
|
"string"
|
@@ -10099,7 +10183,7 @@
|
|
10099
10183
|
]
|
10100
10184
|
},
|
10101
10185
|
"payout_schedule": {
|
10102
|
-
"description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [
|
10186
|
+
"description": "Details on when this account will make funds from charges available, and when they will be paid out to the account holder's bank account. See our [Connect account bank transfer guide](/docs/connect/bank-transfers#payout-information) for more information.",
|
10103
10187
|
"title": "payout_schedule",
|
10104
10188
|
"type": [
|
10105
10189
|
"object"
|
@@ -10148,7 +10232,7 @@
|
|
10148
10232
|
]
|
10149
10233
|
},
|
10150
10234
|
"tos_acceptance": {
|
10151
|
-
"description": "Details on who accepted the Stripe terms of service, and when they accepted it. See our [updating
|
10235
|
+
"description": "Details on who accepted the Stripe terms of service, and when they accepted it. See our [updating accounts guide](/docs/connect/updating-accounts#tos-acceptance) for more information.",
|
10152
10236
|
"title": "tos_acceptance",
|
10153
10237
|
"type": [
|
10154
10238
|
"object"
|
@@ -10330,7 +10414,7 @@
|
|
10330
10414
|
}
|
10331
10415
|
},
|
10332
10416
|
"post": {
|
10333
|
-
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/
|
10417
|
+
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/custom-accounts\">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p><p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>",
|
10334
10418
|
"operationId": "UpdateAccountBankAccount",
|
10335
10419
|
"parameters": [
|
10336
10420
|
{
|
@@ -10407,7 +10491,7 @@
|
|
10407
10491
|
"type": "string"
|
10408
10492
|
},
|
10409
10493
|
{
|
10410
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
10494
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
10411
10495
|
"in": "query",
|
10412
10496
|
"name": "limit",
|
10413
10497
|
"required": false,
|
@@ -10647,7 +10731,7 @@
|
|
10647
10731
|
}
|
10648
10732
|
},
|
10649
10733
|
"post": {
|
10650
|
-
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/
|
10734
|
+
"description": "<p>Updates the metadata of a bank account belonging to a <a href=\"/docs/connect/custom-accounts\">Custom account</a>, and optionally sets it as the default for its currency. Other bank account details are not editable by design.</p><p>You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.</p>",
|
10651
10735
|
"operationId": "UpdateAccountBankAccount",
|
10652
10736
|
"parameters": [
|
10653
10737
|
{
|
@@ -10713,7 +10797,7 @@
|
|
10713
10797
|
},
|
10714
10798
|
"/v1/accounts/{account}/login_links": {
|
10715
10799
|
"post": {
|
10716
|
-
"description": "",
|
10800
|
+
"description": "<p>Creates a single-use login link for an Express account to access their Stripe dashboard.</p><p><strong>You may only create login links for <a href=\"/docs/connect/express-accounts\">Express accounts</a> connected to your platform</strong>.</p>",
|
10717
10801
|
"operationId": "LoginLinkCreate",
|
10718
10802
|
"parameters": [
|
10719
10803
|
{
|
@@ -10742,20 +10826,6 @@
|
|
10742
10826
|
"array",
|
10743
10827
|
"string"
|
10744
10828
|
]
|
10745
|
-
},
|
10746
|
-
"id": {
|
10747
|
-
"description": "",
|
10748
|
-
"title": "id",
|
10749
|
-
"type": [
|
10750
|
-
"string"
|
10751
|
-
]
|
10752
|
-
},
|
10753
|
-
"percent_off": {
|
10754
|
-
"description": "",
|
10755
|
-
"title": "percent_off",
|
10756
|
-
"type": [
|
10757
|
-
"integer"
|
10758
|
-
]
|
10759
10829
|
}
|
10760
10830
|
}
|
10761
10831
|
}
|
@@ -10779,7 +10849,7 @@
|
|
10779
10849
|
},
|
10780
10850
|
"/v1/accounts/{account}/reject": {
|
10781
10851
|
"post": {
|
10782
|
-
"description": "<p>With <a href=\"/docs/connect\">Connect</a>, you may flag
|
10852
|
+
"description": "<p>With <a href=\"/docs/connect\">Connect</a>, you may flag accounts as suspicious.</p><p>Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.</p>",
|
10783
10853
|
"operationId": "AccountReject",
|
10784
10854
|
"parameters": [
|
10785
10855
|
{
|
@@ -10852,7 +10922,7 @@
|
|
10852
10922
|
"type": "string"
|
10853
10923
|
},
|
10854
10924
|
{
|
10855
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
10925
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
10856
10926
|
"in": "query",
|
10857
10927
|
"name": "limit",
|
10858
10928
|
"required": false,
|
@@ -11100,7 +11170,7 @@
|
|
11100
11170
|
"type": "string"
|
11101
11171
|
},
|
11102
11172
|
{
|
11103
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
11173
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
11104
11174
|
"in": "query",
|
11105
11175
|
"name": "limit",
|
11106
11176
|
"required": false,
|
@@ -11410,7 +11480,7 @@
|
|
11410
11480
|
"type": "string"
|
11411
11481
|
},
|
11412
11482
|
{
|
11413
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
11483
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
11414
11484
|
"in": "query",
|
11415
11485
|
"name": "limit",
|
11416
11486
|
"required": false,
|
@@ -11616,7 +11686,7 @@
|
|
11616
11686
|
"type": "string"
|
11617
11687
|
},
|
11618
11688
|
{
|
11619
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
11689
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
11620
11690
|
"in": "query",
|
11621
11691
|
"name": "limit",
|
11622
11692
|
"required": false,
|
@@ -11786,7 +11856,7 @@
|
|
11786
11856
|
"/v1/bitcoin/payments": {
|
11787
11857
|
"get": {
|
11788
11858
|
"description": "",
|
11789
|
-
"operationId": "
|
11859
|
+
"operationId": "AllBitcoinPayments",
|
11790
11860
|
"parameters": [
|
11791
11861
|
{
|
11792
11862
|
"description": "Specifies which fields in the response should be expanded.",
|
@@ -11796,7 +11866,7 @@
|
|
11796
11866
|
"type": "string"
|
11797
11867
|
},
|
11798
11868
|
{
|
11799
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
11869
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
11800
11870
|
"in": "query",
|
11801
11871
|
"name": "limit",
|
11802
11872
|
"required": false,
|
@@ -12089,6 +12159,13 @@
|
|
12089
12159
|
"string"
|
12090
12160
|
]
|
12091
12161
|
},
|
12162
|
+
"statement_address": {
|
12163
|
+
"description": "",
|
12164
|
+
"title": "statement_address",
|
12165
|
+
"type": [
|
12166
|
+
"object"
|
12167
|
+
]
|
12168
|
+
},
|
12092
12169
|
"statement_descriptor": {
|
12093
12170
|
"description": "",
|
12094
12171
|
"title": "statement_descriptor",
|
@@ -12266,7 +12343,7 @@
|
|
12266
12343
|
"/v1/bitcoin/payments/{id}": {
|
12267
12344
|
"get": {
|
12268
12345
|
"description": "",
|
12269
|
-
"operationId": "
|
12346
|
+
"operationId": "RetrieveBitcoinPayment",
|
12270
12347
|
"parameters": [
|
12271
12348
|
{
|
12272
12349
|
"description": "Specifies which fields in the response should be expanded.",
|
@@ -12312,7 +12389,7 @@
|
|
12312
12389
|
"type": "string"
|
12313
12390
|
},
|
12314
12391
|
{
|
12315
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
12392
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
12316
12393
|
"in": "query",
|
12317
12394
|
"name": "limit",
|
12318
12395
|
"required": false,
|
@@ -12439,7 +12516,7 @@
|
|
12439
12516
|
]
|
12440
12517
|
},
|
12441
12518
|
"currency": {
|
12442
|
-
"description": "Three-letter [ISO code for the currency](https://
|
12519
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) to which the bitcoin will be converted. You will be paid out in this currency. Only USD is currently supported.",
|
12443
12520
|
"title": "currency",
|
12444
12521
|
"type": [
|
12445
12522
|
"string"
|
@@ -12746,7 +12823,7 @@
|
|
12746
12823
|
"type": "string"
|
12747
12824
|
},
|
12748
12825
|
{
|
12749
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
12826
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
12750
12827
|
"in": "query",
|
12751
12828
|
"name": "limit",
|
12752
12829
|
"required": false,
|
@@ -12859,7 +12936,7 @@
|
|
12859
12936
|
"type": "string"
|
12860
12937
|
},
|
12861
12938
|
{
|
12862
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
12939
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
12863
12940
|
"in": "query",
|
12864
12941
|
"name": "limit",
|
12865
12942
|
"required": false,
|
@@ -13008,7 +13085,7 @@
|
|
13008
13085
|
"type": "string"
|
13009
13086
|
},
|
13010
13087
|
{
|
13011
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
13088
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
13012
13089
|
"in": "query",
|
13013
13090
|
"name": "limit",
|
13014
13091
|
"required": false,
|
@@ -13648,6 +13725,13 @@
|
|
13648
13725
|
"type": [
|
13649
13726
|
"object"
|
13650
13727
|
]
|
13728
|
+
},
|
13729
|
+
"submit": {
|
13730
|
+
"description": "Whether or not to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).",
|
13731
|
+
"title": "submit",
|
13732
|
+
"type": [
|
13733
|
+
"boolean"
|
13734
|
+
]
|
13651
13735
|
}
|
13652
13736
|
}
|
13653
13737
|
}
|
@@ -13842,7 +13926,7 @@
|
|
13842
13926
|
"type": "string"
|
13843
13927
|
},
|
13844
13928
|
{
|
13845
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
13929
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
13846
13930
|
"in": "query",
|
13847
13931
|
"name": "limit",
|
13848
13932
|
"required": false,
|
@@ -14140,7 +14224,7 @@
|
|
14140
14224
|
"type": "string"
|
14141
14225
|
},
|
14142
14226
|
{
|
14143
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
14227
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
14144
14228
|
"in": "query",
|
14145
14229
|
"name": "limit",
|
14146
14230
|
"required": false,
|
@@ -14277,7 +14361,7 @@
|
|
14277
14361
|
"type": "string"
|
14278
14362
|
},
|
14279
14363
|
{
|
14280
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
14364
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
14281
14365
|
"in": "query",
|
14282
14366
|
"name": "limit",
|
14283
14367
|
"required": false,
|
@@ -14390,7 +14474,7 @@
|
|
14390
14474
|
]
|
14391
14475
|
},
|
14392
14476
|
"currency": {
|
14393
|
-
"description": "Three-letter [ISO code for the currency](https://
|
14477
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).",
|
14394
14478
|
"title": "currency",
|
14395
14479
|
"type": [
|
14396
14480
|
"string"
|
@@ -14637,7 +14721,7 @@
|
|
14637
14721
|
"type": "string"
|
14638
14722
|
},
|
14639
14723
|
{
|
14640
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
14724
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
14641
14725
|
"in": "query",
|
14642
14726
|
"name": "limit",
|
14643
14727
|
"required": false,
|
@@ -14763,6 +14847,13 @@
|
|
14763
14847
|
"string"
|
14764
14848
|
]
|
14765
14849
|
},
|
14850
|
+
"default_source": {
|
14851
|
+
"description": "",
|
14852
|
+
"title": "default_source",
|
14853
|
+
"type": [
|
14854
|
+
"string"
|
14855
|
+
]
|
14856
|
+
},
|
14766
14857
|
"description": {
|
14767
14858
|
"description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
|
14768
14859
|
"title": "description",
|
@@ -14805,7 +14896,7 @@
|
|
14805
14896
|
]
|
14806
14897
|
},
|
14807
14898
|
"source": {
|
14808
|
-
"description": "The source can either be a
|
14899
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](/docs/elements), or a dictionary containing a user's credit card details (with the options shown below).",
|
14809
14900
|
"title": "source",
|
14810
14901
|
"type": [
|
14811
14902
|
"object",
|
@@ -14956,6 +15047,13 @@
|
|
14956
15047
|
"string"
|
14957
15048
|
]
|
14958
15049
|
},
|
15050
|
+
"default_source": {
|
15051
|
+
"description": "",
|
15052
|
+
"title": "default_source",
|
15053
|
+
"type": [
|
15054
|
+
"string"
|
15055
|
+
]
|
15056
|
+
},
|
14959
15057
|
"description": {
|
14960
15058
|
"description": "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
|
14961
15059
|
"title": "description",
|
@@ -14998,7 +15096,7 @@
|
|
14998
15096
|
]
|
14999
15097
|
},
|
15000
15098
|
"source": {
|
15001
|
-
"description": "The source can either be a
|
15099
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](/docs/elements), or a dictionary containing a user's credit card details (with the options shown below).",
|
15002
15100
|
"title": "source",
|
15003
15101
|
"type": [
|
15004
15102
|
"object",
|
@@ -15038,7 +15136,7 @@
|
|
15038
15136
|
"type": "string"
|
15039
15137
|
},
|
15040
15138
|
{
|
15041
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
15139
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
15042
15140
|
"in": "query",
|
15043
15141
|
"name": "limit",
|
15044
15142
|
"required": false,
|
@@ -15291,7 +15389,7 @@
|
|
15291
15389
|
"type": "string"
|
15292
15390
|
},
|
15293
15391
|
{
|
15294
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
15392
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
15295
15393
|
"in": "query",
|
15296
15394
|
"name": "limit",
|
15297
15395
|
"required": false,
|
@@ -15744,7 +15842,7 @@
|
|
15744
15842
|
"type": "string"
|
15745
15843
|
},
|
15746
15844
|
{
|
15747
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
15845
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
15748
15846
|
"in": "query",
|
15749
15847
|
"name": "limit",
|
15750
15848
|
"required": false,
|
@@ -16196,7 +16294,7 @@
|
|
16196
16294
|
"type": "string"
|
16197
16295
|
},
|
16198
16296
|
{
|
16199
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
16297
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
16200
16298
|
"in": "query",
|
16201
16299
|
"name": "limit",
|
16202
16300
|
"required": false,
|
@@ -16649,7 +16747,7 @@
|
|
16649
16747
|
"type": "string"
|
16650
16748
|
},
|
16651
16749
|
{
|
16652
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
16750
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
16653
16751
|
"in": "query",
|
16654
16752
|
"name": "limit",
|
16655
16753
|
"required": false,
|
@@ -16815,7 +16913,7 @@
|
|
16815
16913
|
]
|
16816
16914
|
},
|
16817
16915
|
"source": {
|
16818
|
-
"description": "The source can either be a
|
16916
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.",
|
16819
16917
|
"title": "source",
|
16820
16918
|
"type": [
|
16821
16919
|
"object",
|
@@ -17023,7 +17121,7 @@
|
|
17023
17121
|
]
|
17024
17122
|
},
|
17025
17123
|
"source": {
|
17026
|
-
"description": "The source can either be a
|
17124
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.",
|
17027
17125
|
"title": "source",
|
17028
17126
|
"type": [
|
17029
17127
|
"object",
|
@@ -17157,7 +17255,7 @@
|
|
17157
17255
|
"type": "string"
|
17158
17256
|
},
|
17159
17257
|
{
|
17160
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
17258
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
17161
17259
|
"in": "query",
|
17162
17260
|
"name": "limit",
|
17163
17261
|
"required": false,
|
@@ -17331,6 +17429,13 @@
|
|
17331
17429
|
"type": [
|
17332
17430
|
"object"
|
17333
17431
|
]
|
17432
|
+
},
|
17433
|
+
"submit": {
|
17434
|
+
"description": "Whether or not to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).",
|
17435
|
+
"title": "submit",
|
17436
|
+
"type": [
|
17437
|
+
"boolean"
|
17438
|
+
]
|
17334
17439
|
}
|
17335
17440
|
}
|
17336
17441
|
}
|
@@ -17404,6 +17509,113 @@
|
|
17404
17509
|
}
|
17405
17510
|
}
|
17406
17511
|
},
|
17512
|
+
"/v1/ephemeral_keys": {
|
17513
|
+
"post": {
|
17514
|
+
"description": "<p>Creates a short-lived API key for a given resource.</p>",
|
17515
|
+
"operationId": "CreateEphemeralKey",
|
17516
|
+
"parameters": [
|
17517
|
+
{
|
17518
|
+
"description": "Body parameters for the request.",
|
17519
|
+
"in": "body",
|
17520
|
+
"name": "payload",
|
17521
|
+
"required": true,
|
17522
|
+
"schema": {
|
17523
|
+
"properties": {
|
17524
|
+
"customer": {
|
17525
|
+
"description": "The ID of the Customer you'd like to modify using the resulting ephemeral key.",
|
17526
|
+
"title": "customer",
|
17527
|
+
"type": [
|
17528
|
+
"string"
|
17529
|
+
]
|
17530
|
+
},
|
17531
|
+
"expand": {
|
17532
|
+
"description": "Specifies which fields in the response should be expanded.",
|
17533
|
+
"items": {
|
17534
|
+
"type": [
|
17535
|
+
"string"
|
17536
|
+
]
|
17537
|
+
},
|
17538
|
+
"title": "expand",
|
17539
|
+
"type": [
|
17540
|
+
"array",
|
17541
|
+
"string"
|
17542
|
+
]
|
17543
|
+
}
|
17544
|
+
},
|
17545
|
+
"required": [
|
17546
|
+
"customer"
|
17547
|
+
]
|
17548
|
+
}
|
17549
|
+
}
|
17550
|
+
],
|
17551
|
+
"responses": {
|
17552
|
+
"200": {
|
17553
|
+
"description": "Successful response.",
|
17554
|
+
"schema": {
|
17555
|
+
"$ref": "#/definitions/ephemeral_key_with_secret"
|
17556
|
+
}
|
17557
|
+
},
|
17558
|
+
"default": {
|
17559
|
+
"description": "Error response.",
|
17560
|
+
"schema": {
|
17561
|
+
"$ref": "#/definitions/error"
|
17562
|
+
}
|
17563
|
+
}
|
17564
|
+
}
|
17565
|
+
}
|
17566
|
+
},
|
17567
|
+
"/v1/ephemeral_keys/{key}": {
|
17568
|
+
"delete": {
|
17569
|
+
"description": "<p>Invalidates a short-lived API key for a given resource.</p>",
|
17570
|
+
"operationId": "DeleteEphemeralKey",
|
17571
|
+
"parameters": [
|
17572
|
+
{
|
17573
|
+
"description": "The ID of the key you'd like to invalidate.",
|
17574
|
+
"in": "path",
|
17575
|
+
"name": "key",
|
17576
|
+
"required": true,
|
17577
|
+
"type": "string"
|
17578
|
+
},
|
17579
|
+
{
|
17580
|
+
"description": "Body parameters for the request.",
|
17581
|
+
"in": "body",
|
17582
|
+
"name": "payload",
|
17583
|
+
"required": false,
|
17584
|
+
"schema": {
|
17585
|
+
"properties": {
|
17586
|
+
"expand": {
|
17587
|
+
"description": "Specifies which fields in the response should be expanded.",
|
17588
|
+
"items": {
|
17589
|
+
"type": [
|
17590
|
+
"string"
|
17591
|
+
]
|
17592
|
+
},
|
17593
|
+
"title": "expand",
|
17594
|
+
"type": [
|
17595
|
+
"array",
|
17596
|
+
"string"
|
17597
|
+
]
|
17598
|
+
}
|
17599
|
+
}
|
17600
|
+
}
|
17601
|
+
}
|
17602
|
+
],
|
17603
|
+
"responses": {
|
17604
|
+
"200": {
|
17605
|
+
"description": "Successful response.",
|
17606
|
+
"schema": {
|
17607
|
+
"$ref": "#/definitions/ephemeral_key"
|
17608
|
+
}
|
17609
|
+
},
|
17610
|
+
"default": {
|
17611
|
+
"description": "Error response.",
|
17612
|
+
"schema": {
|
17613
|
+
"$ref": "#/definitions/error"
|
17614
|
+
}
|
17615
|
+
}
|
17616
|
+
}
|
17617
|
+
}
|
17618
|
+
},
|
17407
17619
|
"/v1/events": {
|
17408
17620
|
"get": {
|
17409
17621
|
"description": "<p>List events, going back up to 30 days.</p>",
|
@@ -17417,7 +17629,7 @@
|
|
17417
17629
|
"type": "string"
|
17418
17630
|
},
|
17419
17631
|
{
|
17420
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
17632
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
17421
17633
|
"in": "query",
|
17422
17634
|
"name": "limit",
|
17423
17635
|
"required": false,
|
@@ -17456,7 +17668,7 @@
|
|
17456
17668
|
"in": "query",
|
17457
17669
|
"name": "created",
|
17458
17670
|
"required": false,
|
17459
|
-
"type": "
|
17671
|
+
"type": "string"
|
17460
17672
|
}
|
17461
17673
|
],
|
17462
17674
|
"responses": {
|
@@ -17627,7 +17839,7 @@
|
|
17627
17839
|
"type": "string"
|
17628
17840
|
},
|
17629
17841
|
{
|
17630
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
17842
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
17631
17843
|
"in": "query",
|
17632
17844
|
"name": "limit",
|
17633
17845
|
"required": false,
|
@@ -17747,7 +17959,7 @@
|
|
17747
17959
|
]
|
17748
17960
|
},
|
17749
17961
|
"currency": {
|
17750
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
17962
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
17751
17963
|
"title": "currency",
|
17752
17964
|
"type": [
|
17753
17965
|
"string"
|
@@ -18003,7 +18215,7 @@
|
|
18003
18215
|
"type": "string"
|
18004
18216
|
},
|
18005
18217
|
{
|
18006
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
18218
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
18007
18219
|
"in": "query",
|
18008
18220
|
"name": "limit",
|
18009
18221
|
"required": false,
|
@@ -18468,7 +18680,7 @@
|
|
18468
18680
|
"type": "string"
|
18469
18681
|
},
|
18470
18682
|
{
|
18471
|
-
"description": "The
|
18683
|
+
"description": "The ID of the invoice containing the lines to be retrieved. Use a value of **upcoming** to retrieve the upcoming invoice.",
|
18472
18684
|
"in": "path",
|
18473
18685
|
"name": "invoice",
|
18474
18686
|
"required": true,
|
@@ -18641,6 +18853,13 @@
|
|
18641
18853
|
"array",
|
18642
18854
|
"string"
|
18643
18855
|
]
|
18856
|
+
},
|
18857
|
+
"source": {
|
18858
|
+
"description": "A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.",
|
18859
|
+
"title": "source",
|
18860
|
+
"type": [
|
18861
|
+
"string"
|
18862
|
+
]
|
18644
18863
|
}
|
18645
18864
|
}
|
18646
18865
|
}
|
@@ -18689,7 +18908,7 @@
|
|
18689
18908
|
"type": "integer"
|
18690
18909
|
},
|
18691
18910
|
{
|
18692
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
18911
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
18693
18912
|
"in": "query",
|
18694
18913
|
"name": "limit",
|
18695
18914
|
"required": false,
|
@@ -18826,7 +19045,7 @@
|
|
18826
19045
|
"type": "string"
|
18827
19046
|
},
|
18828
19047
|
{
|
18829
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
19048
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
18830
19049
|
"in": "query",
|
18831
19050
|
"name": "limit",
|
18832
19051
|
"required": false,
|
@@ -18974,7 +19193,7 @@
|
|
18974
19193
|
]
|
18975
19194
|
},
|
18976
19195
|
"currency": {
|
18977
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
19196
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
18978
19197
|
"title": "currency",
|
18979
19198
|
"type": [
|
18980
19199
|
"string"
|
@@ -19240,7 +19459,7 @@
|
|
19240
19459
|
]
|
19241
19460
|
},
|
19242
19461
|
"source": {
|
19243
|
-
"description": "The source can either be a
|
19462
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). If no customer was attached to the order at creation, either `source` or `customer is required. Otherwise, the specified source will be charged intead of the customer attached to the order.",
|
19244
19463
|
"title": "source",
|
19245
19464
|
"type": [
|
19246
19465
|
"object",
|
@@ -19339,7 +19558,7 @@
|
|
19339
19558
|
"type": "string"
|
19340
19559
|
},
|
19341
19560
|
{
|
19342
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
19561
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
19343
19562
|
"in": "query",
|
19344
19563
|
"name": "limit",
|
19345
19564
|
"required": false,
|
@@ -19639,6 +19858,13 @@
|
|
19639
19858
|
"string"
|
19640
19859
|
]
|
19641
19860
|
},
|
19861
|
+
"statement_address": {
|
19862
|
+
"description": "",
|
19863
|
+
"title": "statement_address",
|
19864
|
+
"type": [
|
19865
|
+
"object"
|
19866
|
+
]
|
19867
|
+
},
|
19642
19868
|
"statement_descriptor": {
|
19643
19869
|
"description": "",
|
19644
19870
|
"title": "statement_descriptor",
|
@@ -19754,7 +19980,7 @@
|
|
19754
19980
|
"type": "string"
|
19755
19981
|
},
|
19756
19982
|
{
|
19757
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
19983
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
19758
19984
|
"in": "query",
|
19759
19985
|
"name": "limit",
|
19760
19986
|
"required": false,
|
@@ -19779,14 +20005,14 @@
|
|
19779
20005
|
"in": "query",
|
19780
20006
|
"name": "arrival_date",
|
19781
20007
|
"required": false,
|
19782
|
-
"type": "
|
20008
|
+
"type": "string"
|
19783
20009
|
},
|
19784
20010
|
{
|
19785
20011
|
"description": "",
|
19786
20012
|
"in": "query",
|
19787
20013
|
"name": "created",
|
19788
20014
|
"required": false,
|
19789
|
-
"type": "
|
20015
|
+
"type": "string"
|
19790
20016
|
},
|
19791
20017
|
{
|
19792
20018
|
"description": "The ID of an external account - only return payouts sent to this external account.",
|
@@ -19796,7 +20022,7 @@
|
|
19796
20022
|
"type": "string"
|
19797
20023
|
},
|
19798
20024
|
{
|
19799
|
-
"description": "Only return payouts that have the given status: `pending`, `paid`, `failed`,
|
20025
|
+
"description": "Only return payouts that have the given status: `pending`, `paid`, `failed`, or `canceled`.",
|
19800
20026
|
"in": "query",
|
19801
20027
|
"name": "status",
|
19802
20028
|
"required": false,
|
@@ -19889,12 +20115,19 @@
|
|
19889
20115
|
]
|
19890
20116
|
},
|
19891
20117
|
"currency": {
|
19892
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
20118
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
19893
20119
|
"title": "currency",
|
19894
20120
|
"type": [
|
19895
20121
|
"string"
|
19896
20122
|
]
|
19897
20123
|
},
|
20124
|
+
"description": {
|
20125
|
+
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
|
20126
|
+
"title": "description",
|
20127
|
+
"type": [
|
20128
|
+
"string"
|
20129
|
+
]
|
20130
|
+
},
|
19898
20131
|
"destination": {
|
19899
20132
|
"description": "The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.",
|
19900
20133
|
"title": "destination",
|
@@ -19930,7 +20163,7 @@
|
|
19930
20163
|
]
|
19931
20164
|
},
|
19932
20165
|
"source_type": {
|
19933
|
-
"description": "The source balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are:
|
20166
|
+
"description": "The source balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: **alipay_account**, **bank_account**, and **card**.",
|
19934
20167
|
"title": "source_type",
|
19935
20168
|
"type": [
|
19936
20169
|
"string"
|
@@ -20125,7 +20358,7 @@
|
|
20125
20358
|
"type": "string"
|
20126
20359
|
},
|
20127
20360
|
{
|
20128
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
20361
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
20129
20362
|
"in": "query",
|
20130
20363
|
"name": "limit",
|
20131
20364
|
"required": false,
|
@@ -20238,7 +20471,7 @@
|
|
20238
20471
|
]
|
20239
20472
|
},
|
20240
20473
|
"currency": {
|
20241
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
20474
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
20242
20475
|
"title": "currency",
|
20243
20476
|
"type": [
|
20244
20477
|
"string"
|
@@ -20538,7 +20771,7 @@
|
|
20538
20771
|
"type": "string"
|
20539
20772
|
},
|
20540
20773
|
{
|
20541
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
20774
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
20542
20775
|
"in": "query",
|
20543
20776
|
"name": "limit",
|
20544
20777
|
"required": false,
|
@@ -20978,7 +21211,7 @@
|
|
20978
21211
|
"type": "string"
|
20979
21212
|
},
|
20980
21213
|
{
|
20981
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
21214
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
20982
21215
|
"in": "query",
|
20983
21216
|
"name": "limit",
|
20984
21217
|
"required": false,
|
@@ -21406,7 +21639,7 @@
|
|
21406
21639
|
"type": "string"
|
21407
21640
|
},
|
21408
21641
|
{
|
21409
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
21642
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
21410
21643
|
"in": "query",
|
21411
21644
|
"name": "limit",
|
21412
21645
|
"required": false,
|
@@ -21772,7 +22005,7 @@
|
|
21772
22005
|
"type": "string"
|
21773
22006
|
},
|
21774
22007
|
{
|
21775
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
22008
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
21776
22009
|
"in": "query",
|
21777
22010
|
"name": "limit",
|
21778
22011
|
"required": false,
|
@@ -22061,7 +22294,7 @@
|
|
22061
22294
|
"type": "string"
|
22062
22295
|
},
|
22063
22296
|
{
|
22064
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
22297
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
22065
22298
|
"in": "query",
|
22066
22299
|
"name": "limit",
|
22067
22300
|
"required": false,
|
@@ -22209,7 +22442,7 @@
|
|
22209
22442
|
]
|
22210
22443
|
},
|
22211
22444
|
"currency": {
|
22212
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
22445
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
22213
22446
|
"title": "currency",
|
22214
22447
|
"type": [
|
22215
22448
|
"string"
|
@@ -22264,7 +22497,7 @@
|
|
22264
22497
|
]
|
22265
22498
|
},
|
22266
22499
|
"price": {
|
22267
|
-
"description": "The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a
|
22500
|
+
"description": "The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
|
22268
22501
|
"title": "price",
|
22269
22502
|
"type": [
|
22270
22503
|
"integer"
|
@@ -22414,7 +22647,7 @@
|
|
22414
22647
|
]
|
22415
22648
|
},
|
22416
22649
|
"currency": {
|
22417
|
-
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://
|
22650
|
+
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
|
22418
22651
|
"title": "currency",
|
22419
22652
|
"type": [
|
22420
22653
|
"string"
|
@@ -22462,7 +22695,7 @@
|
|
22462
22695
|
]
|
22463
22696
|
},
|
22464
22697
|
"price": {
|
22465
|
-
"description": "The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a
|
22698
|
+
"description": "The cost of the item as a positive integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
|
22466
22699
|
"title": "price",
|
22467
22700
|
"type": [
|
22468
22701
|
"integer"
|
@@ -22515,7 +22748,7 @@
|
|
22515
22748
|
]
|
22516
22749
|
},
|
22517
22750
|
"currency": {
|
22518
|
-
"description": "Three-letter [ISO code for the currency](https://
|
22751
|
+
"description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.",
|
22519
22752
|
"title": "currency",
|
22520
22753
|
"type": [
|
22521
22754
|
"string"
|
@@ -22781,7 +23014,7 @@
|
|
22781
23014
|
"type": "string"
|
22782
23015
|
},
|
22783
23016
|
{
|
22784
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
23017
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
22785
23018
|
"in": "query",
|
22786
23019
|
"name": "limit",
|
22787
23020
|
"required": false,
|
@@ -23149,7 +23382,7 @@
|
|
23149
23382
|
"type": "string"
|
23150
23383
|
},
|
23151
23384
|
{
|
23152
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
23385
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
23153
23386
|
"in": "query",
|
23154
23387
|
"name": "limit",
|
23155
23388
|
"required": false,
|
@@ -23338,7 +23571,7 @@
|
|
23338
23571
|
]
|
23339
23572
|
},
|
23340
23573
|
"source": {
|
23341
|
-
"description": "The source can either be a
|
23574
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.",
|
23342
23575
|
"title": "source",
|
23343
23576
|
"type": [
|
23344
23577
|
"object",
|
@@ -23549,7 +23782,7 @@
|
|
23549
23782
|
]
|
23550
23783
|
},
|
23551
23784
|
"source": {
|
23552
|
-
"description": "The source can either be a
|
23785
|
+
"description": "The source can either be a [Token](/docs/api#tokens)'s or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements), or a dictionary containing a user's credit card details (with the options shown below). You must provide a source if the customer does not already have a valid source attached, and you are subscribing the customer for a plan that is not free. Passing `source` will create a new source object, make it the customer default source, and delete the old customer default if one exists. If you want to add an additional source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card) to add the card and then the [customer update API](https://stripe.com/docs/api#update customer) to set it as the default. Whenever you attach a card to a customer, Stripe will automatically validate the card.",
|
23553
23786
|
"title": "source",
|
23554
23787
|
"type": [
|
23555
23788
|
"object",
|
@@ -23676,6 +23909,13 @@
|
|
23676
23909
|
"string"
|
23677
23910
|
]
|
23678
23911
|
},
|
23912
|
+
"referrer": {
|
23913
|
+
"description": "",
|
23914
|
+
"title": "referrer",
|
23915
|
+
"type": [
|
23916
|
+
"string"
|
23917
|
+
]
|
23918
|
+
},
|
23679
23919
|
"request_id": {
|
23680
23920
|
"description": "",
|
23681
23921
|
"title": "request_id",
|
@@ -23752,7 +23992,7 @@
|
|
23752
23992
|
"type": "string"
|
23753
23993
|
},
|
23754
23994
|
{
|
23755
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
23995
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
23756
23996
|
"in": "query",
|
23757
23997
|
"name": "limit",
|
23758
23998
|
"required": false,
|
@@ -23777,7 +24017,7 @@
|
|
23777
24017
|
"in": "query",
|
23778
24018
|
"name": "created",
|
23779
24019
|
"required": false,
|
23780
|
-
"type": "
|
24020
|
+
"type": "string"
|
23781
24021
|
},
|
23782
24022
|
{
|
23783
24023
|
"description": "Only return transfers for the destination specified by this account ID.",
|
@@ -23863,7 +24103,7 @@
|
|
23863
24103
|
},
|
23864
24104
|
"post": {
|
23865
24105
|
"description": "",
|
23866
|
-
"operationId": "
|
24106
|
+
"operationId": "TransferCreate",
|
23867
24107
|
"parameters": [
|
23868
24108
|
{
|
23869
24109
|
"description": "Body parameters for the request.",
|
@@ -23886,6 +24126,13 @@
|
|
23886
24126
|
"string"
|
23887
24127
|
]
|
23888
24128
|
},
|
24129
|
+
"description": {
|
24130
|
+
"description": "",
|
24131
|
+
"title": "description",
|
24132
|
+
"type": [
|
24133
|
+
"string"
|
24134
|
+
]
|
24135
|
+
},
|
23889
24136
|
"destination": {
|
23890
24137
|
"description": "",
|
23891
24138
|
"title": "destination",
|
@@ -24052,58 +24299,6 @@
|
|
24052
24299
|
}
|
24053
24300
|
}
|
24054
24301
|
},
|
24055
|
-
"/v1/transfers/{id}/cancel": {
|
24056
|
-
"post": {
|
24057
|
-
"description": "",
|
24058
|
-
"operationId": "ReverseNonStripeTransferOnSlashCancel",
|
24059
|
-
"parameters": [
|
24060
|
-
{
|
24061
|
-
"description": "",
|
24062
|
-
"in": "path",
|
24063
|
-
"name": "id",
|
24064
|
-
"required": true,
|
24065
|
-
"type": "string"
|
24066
|
-
},
|
24067
|
-
{
|
24068
|
-
"description": "Body parameters for the request.",
|
24069
|
-
"in": "body",
|
24070
|
-
"name": "payload",
|
24071
|
-
"required": false,
|
24072
|
-
"schema": {
|
24073
|
-
"properties": {
|
24074
|
-
"expand": {
|
24075
|
-
"description": "Specifies which fields in the response should be expanded.",
|
24076
|
-
"items": {
|
24077
|
-
"type": [
|
24078
|
-
"string"
|
24079
|
-
]
|
24080
|
-
},
|
24081
|
-
"title": "expand",
|
24082
|
-
"type": [
|
24083
|
-
"array",
|
24084
|
-
"string"
|
24085
|
-
]
|
24086
|
-
}
|
24087
|
-
}
|
24088
|
-
}
|
24089
|
-
}
|
24090
|
-
],
|
24091
|
-
"responses": {
|
24092
|
-
"200": {
|
24093
|
-
"description": "Successful response.",
|
24094
|
-
"schema": {
|
24095
|
-
"$ref": "#/definitions/legacy_transfer"
|
24096
|
-
}
|
24097
|
-
},
|
24098
|
-
"default": {
|
24099
|
-
"description": "Error response.",
|
24100
|
-
"schema": {
|
24101
|
-
"$ref": "#/definitions/error"
|
24102
|
-
}
|
24103
|
-
}
|
24104
|
-
}
|
24105
|
-
}
|
24106
|
-
},
|
24107
24302
|
"/v1/transfers/{id}/reversals": {
|
24108
24303
|
"get": {
|
24109
24304
|
"description": "<p>You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional reversals.</p>",
|
@@ -24117,7 +24312,7 @@
|
|
24117
24312
|
"type": "string"
|
24118
24313
|
},
|
24119
24314
|
{
|
24120
|
-
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items.",
|
24315
|
+
"description": "A limit on the number of objects to be returned. Limit can range between 1 and 100 items, and the default is 10 items.",
|
24121
24316
|
"in": "query",
|
24122
24317
|
"name": "limit",
|
24123
24318
|
"required": false,
|