stripe 2.11.0 → 2.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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.yaml
CHANGED
@@ -32,7 +32,7 @@ definitions:
|
|
32
32
|
type:
|
33
33
|
- string
|
34
34
|
details_submitted:
|
35
|
-
description: Whether or not account details have been submitted yet.
|
35
|
+
description: Whether or not account details have been submitted yet. Standard
|
36
36
|
accounts cannot receive transfers before this is true.
|
37
37
|
type:
|
38
38
|
- boolean
|
@@ -89,11 +89,6 @@ definitions:
|
|
89
89
|
- string
|
90
90
|
legal_entity:
|
91
91
|
"$ref": "#/definitions/legal_entity"
|
92
|
-
managed:
|
93
|
-
description: Whether or not the account is [managed](/docs/connect/managed-accounts)
|
94
|
-
by your platform. Returns null if the account was not created by a platform.
|
95
|
-
type:
|
96
|
-
- boolean
|
97
92
|
metadata:
|
98
93
|
description: Set of key/value pairs that you can attach to an object. It can
|
99
94
|
be useful for storing additional information about the object in a structured
|
@@ -146,6 +141,11 @@ definitions:
|
|
146
141
|
- string
|
147
142
|
tos_acceptance:
|
148
143
|
"$ref": "#/definitions/account_tos_acceptance"
|
144
|
+
type:
|
145
|
+
description: The type of the Stripe account. Can be 'standard', 'express',
|
146
|
+
or 'custom'.
|
147
|
+
type:
|
148
|
+
- string
|
149
149
|
verification:
|
150
150
|
"$ref": "#/definitions/account_verification"
|
151
151
|
required:
|
@@ -158,11 +158,11 @@ definitions:
|
|
158
158
|
- external_accounts
|
159
159
|
- id
|
160
160
|
- legal_entity
|
161
|
-
- managed
|
162
161
|
- object
|
163
162
|
- payout_schedule
|
164
163
|
- payouts_enabled
|
165
164
|
- tos_acceptance
|
165
|
+
- type
|
166
166
|
- verification
|
167
167
|
title: Account
|
168
168
|
type:
|
@@ -237,7 +237,7 @@ definitions:
|
|
237
237
|
description: A string describing the reason for this account being unable
|
238
238
|
to charge and/or transfer, if that is the case. Possible values are `rejected.fraud`,
|
239
239
|
`rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `fields_needed`,
|
240
|
-
`listed`, or `other`.
|
240
|
+
`listed`, `under_review`, or `other`.
|
241
241
|
type:
|
242
242
|
- string
|
243
243
|
due_by:
|
@@ -290,7 +290,7 @@ definitions:
|
|
290
290
|
type:
|
291
291
|
- string
|
292
292
|
details_submitted:
|
293
|
-
description: Whether or not account details have been submitted yet.
|
293
|
+
description: Whether or not account details have been submitted yet. Standard
|
294
294
|
accounts cannot receive transfers before this is true.
|
295
295
|
type:
|
296
296
|
- boolean
|
@@ -351,11 +351,6 @@ definitions:
|
|
351
351
|
- object
|
352
352
|
legal_entity:
|
353
353
|
"$ref": "#/definitions/legal_entity"
|
354
|
-
managed:
|
355
|
-
description: Whether or not the account is [managed](/docs/connect/managed-accounts)
|
356
|
-
by your platform. Returns null if the account was not created by a platform.
|
357
|
-
type:
|
358
|
-
- boolean
|
359
354
|
metadata:
|
360
355
|
description: Set of key/value pairs that you can attach to an object. It can
|
361
356
|
be useful for storing additional information about the object in a structured
|
@@ -408,6 +403,11 @@ definitions:
|
|
408
403
|
- string
|
409
404
|
tos_acceptance:
|
410
405
|
"$ref": "#/definitions/account_tos_acceptance"
|
406
|
+
type:
|
407
|
+
description: The type of the Stripe account. Can be 'standard', 'express',
|
408
|
+
or 'custom'.
|
409
|
+
type:
|
410
|
+
- string
|
411
411
|
verification:
|
412
412
|
"$ref": "#/definitions/account_verification"
|
413
413
|
required:
|
@@ -421,11 +421,11 @@ definitions:
|
|
421
421
|
- id
|
422
422
|
- keys
|
423
423
|
- legal_entity
|
424
|
-
- managed
|
425
424
|
- object
|
426
425
|
- payout_schedule
|
427
426
|
- payouts_enabled
|
428
427
|
- tos_acceptance
|
428
|
+
- type
|
429
429
|
- verification
|
430
430
|
title: AccountWithKeys
|
431
431
|
type:
|
@@ -618,10 +618,15 @@ definitions:
|
|
618
618
|
- string
|
619
619
|
x-expansionResources:
|
620
620
|
oneOf:
|
621
|
-
- "$ref": "#/definitions/
|
621
|
+
- "$ref": "#/definitions/card"
|
622
|
+
created:
|
623
|
+
description: Time at which the object was created. Measured in seconds since
|
624
|
+
the Unix epoch.
|
625
|
+
type:
|
626
|
+
- integer
|
622
627
|
currency:
|
623
628
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
624
|
-
in lowercase. Must be a [supported currency](https://
|
629
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
625
630
|
type:
|
626
631
|
- string
|
627
632
|
held_amount:
|
@@ -653,6 +658,7 @@ definitions:
|
|
653
658
|
- amount
|
654
659
|
- balance_transactions
|
655
660
|
- card
|
661
|
+
- created
|
656
662
|
- currency
|
657
663
|
- held_amount
|
658
664
|
- held_currency
|
@@ -713,7 +719,7 @@ definitions:
|
|
713
719
|
- integer
|
714
720
|
currency:
|
715
721
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
716
|
-
in lowercase. Must be a [supported currency](https://
|
722
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
717
723
|
type:
|
718
724
|
- string
|
719
725
|
id:
|
@@ -814,7 +820,7 @@ definitions:
|
|
814
820
|
type:
|
815
821
|
- array
|
816
822
|
connect_reserved:
|
817
|
-
description: Funds held due to negative balances on connected
|
823
|
+
description: Funds held due to negative balances on connected Custom accounts.
|
818
824
|
The connect reserve balance for each currency and payment type can be found
|
819
825
|
in the `source_types` property.
|
820
826
|
type:
|
@@ -863,7 +869,7 @@ definitions:
|
|
863
869
|
- integer
|
864
870
|
currency:
|
865
871
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
866
|
-
in lowercase. Must be a [supported currency](https://
|
872
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
867
873
|
type:
|
868
874
|
- string
|
869
875
|
description:
|
@@ -905,7 +911,6 @@ definitions:
|
|
905
911
|
- "$ref": "#/definitions/fee_refund"
|
906
912
|
- "$ref": "#/definitions/authorization"
|
907
913
|
- "$ref": "#/definitions/transaction"
|
908
|
-
- "$ref": "#/definitions/legacy_transfer"
|
909
914
|
- "$ref": "#/definitions/payout"
|
910
915
|
- "$ref": "#/definitions/platform_fee"
|
911
916
|
- "$ref": "#/definitions/refund"
|
@@ -972,7 +977,7 @@ definitions:
|
|
972
977
|
type:
|
973
978
|
- string
|
974
979
|
currency:
|
975
|
-
description: Three-letter [ISO code for the currency](https://
|
980
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts)
|
976
981
|
paid out to the bank account.
|
977
982
|
type:
|
978
983
|
- string
|
@@ -1081,7 +1086,7 @@ definitions:
|
|
1081
1086
|
type:
|
1082
1087
|
- integer
|
1083
1088
|
currency:
|
1084
|
-
description: Three-letter [ISO code for the currency](https://
|
1089
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
1085
1090
|
to which the bitcoin will be converted.
|
1086
1091
|
type:
|
1087
1092
|
- string
|
@@ -1223,7 +1228,7 @@ definitions:
|
|
1223
1228
|
type:
|
1224
1229
|
- integer
|
1225
1230
|
currency:
|
1226
|
-
description: Three-letter [ISO code for the currency](https://
|
1231
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
1227
1232
|
to which this transaction was converted.
|
1228
1233
|
type:
|
1229
1234
|
- string
|
@@ -1315,7 +1320,7 @@ definitions:
|
|
1315
1320
|
type:
|
1316
1321
|
- string
|
1317
1322
|
currency:
|
1318
|
-
description: Three-letter [ISO code for currency](https://
|
1323
|
+
description: Three-letter [ISO code for currency](https://stripe.com/docs/payouts).
|
1319
1324
|
Only applicable on accounts (not customers or recipients). The card can
|
1320
1325
|
be used as a transfer destination for funds in this currency.
|
1321
1326
|
type:
|
@@ -1418,8 +1423,8 @@ definitions:
|
|
1418
1423
|
charge:
|
1419
1424
|
properties:
|
1420
1425
|
amount:
|
1421
|
-
description: A positive integer in the [smallest currency unit](https://
|
1422
|
-
(e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a
|
1426
|
+
description: A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)
|
1427
|
+
(e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency)
|
1423
1428
|
representing how much to charge. The minimum amount is $0.50 US or [equivalent
|
1424
1429
|
in charge currency](https://support.stripe.com/questions/what-is-the-minimum-amount-i-can-charge-with-stripe).
|
1425
1430
|
type:
|
@@ -1465,7 +1470,7 @@ definitions:
|
|
1465
1470
|
- integer
|
1466
1471
|
currency:
|
1467
1472
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
1468
|
-
in lowercase. Must be a [supported currency](https://
|
1473
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
1469
1474
|
type:
|
1470
1475
|
- string
|
1471
1476
|
customer:
|
@@ -1570,7 +1575,8 @@ definitions:
|
|
1570
1575
|
- string
|
1571
1576
|
receipt_number:
|
1572
1577
|
description: This is the transaction number that appears on email receipts
|
1573
|
-
sent for this charge.
|
1578
|
+
sent for this charge. This attribute will be `null` until a receipt has
|
1579
|
+
been sent.
|
1574
1580
|
type:
|
1575
1581
|
- string
|
1576
1582
|
refunded:
|
@@ -1805,8 +1811,8 @@ definitions:
|
|
1805
1811
|
- integer
|
1806
1812
|
currency:
|
1807
1813
|
description: If `amount_off` has been set, the three-letter [ISO code for
|
1808
|
-
the currency](https://
|
1809
|
-
|
1814
|
+
the currency](https://stripe.com/docs/currencies) of the amount to take
|
1815
|
+
off.
|
1810
1816
|
type:
|
1811
1817
|
- string
|
1812
1818
|
duration:
|
@@ -1899,7 +1905,7 @@ definitions:
|
|
1899
1905
|
type:
|
1900
1906
|
- integer
|
1901
1907
|
currency:
|
1902
|
-
description: Three-letter [ISO code for the currency](https://
|
1908
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
1903
1909
|
the customer can be charged in for recurring billing purposes.
|
1904
1910
|
type:
|
1905
1911
|
- string
|
@@ -2143,8 +2149,8 @@ definitions:
|
|
2143
2149
|
oneOf:
|
2144
2150
|
- "$ref": "#/definitions/customer"
|
2145
2151
|
end:
|
2146
|
-
description: If the coupon has a duration of `
|
2147
|
-
|
2152
|
+
description: If the coupon has a duration of `repeating`, the date that this
|
2153
|
+
discount will end. If the coupon has a duration of `once` or `forever`,
|
2148
2154
|
this attribute will be null.
|
2149
2155
|
type:
|
2150
2156
|
- integer
|
@@ -2199,18 +2205,13 @@ definitions:
|
|
2199
2205
|
- integer
|
2200
2206
|
currency:
|
2201
2207
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
2202
|
-
in lowercase. Must be a [supported currency](https://
|
2208
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2203
2209
|
type:
|
2204
2210
|
- string
|
2205
2211
|
evidence:
|
2206
|
-
|
2207
|
-
in the hash will submit all fields in the hash for review.
|
2208
|
-
type:
|
2209
|
-
- object
|
2212
|
+
"$ref": "#/definitions/dispute_evidence"
|
2210
2213
|
evidence_details:
|
2211
|
-
|
2212
|
-
type:
|
2213
|
-
- object
|
2214
|
+
"$ref": "#/definitions/dispute_evidence_details"
|
2214
2215
|
id:
|
2215
2216
|
description: Unique identifier for the object.
|
2216
2217
|
type:
|
@@ -2272,6 +2273,301 @@ definitions:
|
|
2272
2273
|
x-expandableFields:
|
2273
2274
|
- charge
|
2274
2275
|
x-resourceId: dispute
|
2276
|
+
dispute_evidence:
|
2277
|
+
properties:
|
2278
|
+
access_activity_log:
|
2279
|
+
description: Any server or activity logs showing proof that the customer accessed
|
2280
|
+
or downloaded the purchased digital product. This information should include
|
2281
|
+
IP addresses, corresponding timestamps, and any detailed recorded activity.
|
2282
|
+
type:
|
2283
|
+
- string
|
2284
|
+
billing_address:
|
2285
|
+
description: The billing address provided by the customer.
|
2286
|
+
type:
|
2287
|
+
- string
|
2288
|
+
cancellation_policy:
|
2289
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2290
|
+
Your subscription cancellation policy, as shown to the customer."
|
2291
|
+
type:
|
2292
|
+
- string
|
2293
|
+
x-expansionResources:
|
2294
|
+
oneOf:
|
2295
|
+
- "$ref": "#/definitions/file"
|
2296
|
+
cancellation_policy_disclosure:
|
2297
|
+
description: An explanation of how and when the customer was shown your refund
|
2298
|
+
policy prior to purchase.
|
2299
|
+
type:
|
2300
|
+
- string
|
2301
|
+
cancellation_rebuttal:
|
2302
|
+
description: A justification for why the customer's subscription was not canceled.
|
2303
|
+
type:
|
2304
|
+
- string
|
2305
|
+
customer_communication:
|
2306
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2307
|
+
Any communication with the customer that you feel is relevant to your case
|
2308
|
+
(for example emails proving that they received the product or service, or
|
2309
|
+
demonstrating their use of or satisfaction with the product or service)."
|
2310
|
+
type:
|
2311
|
+
- string
|
2312
|
+
x-expansionResources:
|
2313
|
+
oneOf:
|
2314
|
+
- "$ref": "#/definitions/file"
|
2315
|
+
customer_email_address:
|
2316
|
+
description: The email address of the customer.
|
2317
|
+
type:
|
2318
|
+
- string
|
2319
|
+
customer_name:
|
2320
|
+
description: The name of the customer.
|
2321
|
+
type:
|
2322
|
+
- string
|
2323
|
+
customer_purchase_ip:
|
2324
|
+
description: The IP address that the customer used when making the purchase.
|
2325
|
+
type:
|
2326
|
+
- string
|
2327
|
+
customer_signature:
|
2328
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2329
|
+
A relevant document or contract showing the customer's signature."
|
2330
|
+
type:
|
2331
|
+
- string
|
2332
|
+
x-expansionResources:
|
2333
|
+
oneOf:
|
2334
|
+
- "$ref": "#/definitions/file"
|
2335
|
+
duplicate_charge_documentation:
|
2336
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2337
|
+
Documentation for the prior charge that can uniquely identify the charge,
|
2338
|
+
such as a receipt, shipping label, work order, etc. This document should
|
2339
|
+
be paired with a similar document from the disputed payment that proves
|
2340
|
+
the two payments are separate."
|
2341
|
+
type:
|
2342
|
+
- string
|
2343
|
+
x-expansionResources:
|
2344
|
+
oneOf:
|
2345
|
+
- "$ref": "#/definitions/file"
|
2346
|
+
duplicate_charge_explanation:
|
2347
|
+
description: An explanation of the difference between the disputed charge
|
2348
|
+
and the prior charge that appears to be a duplicate.
|
2349
|
+
type:
|
2350
|
+
- string
|
2351
|
+
duplicate_charge_id:
|
2352
|
+
description: The Stripe ID for the prior charge which appears to be a duplicate
|
2353
|
+
of the disputed charge.
|
2354
|
+
type:
|
2355
|
+
- string
|
2356
|
+
product_description:
|
2357
|
+
description: A description of the product or service which was sold.
|
2358
|
+
type:
|
2359
|
+
- string
|
2360
|
+
receipt:
|
2361
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2362
|
+
Any receipt or message sent to the customer notifying them of the charge."
|
2363
|
+
type:
|
2364
|
+
- string
|
2365
|
+
x-expansionResources:
|
2366
|
+
oneOf:
|
2367
|
+
- "$ref": "#/definitions/file"
|
2368
|
+
refund_policy:
|
2369
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2370
|
+
Your refund policy, as shown to the customer."
|
2371
|
+
type:
|
2372
|
+
- string
|
2373
|
+
x-expansionResources:
|
2374
|
+
oneOf:
|
2375
|
+
- "$ref": "#/definitions/file"
|
2376
|
+
refund_policy_disclosure:
|
2377
|
+
description: Documentation demonstrating that the customer was shown your
|
2378
|
+
refund policy prior to purchase.
|
2379
|
+
type:
|
2380
|
+
- string
|
2381
|
+
refund_refusal_explanation:
|
2382
|
+
description: A justification for why the customer is not entitled to a refund.
|
2383
|
+
type:
|
2384
|
+
- string
|
2385
|
+
service_date:
|
2386
|
+
description: The date on which the customer received or began receiving the
|
2387
|
+
purchased service, in a clear human-readable format.
|
2388
|
+
type:
|
2389
|
+
- string
|
2390
|
+
service_documentation:
|
2391
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2392
|
+
Documentation showing proof that a service was provided to the customer.
|
2393
|
+
This could include a copy of a signed contract, work order, or other form
|
2394
|
+
of written agreement."
|
2395
|
+
type:
|
2396
|
+
- string
|
2397
|
+
x-expansionResources:
|
2398
|
+
oneOf:
|
2399
|
+
- "$ref": "#/definitions/file"
|
2400
|
+
shipping_address:
|
2401
|
+
description: The address to which a physical product was shipped. You should
|
2402
|
+
try to include as much complete address information as possible.
|
2403
|
+
type:
|
2404
|
+
- string
|
2405
|
+
shipping_carrier:
|
2406
|
+
description: The delivery service that shipped a physical product, such as
|
2407
|
+
Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase,
|
2408
|
+
please separate them with commas.
|
2409
|
+
type:
|
2410
|
+
- string
|
2411
|
+
shipping_date:
|
2412
|
+
description: The date on which a physical product began its route to the shipping
|
2413
|
+
address, in a clear human-readable format.
|
2414
|
+
type:
|
2415
|
+
- string
|
2416
|
+
shipping_documentation:
|
2417
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2418
|
+
Documentation showing proof that a product was shipped to the customer at
|
2419
|
+
the same address the customer provided to you. This could include a copy
|
2420
|
+
of the shipment receipt, shipping label, etc, and should show the full shipping
|
2421
|
+
address of the customer, if possible."
|
2422
|
+
type:
|
2423
|
+
- string
|
2424
|
+
x-expansionResources:
|
2425
|
+
oneOf:
|
2426
|
+
- "$ref": "#/definitions/file"
|
2427
|
+
shipping_tracking_number:
|
2428
|
+
description: The tracking number for a physical product, obtained from the
|
2429
|
+
delivery service. If multiple tracking numbers were generated for this purchase,
|
2430
|
+
please separate them with commas.
|
2431
|
+
type:
|
2432
|
+
- string
|
2433
|
+
uncategorized_file:
|
2434
|
+
description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload))
|
2435
|
+
Any additional evidence or statements."
|
2436
|
+
type:
|
2437
|
+
- string
|
2438
|
+
x-expansionResources:
|
2439
|
+
oneOf:
|
2440
|
+
- "$ref": "#/definitions/file"
|
2441
|
+
uncategorized_text:
|
2442
|
+
description: Any additional evidence or statements.
|
2443
|
+
type:
|
2444
|
+
- string
|
2445
|
+
title: DisputeEvidence
|
2446
|
+
type:
|
2447
|
+
- object
|
2448
|
+
x-expandableFields:
|
2449
|
+
- cancellation_policy
|
2450
|
+
- customer_communication
|
2451
|
+
- customer_signature
|
2452
|
+
- duplicate_charge_documentation
|
2453
|
+
- receipt
|
2454
|
+
- refund_policy
|
2455
|
+
- service_documentation
|
2456
|
+
- shipping_documentation
|
2457
|
+
- uncategorized_file
|
2458
|
+
x-resourceId: dispute_evidence
|
2459
|
+
dispute_evidence_details:
|
2460
|
+
properties:
|
2461
|
+
due_by:
|
2462
|
+
description: Date by which evidence must be submitted in order to successfully
|
2463
|
+
challenge dispute. Will be null if the customer's bank or credit card company
|
2464
|
+
doesn't allow a response for this particular dispute.
|
2465
|
+
type:
|
2466
|
+
- integer
|
2467
|
+
has_evidence:
|
2468
|
+
description: Whether or not evidence has been staged for this dispute.
|
2469
|
+
type:
|
2470
|
+
- boolean
|
2471
|
+
past_due:
|
2472
|
+
description: Whether or not the last evidence submission was submitted past
|
2473
|
+
the due date. Defaults to `false` if no evidence submissions have occurred.
|
2474
|
+
If true, then delivery of the latest evidence is not guaranteed.
|
2475
|
+
type:
|
2476
|
+
- boolean
|
2477
|
+
submission_count:
|
2478
|
+
description: The number of times evidence has been submitted. Typically, you
|
2479
|
+
may only submit evidence once.
|
2480
|
+
type:
|
2481
|
+
- integer
|
2482
|
+
required:
|
2483
|
+
- has_evidence
|
2484
|
+
- past_due
|
2485
|
+
- submission_count
|
2486
|
+
title: DisputeEvidenceDetails
|
2487
|
+
type:
|
2488
|
+
- object
|
2489
|
+
x-expandableFields: []
|
2490
|
+
x-resourceId: dispute_evidence_details
|
2491
|
+
ephemeral_key:
|
2492
|
+
properties:
|
2493
|
+
created:
|
2494
|
+
description: Time at which the object was created. Measured in seconds since
|
2495
|
+
the Unix epoch.
|
2496
|
+
type:
|
2497
|
+
- integer
|
2498
|
+
expires:
|
2499
|
+
description: Time at which the key will expire. Measured in seconds since
|
2500
|
+
the Unix epoch.
|
2501
|
+
type:
|
2502
|
+
- integer
|
2503
|
+
id:
|
2504
|
+
description: Unique identifier for the object.
|
2505
|
+
type:
|
2506
|
+
- string
|
2507
|
+
livemode:
|
2508
|
+
description: Flag indicating whether the object exists in live mode or test
|
2509
|
+
mode.
|
2510
|
+
type:
|
2511
|
+
- boolean
|
2512
|
+
object:
|
2513
|
+
description: String representing the object's type. Objects of the same type
|
2514
|
+
share the same value.
|
2515
|
+
type:
|
2516
|
+
- string
|
2517
|
+
required:
|
2518
|
+
- created
|
2519
|
+
- expires
|
2520
|
+
- id
|
2521
|
+
- livemode
|
2522
|
+
- object
|
2523
|
+
title: EphemeralKey
|
2524
|
+
type:
|
2525
|
+
- object
|
2526
|
+
x-expandableFields: []
|
2527
|
+
x-resourceId: ephemeral_key
|
2528
|
+
ephemeral_key_with_secret:
|
2529
|
+
properties:
|
2530
|
+
created:
|
2531
|
+
description: Time at which the object was created. Measured in seconds since
|
2532
|
+
the Unix epoch.
|
2533
|
+
type:
|
2534
|
+
- integer
|
2535
|
+
expires:
|
2536
|
+
description: Time at which the key will expire. Measured in seconds since
|
2537
|
+
the Unix epoch.
|
2538
|
+
type:
|
2539
|
+
- integer
|
2540
|
+
id:
|
2541
|
+
description: Unique identifier for the object.
|
2542
|
+
type:
|
2543
|
+
- string
|
2544
|
+
livemode:
|
2545
|
+
description: Flag indicating whether the object exists in live mode or test
|
2546
|
+
mode.
|
2547
|
+
type:
|
2548
|
+
- boolean
|
2549
|
+
object:
|
2550
|
+
description: String representing the object's type. Objects of the same type
|
2551
|
+
share the same value.
|
2552
|
+
type:
|
2553
|
+
- string
|
2554
|
+
secret:
|
2555
|
+
description: The key's secret. You can use this value to make authorized requests
|
2556
|
+
to the Stripe API.
|
2557
|
+
type:
|
2558
|
+
- string
|
2559
|
+
required:
|
2560
|
+
- created
|
2561
|
+
- expires
|
2562
|
+
- id
|
2563
|
+
- livemode
|
2564
|
+
- object
|
2565
|
+
- secret
|
2566
|
+
title: EphemeralKeyWithSecret
|
2567
|
+
type:
|
2568
|
+
- object
|
2569
|
+
x-expandableFields: []
|
2570
|
+
x-resourceId: ephemeral_key_with_secret
|
2275
2571
|
error:
|
2276
2572
|
description: An error response from the Stripe API.
|
2277
2573
|
properties:
|
@@ -2348,13 +2644,7 @@ definitions:
|
|
2348
2644
|
type:
|
2349
2645
|
- integer
|
2350
2646
|
request:
|
2351
|
-
|
2352
|
-
was automatic (e.g. Stripe''s automatic subscription handling). Request
|
2353
|
-
logs are available in the [dashboard](https://dashboard.stripe.com/logs)
|
2354
|
-
but currently not in the API. *Note: this property is populated for events
|
2355
|
-
on or after April 23, 2013*.'
|
2356
|
-
type:
|
2357
|
-
- string
|
2647
|
+
"$ref": "#/definitions/event_request"
|
2358
2648
|
type:
|
2359
2649
|
description: 'Description of the event: e.g. `invoice.created`, `charge.refunded`,
|
2360
2650
|
etc.'
|
@@ -2376,13 +2666,13 @@ definitions:
|
|
2376
2666
|
event_data:
|
2377
2667
|
properties:
|
2378
2668
|
object:
|
2379
|
-
description:
|
2380
|
-
|
2381
|
-
|
2669
|
+
description: Object containing the API resource relevant to the event. For
|
2670
|
+
example, an `invoice.created` event will have a full [invoice object](#invoice_object)
|
2671
|
+
as the value of the object key.
|
2382
2672
|
type:
|
2383
2673
|
- object
|
2384
2674
|
previous_attributes:
|
2385
|
-
description:
|
2675
|
+
description: Object containing the names of the attributes that have changed
|
2386
2676
|
and their previous values (only sent along with *.updated events)
|
2387
2677
|
type:
|
2388
2678
|
- object
|
@@ -2393,6 +2683,25 @@ definitions:
|
|
2393
2683
|
- object
|
2394
2684
|
x-expandableFields: []
|
2395
2685
|
x-resourceId: event_data
|
2686
|
+
event_request:
|
2687
|
+
properties:
|
2688
|
+
id:
|
2689
|
+
description: ID of the API request that caused the event. If null, the event
|
2690
|
+
was automatic (e.g. Stripe's automatic subscription handling). Request logs
|
2691
|
+
are available in the [dashboard](https://dashboard.stripe.com/logs) but
|
2692
|
+
currently not in the API.
|
2693
|
+
type:
|
2694
|
+
- string
|
2695
|
+
idempotency_key:
|
2696
|
+
description: 'The idempotency key transmitted during the request, if any.
|
2697
|
+
*Note: this proprety is only populated for events on or after May 23, 2017*.'
|
2698
|
+
type:
|
2699
|
+
- string
|
2700
|
+
title: EventRequest
|
2701
|
+
type:
|
2702
|
+
- object
|
2703
|
+
x-expandableFields: []
|
2704
|
+
x-resourceId: event_request
|
2396
2705
|
external_account_source:
|
2397
2706
|
properties:
|
2398
2707
|
account:
|
@@ -2408,7 +2717,7 @@ definitions:
|
|
2408
2717
|
type:
|
2409
2718
|
- string
|
2410
2719
|
currency:
|
2411
|
-
description: Three-letter [ISO code for the currency](https://
|
2720
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts)
|
2412
2721
|
paid out to the bank account.
|
2413
2722
|
type:
|
2414
2723
|
- string
|
@@ -2477,7 +2786,7 @@ definitions:
|
|
2477
2786
|
- string
|
2478
2787
|
currency:
|
2479
2788
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
2480
|
-
in lowercase. Must be a [supported currency](https://
|
2789
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2481
2790
|
type:
|
2482
2791
|
- string
|
2483
2792
|
description:
|
@@ -2520,7 +2829,7 @@ definitions:
|
|
2520
2829
|
- integer
|
2521
2830
|
currency:
|
2522
2831
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
2523
|
-
in lowercase. Must be a [supported currency](https://
|
2832
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2524
2833
|
type:
|
2525
2834
|
- string
|
2526
2835
|
fee:
|
@@ -2681,7 +2990,7 @@ definitions:
|
|
2681
2990
|
- boolean
|
2682
2991
|
currency:
|
2683
2992
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
2684
|
-
in lowercase. Must be a [supported currency](https://
|
2993
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2685
2994
|
type:
|
2686
2995
|
- string
|
2687
2996
|
customer:
|
@@ -2882,7 +3191,7 @@ definitions:
|
|
2882
3191
|
- integer
|
2883
3192
|
currency:
|
2884
3193
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
2885
|
-
in lowercase. Must be a [supported currency](https://
|
3194
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2886
3195
|
type:
|
2887
3196
|
- string
|
2888
3197
|
customer:
|
@@ -2989,7 +3298,7 @@ definitions:
|
|
2989
3298
|
- integer
|
2990
3299
|
currency:
|
2991
3300
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
2992
|
-
in lowercase. Must be a [supported currency](https://
|
3301
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
2993
3302
|
type:
|
2994
3303
|
- string
|
2995
3304
|
description:
|
@@ -3015,311 +3324,62 @@ definitions:
|
|
3015
3324
|
be useful for storing additional information about the object in a structured
|
3016
3325
|
format.
|
3017
3326
|
type:
|
3018
|
-
- object
|
3019
|
-
object:
|
3020
|
-
description: String representing the object's type. Objects of the same type
|
3021
|
-
share the same value.
|
3022
|
-
type:
|
3023
|
-
- string
|
3024
|
-
period:
|
3025
|
-
description: The period this line_item covers. For subscription line items,
|
3026
|
-
this is the subscription period. For prorations, this starts when the proration
|
3027
|
-
was calculated, and ends at the period end of the subscription. For invoice
|
3028
|
-
items, this is the time at which the invoice item was created, so the period
|
3029
|
-
start and end are the same time.
|
3030
|
-
type:
|
3031
|
-
- object
|
3032
|
-
plan:
|
3033
|
-
"$ref": "#/definitions/plan"
|
3034
|
-
proration:
|
3035
|
-
description: Whether or not this is a proration.
|
3036
|
-
type:
|
3037
|
-
- boolean
|
3038
|
-
quantity:
|
3039
|
-
description: The quantity of the subscription, if the line item is a subscription
|
3040
|
-
or a proration.
|
3041
|
-
type:
|
3042
|
-
- integer
|
3043
|
-
subscription:
|
3044
|
-
description: When type is `invoiceitem`, the subscription that the invoice
|
3045
|
-
item pertains to, if any. Left blank when `type` is already subscription,
|
3046
|
-
as it'd be redundant with `id`.
|
3047
|
-
type:
|
3048
|
-
- string
|
3049
|
-
subscription_item:
|
3050
|
-
description: ''
|
3051
|
-
type:
|
3052
|
-
- string
|
3053
|
-
type:
|
3054
|
-
description: A string identifying the type of the source of this line item,
|
3055
|
-
either an `invoiceitem` or a `subscription`.
|
3056
|
-
type:
|
3057
|
-
- string
|
3058
|
-
required:
|
3059
|
-
- amount
|
3060
|
-
- currency
|
3061
|
-
- discountable
|
3062
|
-
- id
|
3063
|
-
- livemode
|
3064
|
-
- metadata
|
3065
|
-
- object
|
3066
|
-
- period
|
3067
|
-
- proration
|
3068
|
-
- type
|
3069
|
-
title: InvoiceLineItem
|
3070
|
-
type:
|
3071
|
-
- object
|
3072
|
-
x-expandableFields: []
|
3073
|
-
x-resourceId: invoice_line_item
|
3074
|
-
issued_card:
|
3075
|
-
properties:
|
3076
|
-
available_balance:
|
3077
|
-
description: ''
|
3078
|
-
type:
|
3079
|
-
- integer
|
3080
|
-
card:
|
3081
|
-
description: ''
|
3082
|
-
type:
|
3083
|
-
- string
|
3084
|
-
x-expansionResources:
|
3085
|
-
oneOf:
|
3086
|
-
- "$ref": "#/definitions/card"
|
3087
|
-
currency:
|
3088
|
-
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
3089
|
-
in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
|
3090
|
-
type:
|
3091
|
-
- string
|
3092
|
-
id:
|
3093
|
-
description: Unique identifier for the object.
|
3094
|
-
type:
|
3095
|
-
- string
|
3096
|
-
object:
|
3097
|
-
description: String representing the object's type. Objects of the same type
|
3098
|
-
share the same value.
|
3099
|
-
type:
|
3100
|
-
- string
|
3101
|
-
status:
|
3102
|
-
description: ''
|
3103
|
-
type:
|
3104
|
-
- string
|
3105
|
-
required:
|
3106
|
-
- available_balance
|
3107
|
-
- card
|
3108
|
-
- currency
|
3109
|
-
- id
|
3110
|
-
- object
|
3111
|
-
- status
|
3112
|
-
title: IssuedCard
|
3113
|
-
type:
|
3114
|
-
- object
|
3115
|
-
x-expandableFields:
|
3116
|
-
- card
|
3117
|
-
x-resourceId: issued_card
|
3118
|
-
legacy_transfer:
|
3119
|
-
properties:
|
3120
|
-
amount:
|
3121
|
-
description: Amount (in %s) to be transferred to your bank account.
|
3122
|
-
type:
|
3123
|
-
- integer
|
3124
|
-
amount_reversed:
|
3125
|
-
description: Amount in %s reversed (can be less than the amount attribute
|
3126
|
-
on the transfer if a partial reversal was issued).
|
3127
|
-
type:
|
3128
|
-
- integer
|
3129
|
-
application_fee:
|
3130
|
-
description: ''
|
3131
|
-
type:
|
3132
|
-
- string
|
3133
|
-
x-expansionResources:
|
3134
|
-
oneOf:
|
3135
|
-
- "$ref": "#/definitions/backwards_compatible_platform_earning"
|
3136
|
-
balance_transaction:
|
3137
|
-
description: Balance transaction that describes the impact of this transfer
|
3138
|
-
on your account balance.
|
3139
|
-
type:
|
3140
|
-
- string
|
3141
|
-
x-expansionResources:
|
3142
|
-
oneOf:
|
3143
|
-
- "$ref": "#/definitions/balance_transaction"
|
3144
|
-
created:
|
3145
|
-
description: Time at which the object was created. Measured in seconds since
|
3146
|
-
the Unix epoch.
|
3147
|
-
type:
|
3148
|
-
- integer
|
3149
|
-
currency:
|
3150
|
-
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
3151
|
-
in lowercase. Must be a [supported currency](https://support.stripe.com/questions/which-currencies-does-stripe-support).
|
3152
|
-
type:
|
3153
|
-
- string
|
3154
|
-
date:
|
3155
|
-
description: Date the transfer is scheduled to arrive in the bank. This factors
|
3156
|
-
in delays like weekends or bank holidays.
|
3157
|
-
type:
|
3158
|
-
- integer
|
3159
|
-
description:
|
3160
|
-
description: Internal-only description of the transfer.
|
3161
|
-
type:
|
3162
|
-
- string
|
3163
|
-
destination:
|
3164
|
-
description: ID of the bank account, card, or Stripe account the transfer
|
3165
|
-
was sent to.
|
3166
|
-
type:
|
3167
|
-
- string
|
3168
|
-
x-expansionResources:
|
3169
|
-
oneOf:
|
3170
|
-
- "$ref": "#/definitions/account"
|
3171
|
-
- "$ref": "#/definitions/bank_account"
|
3172
|
-
- "$ref": "#/definitions/card"
|
3173
|
-
destination_payment:
|
3174
|
-
description: If the destination is a Stripe account, this will be the ID of
|
3175
|
-
the payment that the destination account received for the transfer.
|
3176
|
-
type:
|
3177
|
-
- string
|
3178
|
-
x-expansionResources:
|
3179
|
-
oneOf:
|
3180
|
-
- "$ref": "#/definitions/charge"
|
3181
|
-
failure_code:
|
3182
|
-
description: Error code explaining reason for transfer failure if available.
|
3183
|
-
See [Types of transfer failures](/docs/api#transfer_failures) for a list
|
3184
|
-
of failure codes.
|
3185
|
-
type:
|
3186
|
-
- string
|
3187
|
-
failure_message:
|
3188
|
-
description: Message to user further explaining reason for transfer failure
|
3189
|
-
if available.
|
3190
|
-
type:
|
3191
|
-
- string
|
3192
|
-
id:
|
3193
|
-
description: Unique identifier for the object.
|
3194
|
-
type:
|
3195
|
-
- string
|
3196
|
-
livemode:
|
3197
|
-
description: Flag indicating whether the object exists in live mode or test
|
3198
|
-
mode.
|
3199
|
-
type:
|
3200
|
-
- boolean
|
3201
|
-
metadata:
|
3202
|
-
description: Set of key/value pairs that you can attach to an object. It can
|
3203
|
-
be useful for storing additional information about the object in a structured
|
3204
|
-
format.
|
3205
|
-
type:
|
3206
|
-
- object
|
3207
|
-
method:
|
3208
|
-
description: The method used to send this transfer, which can be `standard`
|
3209
|
-
or `instant`. `instant` is only supported for transfers to debit cards.
|
3210
|
-
(See [Instant payouts for marketplaces](/blog/instant-payouts-for-marketplaces)
|
3211
|
-
for more information.)
|
3212
|
-
type:
|
3213
|
-
- string
|
3214
|
-
object:
|
3215
|
-
description: String representing the object's type. Objects of the same type
|
3216
|
-
share the same value.
|
3217
|
-
type:
|
3218
|
-
- string
|
3219
|
-
reversals:
|
3220
|
-
properties:
|
3221
|
-
data:
|
3222
|
-
items:
|
3223
|
-
"$ref": "#/definitions/transfer_reversal"
|
3224
|
-
type:
|
3225
|
-
- array
|
3226
|
-
has_more:
|
3227
|
-
description: True if this list has another page of items after this one
|
3228
|
-
that can be fetched.
|
3229
|
-
type:
|
3230
|
-
- boolean
|
3231
|
-
object:
|
3232
|
-
description: String representing the object's type. Objects of the same
|
3233
|
-
type share the same value. Always has the value "list".
|
3234
|
-
enum:
|
3235
|
-
- list
|
3236
|
-
type:
|
3237
|
-
- string
|
3238
|
-
total_count:
|
3239
|
-
description: The total number of items available. This value is not included
|
3240
|
-
by default, but you can request it by specifying ?include[]=total_count.
|
3241
|
-
type:
|
3242
|
-
- integer
|
3243
|
-
url:
|
3244
|
-
description: The URL where this list can be accessed.
|
3245
|
-
type:
|
3246
|
-
- string
|
3247
|
-
required:
|
3248
|
-
- data
|
3249
|
-
- has_more
|
3250
|
-
- object
|
3251
|
-
- url
|
3252
|
-
title: TransferReversalList
|
3253
|
-
type:
|
3254
|
-
- object
|
3255
|
-
x-expandableFields: []
|
3256
|
-
reversed:
|
3257
|
-
description: Whether or not the transfer has been fully reversed. If the transfer
|
3258
|
-
is only partially reversed, this attribute will still be false.
|
3259
|
-
type:
|
3260
|
-
- boolean
|
3261
|
-
source_transaction:
|
3262
|
-
description: ID of the charge (or other transaction) that was used to fund
|
3263
|
-
the transfer. If null, the transfer was funded from the available balance.
|
3264
|
-
type:
|
3265
|
-
- string
|
3266
|
-
x-expansionResources:
|
3267
|
-
oneOf:
|
3268
|
-
- "$ref": "#/definitions/charge"
|
3269
|
-
- "$ref": "#/definitions/platform_fee"
|
3270
|
-
- "$ref": "#/definitions/transfer_reversal"
|
3271
|
-
source_type:
|
3272
|
-
description: The source balance this transfer came from. One of `card`, `bank_account`,
|
3273
|
-
`bitcoin_receiver`, or `alipay_account`.
|
3274
|
-
type:
|
3275
|
-
- string
|
3276
|
-
statement_descriptor:
|
3277
|
-
description: Extra information about a transfer to be displayed on the user's
|
3278
|
-
bank statement.
|
3327
|
+
- object
|
3328
|
+
object:
|
3329
|
+
description: String representing the object's type. Objects of the same type
|
3330
|
+
share the same value.
|
3279
3331
|
type:
|
3280
3332
|
- string
|
3281
|
-
|
3282
|
-
description:
|
3283
|
-
|
3284
|
-
|
3285
|
-
|
3286
|
-
|
3333
|
+
period:
|
3334
|
+
description: The period this line_item covers. For subscription line items,
|
3335
|
+
this is the subscription period. For prorations, this starts when the proration
|
3336
|
+
was calculated, and ends at the period end of the subscription. For invoice
|
3337
|
+
items, this is the time at which the invoice item was created, so the period
|
3338
|
+
start and end are the same time.
|
3339
|
+
type:
|
3340
|
+
- object
|
3341
|
+
plan:
|
3342
|
+
"$ref": "#/definitions/plan"
|
3343
|
+
proration:
|
3344
|
+
description: Whether or not this is a proration.
|
3345
|
+
type:
|
3346
|
+
- boolean
|
3347
|
+
quantity:
|
3348
|
+
description: The quantity of the subscription, if the line item is a subscription
|
3349
|
+
or a proration.
|
3350
|
+
type:
|
3351
|
+
- integer
|
3352
|
+
subscription:
|
3353
|
+
description: When type is `invoiceitem`, the subscription that the invoice
|
3354
|
+
item pertains to, if any. Left blank when `type` is already subscription,
|
3355
|
+
as it'd be redundant with `id`.
|
3287
3356
|
type:
|
3288
3357
|
- string
|
3289
|
-
|
3290
|
-
description:
|
3291
|
-
See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions)
|
3292
|
-
for details.
|
3358
|
+
subscription_item:
|
3359
|
+
description: ''
|
3293
3360
|
type:
|
3294
3361
|
- string
|
3295
3362
|
type:
|
3296
|
-
description:
|
3363
|
+
description: A string identifying the type of the source of this line item,
|
3364
|
+
either an `invoiceitem` or a `subscription`.
|
3297
3365
|
type:
|
3298
3366
|
- string
|
3299
3367
|
required:
|
3300
3368
|
- amount
|
3301
|
-
- amount_reversed
|
3302
|
-
- created
|
3303
3369
|
- currency
|
3304
|
-
-
|
3370
|
+
- discountable
|
3305
3371
|
- id
|
3306
3372
|
- livemode
|
3307
3373
|
- metadata
|
3308
3374
|
- object
|
3309
|
-
-
|
3310
|
-
-
|
3311
|
-
- status
|
3375
|
+
- period
|
3376
|
+
- proration
|
3312
3377
|
- type
|
3313
|
-
title:
|
3378
|
+
title: InvoiceLineItem
|
3314
3379
|
type:
|
3315
3380
|
- object
|
3316
|
-
x-expandableFields:
|
3317
|
-
-
|
3318
|
-
- balance_transaction
|
3319
|
-
- destination
|
3320
|
-
- destination_payment
|
3321
|
-
- source_transaction
|
3322
|
-
x-resourceId: legacy_transfer
|
3381
|
+
x-expandableFields: []
|
3382
|
+
x-resourceId: invoice_line_item
|
3323
3383
|
legal_entity:
|
3324
3384
|
properties:
|
3325
3385
|
additional_owners:
|
@@ -3413,6 +3473,10 @@ definitions:
|
|
3413
3473
|
the account have been provided.
|
3414
3474
|
type:
|
3415
3475
|
- boolean
|
3476
|
+
tax_id_registrar:
|
3477
|
+
description: ''
|
3478
|
+
type:
|
3479
|
+
- string
|
3416
3480
|
type:
|
3417
3481
|
description: Either "individual" or "company", for what kind of legal entity
|
3418
3482
|
the account owner is for.
|
@@ -3640,8 +3704,8 @@ definitions:
|
|
3640
3704
|
properties:
|
3641
3705
|
amount:
|
3642
3706
|
description: A positive integer in the smallest currency unit (that is, 100
|
3643
|
-
cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
3644
|
-
the total amount for the order.
|
3707
|
+
cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
|
3708
|
+
representing the total amount for the order.
|
3645
3709
|
type:
|
3646
3710
|
- integer
|
3647
3711
|
amount_returned:
|
@@ -3671,7 +3735,7 @@ definitions:
|
|
3671
3735
|
- integer
|
3672
3736
|
currency:
|
3673
3737
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
3674
|
-
in lowercase. Must be a [supported currency](https://
|
3738
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3675
3739
|
type:
|
3676
3740
|
- string
|
3677
3741
|
customer:
|
@@ -3796,13 +3860,13 @@ definitions:
|
|
3796
3860
|
properties:
|
3797
3861
|
amount:
|
3798
3862
|
description: A positive integer in the smallest currency unit (that is, 100
|
3799
|
-
cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
3800
|
-
the total amount for the line item.
|
3863
|
+
cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
|
3864
|
+
representing the total amount for the line item.
|
3801
3865
|
type:
|
3802
3866
|
- integer
|
3803
3867
|
currency:
|
3804
3868
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
3805
|
-
in lowercase. Must be a [supported currency](https://
|
3869
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3806
3870
|
type:
|
3807
3871
|
- string
|
3808
3872
|
description:
|
@@ -3850,8 +3914,8 @@ definitions:
|
|
3850
3914
|
properties:
|
3851
3915
|
amount:
|
3852
3916
|
description: A positive integer in the smallest currency unit (that is, 100
|
3853
|
-
cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
3854
|
-
the total amount for the returned line item.
|
3917
|
+
cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
|
3918
|
+
representing the total amount for the returned line item.
|
3855
3919
|
type:
|
3856
3920
|
- integer
|
3857
3921
|
created:
|
@@ -3861,7 +3925,7 @@ definitions:
|
|
3861
3925
|
- integer
|
3862
3926
|
currency:
|
3863
3927
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
3864
|
-
in lowercase. Must be a [supported currency](https://
|
3928
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
3865
3929
|
type:
|
3866
3930
|
- string
|
3867
3931
|
id:
|
@@ -3964,7 +4028,12 @@ definitions:
|
|
3964
4028
|
- integer
|
3965
4029
|
currency:
|
3966
4030
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
3967
|
-
in lowercase. Must be a [supported currency](https://
|
4031
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4032
|
+
type:
|
4033
|
+
- string
|
4034
|
+
description:
|
4035
|
+
description: An arbitrary string attached to the object. Often useful for
|
4036
|
+
displaying to users.
|
3968
4037
|
type:
|
3969
4038
|
- string
|
3970
4039
|
destination:
|
@@ -4079,7 +4148,7 @@ definitions:
|
|
4079
4148
|
- integer
|
4080
4149
|
currency:
|
4081
4150
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4082
|
-
in lowercase. Must be a [supported currency](https://
|
4151
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4083
4152
|
type:
|
4084
4153
|
- string
|
4085
4154
|
id:
|
@@ -4190,7 +4259,7 @@ definitions:
|
|
4190
4259
|
- integer
|
4191
4260
|
currency:
|
4192
4261
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4193
|
-
in lowercase. Must be a [supported currency](https://
|
4262
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4194
4263
|
type:
|
4195
4264
|
- string
|
4196
4265
|
id:
|
@@ -4328,7 +4397,7 @@ definitions:
|
|
4328
4397
|
- integer
|
4329
4398
|
currency:
|
4330
4399
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4331
|
-
in lowercase. Must be a [supported currency](https://
|
4400
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4332
4401
|
type:
|
4333
4402
|
- string
|
4334
4403
|
id:
|
@@ -4575,7 +4644,7 @@ definitions:
|
|
4575
4644
|
- integer
|
4576
4645
|
currency:
|
4577
4646
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4578
|
-
in lowercase. Must be a [supported currency](https://
|
4647
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4579
4648
|
type:
|
4580
4649
|
- string
|
4581
4650
|
description:
|
@@ -4636,7 +4705,7 @@ definitions:
|
|
4636
4705
|
- integer
|
4637
4706
|
currency:
|
4638
4707
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4639
|
-
in lowercase. Must be a [supported currency](https://
|
4708
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4640
4709
|
type:
|
4641
4710
|
- string
|
4642
4711
|
description:
|
@@ -4773,13 +4842,13 @@ definitions:
|
|
4773
4842
|
properties:
|
4774
4843
|
amount:
|
4775
4844
|
description: A positive integer in the smallest currency unit (that is, 100
|
4776
|
-
cents for $1.00, or 1 for ¥1, Japanese Yen being a
|
4777
|
-
the total amount for the line item.
|
4845
|
+
cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency)
|
4846
|
+
representing the total amount for the line item.
|
4778
4847
|
type:
|
4779
4848
|
- integer
|
4780
4849
|
currency:
|
4781
4850
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4782
|
-
in lowercase. Must be a [supported currency](https://
|
4851
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4783
4852
|
type:
|
4784
4853
|
- string
|
4785
4854
|
delivery_estimate:
|
@@ -4823,7 +4892,7 @@ definitions:
|
|
4823
4892
|
- integer
|
4824
4893
|
currency:
|
4825
4894
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
4826
|
-
in lowercase. Must be a [supported currency](https://
|
4895
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
4827
4896
|
type:
|
4828
4897
|
- string
|
4829
4898
|
id:
|
@@ -4858,7 +4927,7 @@ definitions:
|
|
4858
4927
|
price:
|
4859
4928
|
description: The cost of the item as a positive integer in the smallest currency
|
4860
4929
|
unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese
|
4861
|
-
Yen being a
|
4930
|
+
Yen being a zero-decimal currency).
|
4862
4931
|
type:
|
4863
4932
|
- integer
|
4864
4933
|
product:
|
@@ -4900,7 +4969,7 @@ definitions:
|
|
4900
4969
|
type:
|
4901
4970
|
- integer
|
4902
4971
|
client_secret:
|
4903
|
-
description: The client secret of the source. Used for client-side
|
4972
|
+
description: The client secret of the source. Used for client-side retrieval
|
4904
4973
|
using a publishable key.
|
4905
4974
|
type:
|
4906
4975
|
- string
|
@@ -4912,7 +4981,7 @@ definitions:
|
|
4912
4981
|
type:
|
4913
4982
|
- integer
|
4914
4983
|
currency:
|
4915
|
-
description: Three-letter [ISO code for the currency](https://
|
4984
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
4916
4985
|
associated with the source. This is the currency for which the source will
|
4917
4986
|
be chargeable once ready. Required for `single_use` sources.
|
4918
4987
|
type:
|
@@ -5338,7 +5407,7 @@ definitions:
|
|
5338
5407
|
- integer
|
5339
5408
|
currency:
|
5340
5409
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
5341
|
-
in lowercase. Must be a [supported currency](https://
|
5410
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5342
5411
|
type:
|
5343
5412
|
- string
|
5344
5413
|
id:
|
@@ -5457,7 +5526,7 @@ definitions:
|
|
5457
5526
|
type:
|
5458
5527
|
- string
|
5459
5528
|
currency:
|
5460
|
-
description: Three-letter [ISO code for the currency](https://
|
5529
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/payouts)
|
5461
5530
|
paid out to the bank account.
|
5462
5531
|
type:
|
5463
5532
|
- string
|
@@ -5557,7 +5626,7 @@ definitions:
|
|
5557
5626
|
- string
|
5558
5627
|
currency:
|
5559
5628
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
5560
|
-
in lowercase. Must be a [supported currency](https://
|
5629
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5561
5630
|
type:
|
5562
5631
|
- string
|
5563
5632
|
cvc_check:
|
@@ -5656,10 +5725,15 @@ definitions:
|
|
5656
5725
|
- string
|
5657
5726
|
x-expansionResources:
|
5658
5727
|
oneOf:
|
5659
|
-
- "$ref": "#/definitions/
|
5728
|
+
- "$ref": "#/definitions/card"
|
5729
|
+
created:
|
5730
|
+
description: Time at which the object was created. Measured in seconds since
|
5731
|
+
the Unix epoch.
|
5732
|
+
type:
|
5733
|
+
- integer
|
5660
5734
|
currency:
|
5661
5735
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
5662
|
-
in lowercase. Must be a [supported currency](https://
|
5736
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5663
5737
|
type:
|
5664
5738
|
- string
|
5665
5739
|
id:
|
@@ -5681,6 +5755,7 @@ definitions:
|
|
5681
5755
|
- amount
|
5682
5756
|
- balance_transaction
|
5683
5757
|
- card
|
5758
|
+
- created
|
5684
5759
|
- currency
|
5685
5760
|
- id
|
5686
5761
|
- merchant_data
|
@@ -5719,7 +5794,12 @@ definitions:
|
|
5719
5794
|
- integer
|
5720
5795
|
currency:
|
5721
5796
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
5722
|
-
in lowercase. Must be a [supported currency](https://
|
5797
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5798
|
+
type:
|
5799
|
+
- string
|
5800
|
+
description:
|
5801
|
+
description: An arbitrary string attached to the object. Often useful for
|
5802
|
+
displaying to users.
|
5723
5803
|
type:
|
5724
5804
|
- string
|
5725
5805
|
destination:
|
@@ -5915,9 +5995,9 @@ definitions:
|
|
5915
5995
|
type:
|
5916
5996
|
- object
|
5917
5997
|
migrated_to:
|
5918
|
-
description: 'The ID of the [
|
5998
|
+
description: 'The ID of the [Custom account](/docs/connect/custom-accounts)
|
5919
5999
|
this recipient was migrated to. If set, the recipient can no longer be updated,
|
5920
|
-
nor can transfers be made to it: use the
|
6000
|
+
nor can transfers be made to it: use the Custom account instead.'
|
5921
6001
|
type:
|
5922
6002
|
- string
|
5923
6003
|
x-expansionResources:
|
@@ -5983,7 +6063,7 @@ definitions:
|
|
5983
6063
|
- integer
|
5984
6064
|
currency:
|
5985
6065
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
5986
|
-
in lowercase. Must be a [supported currency](https://
|
6066
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
5987
6067
|
type:
|
5988
6068
|
- string
|
5989
6069
|
date:
|
@@ -6176,7 +6256,7 @@ definitions:
|
|
6176
6256
|
- integer
|
6177
6257
|
currency:
|
6178
6258
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
6179
|
-
in lowercase. Must be a [supported currency](https://
|
6259
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
6180
6260
|
type:
|
6181
6261
|
- string
|
6182
6262
|
id:
|
@@ -6200,7 +6280,6 @@ definitions:
|
|
6200
6280
|
- string
|
6201
6281
|
x-expansionResources:
|
6202
6282
|
oneOf:
|
6203
|
-
- "$ref": "#/definitions/legacy_transfer"
|
6204
6283
|
- "$ref": "#/definitions/transfer"
|
6205
6284
|
required:
|
6206
6285
|
- amount
|
@@ -6294,7 +6373,7 @@ definitions:
|
|
6294
6373
|
- boolean
|
6295
6374
|
currency:
|
6296
6375
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
6297
|
-
in lowercase. Must be a [supported currency](https://
|
6376
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
6298
6377
|
type:
|
6299
6378
|
- string
|
6300
6379
|
customer:
|
@@ -6492,7 +6571,7 @@ info:
|
|
6492
6571
|
details.
|
6493
6572
|
termsOfService: https://stripe.com/us/terms/
|
6494
6573
|
title: Stripe API
|
6495
|
-
version: '2017-
|
6574
|
+
version: '2017-06-05'
|
6496
6575
|
paths:
|
6497
6576
|
"/v1/3d_secure":
|
6498
6577
|
post:
|
@@ -6519,7 +6598,7 @@ paths:
|
|
6519
6598
|
- string
|
6520
6599
|
currency:
|
6521
6600
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
6522
|
-
in lowercase. Must be a [supported currency](https://
|
6601
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
6523
6602
|
title: currency
|
6524
6603
|
type:
|
6525
6604
|
- string
|
@@ -6582,11 +6661,11 @@ paths:
|
|
6582
6661
|
"$ref": "#/definitions/error"
|
6583
6662
|
"/v1/account":
|
6584
6663
|
delete:
|
6585
|
-
description: <p>With <a href="/docs/connect">Connect</a>, you may delete
|
6586
|
-
accounts you manage.</p><p>
|
6587
|
-
be deleted at any time.
|
6588
|
-
|
6589
|
-
|
6664
|
+
description: <p>With <a href="/docs/connect">Connect</a>, you may delete Custom
|
6665
|
+
accounts you manage.</p><p>Custom accounts created using test-mode keys can
|
6666
|
+
be deleted at any time. Custom accounts created using live-mode keys may only
|
6667
|
+
be deleted once all balances are zero.</p><p>If you are looking to close your
|
6668
|
+
own account, use the <a href="https://dashboard.stripe.com/account/data">data
|
6590
6669
|
tab in your account settings</a> instead.</p>
|
6591
6670
|
operationId: AccountDelete
|
6592
6671
|
parameters:
|
@@ -6647,10 +6726,9 @@ paths:
|
|
6647
6726
|
post:
|
6648
6727
|
description: <p>Updates an account by setting the values of the parameters passed.
|
6649
6728
|
Any parameters not provided will be left unchanged.</p><p><strong>You may
|
6650
|
-
only update
|
6651
|
-
To update your own account, you can currently
|
6652
|
-
|
6653
|
-
guide</a>.</p>
|
6729
|
+
only update <a href="/docs/connect/updating-accounts">Custom and Express accounts
|
6730
|
+
that you manage</a></strong>. To update your own account, you can currently
|
6731
|
+
only do so via the <a href="https://dashboard.stripe.com/account">dashboard</a>.</p>
|
6654
6732
|
operationId: AccountUpdate
|
6655
6733
|
parameters:
|
6656
6734
|
- description: Body parameters for the request.
|
@@ -6684,7 +6762,7 @@ paths:
|
|
6684
6762
|
debit_negative_balances:
|
6685
6763
|
description: A boolean for whether or not Stripe should try to reclaim
|
6686
6764
|
negative balances from the account holder's bank account. See our
|
6687
|
-
[
|
6765
|
+
[Connect account bank transfer guide](/docs/connect/account-balances)
|
6688
6766
|
for more information.
|
6689
6767
|
title: debit_negative_balances
|
6690
6768
|
type:
|
@@ -6698,14 +6776,14 @@ paths:
|
|
6698
6776
|
default_currency:
|
6699
6777
|
description: Three-letter ISO currency code representing the default
|
6700
6778
|
currency for the account. This must be a currency that [Stripe supports
|
6701
|
-
in the account's country](https://
|
6779
|
+
in the account's country](https://stripe.com/docs/payouts).
|
6702
6780
|
title: default_currency
|
6703
6781
|
type:
|
6704
6782
|
- string
|
6705
6783
|
email:
|
6706
|
-
description: 'Email address of the account holder. For
|
6784
|
+
description: 'Email address of the account holder. For Standard accounts,
|
6707
6785
|
this is used to email them asking them to claim their Stripe account.
|
6708
|
-
For
|
6786
|
+
For Custom accounts, this is only to make the account easier to identify
|
6709
6787
|
to you: Stripe will not email the account holder.'
|
6710
6788
|
title: email
|
6711
6789
|
type:
|
@@ -6749,7 +6827,7 @@ paths:
|
|
6749
6827
|
payout_schedule:
|
6750
6828
|
description: Details on when this account will make funds from charges
|
6751
6829
|
available, and when they will be paid out to the account holder's
|
6752
|
-
bank account. See our [
|
6830
|
+
bank account. See our [Connect account bank transfer guide](/docs/connect/bank-transfers#payout-information)
|
6753
6831
|
for more information.
|
6754
6832
|
title: payout_schedule
|
6755
6833
|
type:
|
@@ -6794,7 +6872,7 @@ paths:
|
|
6794
6872
|
- string
|
6795
6873
|
tos_acceptance:
|
6796
6874
|
description: Details on who accepted the Stripe terms of service, and
|
6797
|
-
when they accepted it. See our [updating
|
6875
|
+
when they accepted it. See our [updating accounts guide](/docs/connect/updating-accounts#tos-acceptance)
|
6798
6876
|
for more information.
|
6799
6877
|
title: tos_acceptance
|
6800
6878
|
type:
|
@@ -6917,9 +6995,11 @@ paths:
|
|
6917
6995
|
schema:
|
6918
6996
|
"$ref": "#/definitions/error"
|
6919
6997
|
post:
|
6920
|
-
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/
|
6921
|
-
|
6922
|
-
bank account details are not editable by design.</p>
|
6998
|
+
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom
|
6999
|
+
account</a>, and optionally sets it as the default for its currency. Other
|
7000
|
+
bank account details are not editable by design.</p><p>You can re-enable a
|
7001
|
+
disabled bank account by performing an update call without providing any arguments
|
7002
|
+
or changes.</p>
|
6923
7003
|
operationId: UpdateAccountBankAccount
|
6924
7004
|
parameters:
|
6925
7005
|
- description: The ID of the bank account to be updated.
|
@@ -6973,7 +7053,7 @@ paths:
|
|
6973
7053
|
required: false
|
6974
7054
|
type: string
|
6975
7055
|
- description: A limit on the number of objects to be returned. Limit can range
|
6976
|
-
between 1 and 100 items.
|
7056
|
+
between 1 and 100 items, and the default is 10 items.
|
6977
7057
|
in: query
|
6978
7058
|
name: limit
|
6979
7059
|
required: false
|
@@ -7149,9 +7229,11 @@ paths:
|
|
7149
7229
|
schema:
|
7150
7230
|
"$ref": "#/definitions/error"
|
7151
7231
|
post:
|
7152
|
-
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/
|
7153
|
-
|
7154
|
-
bank account details are not editable by design.</p>
|
7232
|
+
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom
|
7233
|
+
account</a>, and optionally sets it as the default for its currency. Other
|
7234
|
+
bank account details are not editable by design.</p><p>You can re-enable a
|
7235
|
+
disabled bank account by performing an update call without providing any arguments
|
7236
|
+
or changes.</p>
|
7155
7237
|
operationId: UpdateAccountBankAccount
|
7156
7238
|
parameters:
|
7157
7239
|
- description: The ID of the bank account to be updated.
|
@@ -7196,7 +7278,10 @@ paths:
|
|
7196
7278
|
"$ref": "#/definitions/error"
|
7197
7279
|
"/v1/account/login_links":
|
7198
7280
|
post:
|
7199
|
-
description:
|
7281
|
+
description: <p>Creates a single-use login link for an Express account to access
|
7282
|
+
their Stripe dashboard.</p><p><strong>You may only create login links for
|
7283
|
+
<a href="/docs/connect/express-accounts">Express accounts</a> connected to
|
7284
|
+
your platform</strong>.</p>
|
7200
7285
|
operationId: LoginLinkCreate
|
7201
7286
|
parameters:
|
7202
7287
|
- description: Body parameters for the request.
|
@@ -7219,16 +7304,6 @@ paths:
|
|
7219
7304
|
type:
|
7220
7305
|
- array
|
7221
7306
|
- string
|
7222
|
-
id:
|
7223
|
-
description: ''
|
7224
|
-
title: id
|
7225
|
-
type:
|
7226
|
-
- string
|
7227
|
-
percent_off:
|
7228
|
-
description: ''
|
7229
|
-
title: percent_off
|
7230
|
-
type:
|
7231
|
-
- integer
|
7232
7307
|
required:
|
7233
7308
|
- account
|
7234
7309
|
responses:
|
@@ -7253,7 +7328,7 @@ paths:
|
|
7253
7328
|
required: false
|
7254
7329
|
type: string
|
7255
7330
|
- description: A limit on the number of objects to be returned. Limit can range
|
7256
|
-
between 1 and 100 items.
|
7331
|
+
between 1 and 100 items, and the default is 10 items.
|
7257
7332
|
in: query
|
7258
7333
|
name: limit
|
7259
7334
|
required: false
|
@@ -7328,7 +7403,7 @@ paths:
|
|
7328
7403
|
- description: Body parameters for the request.
|
7329
7404
|
in: body
|
7330
7405
|
name: payload
|
7331
|
-
required:
|
7406
|
+
required: true
|
7332
7407
|
schema:
|
7333
7408
|
properties:
|
7334
7409
|
business_logo:
|
@@ -7361,7 +7436,7 @@ paths:
|
|
7361
7436
|
debit_negative_balances:
|
7362
7437
|
description: A boolean for whether or not Stripe should try to reclaim
|
7363
7438
|
negative balances from the account holder's bank account. See our
|
7364
|
-
[
|
7439
|
+
[Connect account bank transfer guide](/docs/connect/account-balances)
|
7365
7440
|
for more information.
|
7366
7441
|
title: debit_negative_balances
|
7367
7442
|
type:
|
@@ -7375,14 +7450,14 @@ paths:
|
|
7375
7450
|
default_currency:
|
7376
7451
|
description: Three-letter ISO currency code representing the default
|
7377
7452
|
currency for the account. This must be a currency that [Stripe supports
|
7378
|
-
in the account's country](https://
|
7453
|
+
in the account's country](https://stripe.com/docs/payouts).
|
7379
7454
|
title: default_currency
|
7380
7455
|
type:
|
7381
7456
|
- string
|
7382
7457
|
email:
|
7383
|
-
description: 'Email address of the account holder. For
|
7458
|
+
description: 'Email address of the account holder. For Standard accounts,
|
7384
7459
|
this is used to email them asking them to claim their Stripe account.
|
7385
|
-
For
|
7460
|
+
For Custom accounts, this is only to make the account easier to identify
|
7386
7461
|
to you: Stripe will not email the account holder.'
|
7387
7462
|
title: email
|
7388
7463
|
type:
|
@@ -7416,11 +7491,6 @@ paths:
|
|
7416
7491
|
title: legal_entity
|
7417
7492
|
type:
|
7418
7493
|
- object
|
7419
|
-
managed:
|
7420
|
-
description: ''
|
7421
|
-
title: managed
|
7422
|
-
type:
|
7423
|
-
- boolean
|
7424
7494
|
metadata:
|
7425
7495
|
description: A set of key/value pairs that you can attach to an account
|
7426
7496
|
object. It can be useful for storing additional information about
|
@@ -7431,7 +7501,7 @@ paths:
|
|
7431
7501
|
payout_schedule:
|
7432
7502
|
description: Details on when this account will make funds from charges
|
7433
7503
|
available, and when they will be paid out to the account holder's
|
7434
|
-
bank account. See our [
|
7504
|
+
bank account. See our [Connect account bank transfer guide](/docs/connect/bank-transfers#payout-information)
|
7435
7505
|
for more information.
|
7436
7506
|
title: payout_schedule
|
7437
7507
|
type:
|
@@ -7476,11 +7546,18 @@ paths:
|
|
7476
7546
|
- string
|
7477
7547
|
tos_acceptance:
|
7478
7548
|
description: Details on who accepted the Stripe terms of service, and
|
7479
|
-
when they accepted it. See our [updating
|
7549
|
+
when they accepted it. See our [updating accounts guide](/docs/connect/updating-accounts#tos-acceptance)
|
7480
7550
|
for more information.
|
7481
7551
|
title: tos_acceptance
|
7482
7552
|
type:
|
7483
7553
|
- object
|
7554
|
+
type:
|
7555
|
+
description: ''
|
7556
|
+
title: type
|
7557
|
+
type:
|
7558
|
+
- string
|
7559
|
+
required:
|
7560
|
+
- type
|
7484
7561
|
responses:
|
7485
7562
|
'200':
|
7486
7563
|
description: Successful response.
|
@@ -7492,11 +7569,11 @@ paths:
|
|
7492
7569
|
"$ref": "#/definitions/error"
|
7493
7570
|
"/v1/accounts/{account}":
|
7494
7571
|
delete:
|
7495
|
-
description: <p>With <a href="/docs/connect">Connect</a>, you may delete
|
7496
|
-
accounts you manage.</p><p>
|
7497
|
-
be deleted at any time.
|
7498
|
-
|
7499
|
-
|
7572
|
+
description: <p>With <a href="/docs/connect">Connect</a>, you may delete Custom
|
7573
|
+
accounts you manage.</p><p>Custom accounts created using test-mode keys can
|
7574
|
+
be deleted at any time. Custom accounts created using live-mode keys may only
|
7575
|
+
be deleted once all balances are zero.</p><p>If you are looking to close your
|
7576
|
+
own account, use the <a href="https://dashboard.stripe.com/account/data">data
|
7500
7577
|
tab in your account settings</a> instead.</p>
|
7501
7578
|
operationId: AccountDelete
|
7502
7579
|
parameters:
|
@@ -7557,10 +7634,9 @@ paths:
|
|
7557
7634
|
post:
|
7558
7635
|
description: <p>Updates an account by setting the values of the parameters passed.
|
7559
7636
|
Any parameters not provided will be left unchanged.</p><p><strong>You may
|
7560
|
-
only update
|
7561
|
-
To update your own account, you can currently
|
7562
|
-
|
7563
|
-
guide</a>.</p>
|
7637
|
+
only update <a href="/docs/connect/updating-accounts">Custom and Express accounts
|
7638
|
+
that you manage</a></strong>. To update your own account, you can currently
|
7639
|
+
only do so via the <a href="https://dashboard.stripe.com/account">dashboard</a>.</p>
|
7564
7640
|
operationId: AccountUpdate
|
7565
7641
|
parameters:
|
7566
7642
|
- description: Body parameters for the request.
|
@@ -7594,7 +7670,7 @@ paths:
|
|
7594
7670
|
debit_negative_balances:
|
7595
7671
|
description: A boolean for whether or not Stripe should try to reclaim
|
7596
7672
|
negative balances from the account holder's bank account. See our
|
7597
|
-
[
|
7673
|
+
[Connect account bank transfer guide](/docs/connect/account-balances)
|
7598
7674
|
for more information.
|
7599
7675
|
title: debit_negative_balances
|
7600
7676
|
type:
|
@@ -7608,14 +7684,14 @@ paths:
|
|
7608
7684
|
default_currency:
|
7609
7685
|
description: Three-letter ISO currency code representing the default
|
7610
7686
|
currency for the account. This must be a currency that [Stripe supports
|
7611
|
-
in the account's country](https://
|
7687
|
+
in the account's country](https://stripe.com/docs/payouts).
|
7612
7688
|
title: default_currency
|
7613
7689
|
type:
|
7614
7690
|
- string
|
7615
7691
|
email:
|
7616
|
-
description: 'Email address of the account holder. For
|
7692
|
+
description: 'Email address of the account holder. For Standard accounts,
|
7617
7693
|
this is used to email them asking them to claim their Stripe account.
|
7618
|
-
For
|
7694
|
+
For Custom accounts, this is only to make the account easier to identify
|
7619
7695
|
to you: Stripe will not email the account holder.'
|
7620
7696
|
title: email
|
7621
7697
|
type:
|
@@ -7659,7 +7735,7 @@ paths:
|
|
7659
7735
|
payout_schedule:
|
7660
7736
|
description: Details on when this account will make funds from charges
|
7661
7737
|
available, and when they will be paid out to the account holder's
|
7662
|
-
bank account. See our [
|
7738
|
+
bank account. See our [Connect account bank transfer guide](/docs/connect/bank-transfers#payout-information)
|
7663
7739
|
for more information.
|
7664
7740
|
title: payout_schedule
|
7665
7741
|
type:
|
@@ -7704,7 +7780,7 @@ paths:
|
|
7704
7780
|
- string
|
7705
7781
|
tos_acceptance:
|
7706
7782
|
description: Details on who accepted the Stripe terms of service, and
|
7707
|
-
when they accepted it. See our [updating
|
7783
|
+
when they accepted it. See our [updating accounts guide](/docs/connect/updating-accounts#tos-acceptance)
|
7708
7784
|
for more information.
|
7709
7785
|
title: tos_acceptance
|
7710
7786
|
type:
|
@@ -7827,9 +7903,11 @@ paths:
|
|
7827
7903
|
schema:
|
7828
7904
|
"$ref": "#/definitions/error"
|
7829
7905
|
post:
|
7830
|
-
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/
|
7831
|
-
|
7832
|
-
bank account details are not editable by design.</p>
|
7906
|
+
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom
|
7907
|
+
account</a>, and optionally sets it as the default for its currency. Other
|
7908
|
+
bank account details are not editable by design.</p><p>You can re-enable a
|
7909
|
+
disabled bank account by performing an update call without providing any arguments
|
7910
|
+
or changes.</p>
|
7833
7911
|
operationId: UpdateAccountBankAccount
|
7834
7912
|
parameters:
|
7835
7913
|
- description: The ID of the bank account to be updated.
|
@@ -7883,7 +7961,7 @@ paths:
|
|
7883
7961
|
required: false
|
7884
7962
|
type: string
|
7885
7963
|
- description: A limit on the number of objects to be returned. Limit can range
|
7886
|
-
between 1 and 100 items.
|
7964
|
+
between 1 and 100 items, and the default is 10 items.
|
7887
7965
|
in: query
|
7888
7966
|
name: limit
|
7889
7967
|
required: false
|
@@ -8059,9 +8137,11 @@ paths:
|
|
8059
8137
|
schema:
|
8060
8138
|
"$ref": "#/definitions/error"
|
8061
8139
|
post:
|
8062
|
-
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/
|
8063
|
-
|
8064
|
-
bank account details are not editable by design.</p>
|
8140
|
+
description: <p>Updates the metadata of a bank account belonging to a <a href="/docs/connect/custom-accounts">Custom
|
8141
|
+
account</a>, and optionally sets it as the default for its currency. Other
|
8142
|
+
bank account details are not editable by design.</p><p>You can re-enable a
|
8143
|
+
disabled bank account by performing an update call without providing any arguments
|
8144
|
+
or changes.</p>
|
8065
8145
|
operationId: UpdateAccountBankAccount
|
8066
8146
|
parameters:
|
8067
8147
|
- description: The ID of the bank account to be updated.
|
@@ -8106,7 +8186,10 @@ paths:
|
|
8106
8186
|
"$ref": "#/definitions/error"
|
8107
8187
|
"/v1/accounts/{account}/login_links":
|
8108
8188
|
post:
|
8109
|
-
description:
|
8189
|
+
description: <p>Creates a single-use login link for an Express account to access
|
8190
|
+
their Stripe dashboard.</p><p><strong>You may only create login links for
|
8191
|
+
<a href="/docs/connect/express-accounts">Express accounts</a> connected to
|
8192
|
+
your platform</strong>.</p>
|
8110
8193
|
operationId: LoginLinkCreate
|
8111
8194
|
parameters:
|
8112
8195
|
- description: The identifier of the account to create a login link for.
|
@@ -8129,16 +8212,6 @@ paths:
|
|
8129
8212
|
type:
|
8130
8213
|
- array
|
8131
8214
|
- string
|
8132
|
-
id:
|
8133
|
-
description: ''
|
8134
|
-
title: id
|
8135
|
-
type:
|
8136
|
-
- string
|
8137
|
-
percent_off:
|
8138
|
-
description: ''
|
8139
|
-
title: percent_off
|
8140
|
-
type:
|
8141
|
-
- integer
|
8142
8215
|
responses:
|
8143
8216
|
'200':
|
8144
8217
|
description: Successful response.
|
@@ -8150,10 +8223,10 @@ paths:
|
|
8150
8223
|
"$ref": "#/definitions/error"
|
8151
8224
|
"/v1/accounts/{account}/reject":
|
8152
8225
|
post:
|
8153
|
-
description: <p>With <a href="/docs/connect">Connect</a>, you may flag
|
8154
|
-
|
8155
|
-
|
8156
|
-
|
8226
|
+
description: <p>With <a href="/docs/connect">Connect</a>, you may flag accounts
|
8227
|
+
as suspicious.</p><p>Test-mode Custom and Express accounts can be rejected
|
8228
|
+
at any time. Accounts created using live-mode keys may only be rejected once
|
8229
|
+
all balances are zero.</p>
|
8157
8230
|
operationId: AccountReject
|
8158
8231
|
parameters:
|
8159
8232
|
- description: The identifier of the account to be rejected.
|
@@ -8204,7 +8277,7 @@ paths:
|
|
8204
8277
|
required: false
|
8205
8278
|
type: string
|
8206
8279
|
- description: A limit on the number of objects to be returned. Limit can range
|
8207
|
-
between 1 and 100 items.
|
8280
|
+
between 1 and 100 items, and the default is 10 items.
|
8208
8281
|
in: query
|
8209
8282
|
name: limit
|
8210
8283
|
required: false
|
@@ -8383,7 +8456,7 @@ paths:
|
|
8383
8456
|
required: false
|
8384
8457
|
type: string
|
8385
8458
|
- description: A limit on the number of objects to be returned. Limit can range
|
8386
|
-
between 1 and 100 items.
|
8459
|
+
between 1 and 100 items, and the default is 10 items.
|
8387
8460
|
in: query
|
8388
8461
|
name: limit
|
8389
8462
|
required: false
|
@@ -8615,7 +8688,7 @@ paths:
|
|
8615
8688
|
required: false
|
8616
8689
|
type: string
|
8617
8690
|
- description: A limit on the number of objects to be returned. Limit can range
|
8618
|
-
between 1 and 100 items.
|
8691
|
+
between 1 and 100 items, and the default is 10 items.
|
8619
8692
|
in: query
|
8620
8693
|
name: limit
|
8621
8694
|
required: false
|
@@ -8769,7 +8842,7 @@ paths:
|
|
8769
8842
|
required: false
|
8770
8843
|
type: string
|
8771
8844
|
- description: A limit on the number of objects to be returned. Limit can range
|
8772
|
-
between 1 and 100 items.
|
8845
|
+
between 1 and 100 items, and the default is 10 items.
|
8773
8846
|
in: query
|
8774
8847
|
name: limit
|
8775
8848
|
required: false
|
@@ -8899,7 +8972,7 @@ paths:
|
|
8899
8972
|
"/v1/bitcoin/payments":
|
8900
8973
|
get:
|
8901
8974
|
description: ''
|
8902
|
-
operationId:
|
8975
|
+
operationId: AllBitcoinPayments
|
8903
8976
|
parameters:
|
8904
8977
|
- description: Specifies which fields in the response should be expanded.
|
8905
8978
|
in: query
|
@@ -8907,7 +8980,7 @@ paths:
|
|
8907
8980
|
required: false
|
8908
8981
|
type: string
|
8909
8982
|
- description: A limit on the number of objects to be returned. Limit can range
|
8910
|
-
between 1 and 100 items.
|
8983
|
+
between 1 and 100 items, and the default is 10 items.
|
8911
8984
|
in: query
|
8912
8985
|
name: limit
|
8913
8986
|
required: false
|
@@ -9125,6 +9198,11 @@ paths:
|
|
9125
9198
|
title: source
|
9126
9199
|
type:
|
9127
9200
|
- string
|
9201
|
+
statement_address:
|
9202
|
+
description: ''
|
9203
|
+
title: statement_address
|
9204
|
+
type:
|
9205
|
+
- object
|
9128
9206
|
statement_descriptor:
|
9129
9207
|
description: ''
|
9130
9208
|
title: statement_descriptor
|
@@ -9244,7 +9322,7 @@ paths:
|
|
9244
9322
|
"/v1/bitcoin/payments/{id}":
|
9245
9323
|
get:
|
9246
9324
|
description: ''
|
9247
|
-
operationId:
|
9325
|
+
operationId: RetrieveBitcoinPayment
|
9248
9326
|
parameters:
|
9249
9327
|
- description: Specifies which fields in the response should be expanded.
|
9250
9328
|
in: query
|
@@ -9277,7 +9355,7 @@ paths:
|
|
9277
9355
|
required: false
|
9278
9356
|
type: string
|
9279
9357
|
- description: A limit on the number of objects to be returned. Limit can range
|
9280
|
-
between 1 and 100 items.
|
9358
|
+
between 1 and 100 items, and the default is 10 items.
|
9281
9359
|
in: query
|
9282
9360
|
name: limit
|
9283
9361
|
required: false
|
@@ -9378,7 +9456,7 @@ paths:
|
|
9378
9456
|
type:
|
9379
9457
|
- integer
|
9380
9458
|
currency:
|
9381
|
-
description: Three-letter [ISO code for the currency](https://
|
9459
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
9382
9460
|
to which the bitcoin will be converted. You will be paid out in this
|
9383
9461
|
currency. Only USD is currently supported.
|
9384
9462
|
title: currency
|
@@ -9590,7 +9668,7 @@ paths:
|
|
9590
9668
|
required: false
|
9591
9669
|
type: string
|
9592
9670
|
- description: A limit on the number of objects to be returned. Limit can range
|
9593
|
-
between 1 and 100 items.
|
9671
|
+
between 1 and 100 items, and the default is 10 items.
|
9594
9672
|
in: query
|
9595
9673
|
name: limit
|
9596
9674
|
required: false
|
@@ -9680,7 +9758,7 @@ paths:
|
|
9680
9758
|
required: false
|
9681
9759
|
type: string
|
9682
9760
|
- description: A limit on the number of objects to be returned. Limit can range
|
9683
|
-
between 1 and 100 items.
|
9761
|
+
between 1 and 100 items, and the default is 10 items.
|
9684
9762
|
in: query
|
9685
9763
|
name: limit
|
9686
9764
|
required: false
|
@@ -9795,7 +9873,7 @@ paths:
|
|
9795
9873
|
required: false
|
9796
9874
|
type: string
|
9797
9875
|
- description: A limit on the number of objects to be returned. Limit can range
|
9798
|
-
between 1 and 100 items.
|
9876
|
+
between 1 and 100 items, and the default is 10 items.
|
9799
9877
|
in: query
|
9800
9878
|
name: limit
|
9801
9879
|
required: false
|
@@ -10300,6 +10378,14 @@ paths:
|
|
10300
10378
|
title: metadata
|
10301
10379
|
type:
|
10302
10380
|
- object
|
10381
|
+
submit:
|
10382
|
+
description: Whether or not to immediately submit evidence to the bank.
|
10383
|
+
If `false`, evidence is staged on the dispute. Staged evidence is
|
10384
|
+
visible in the API and Dashboard, and can be submitted to the bank
|
10385
|
+
by making another request with this attribute set to `true` (the default).
|
10386
|
+
title: submit
|
10387
|
+
type:
|
10388
|
+
- boolean
|
10303
10389
|
responses:
|
10304
10390
|
'200':
|
10305
10391
|
description: Successful response.
|
@@ -10432,7 +10518,7 @@ paths:
|
|
10432
10518
|
required: false
|
10433
10519
|
type: string
|
10434
10520
|
- description: A limit on the number of objects to be returned. Limit can range
|
10435
|
-
between 1 and 100 items.
|
10521
|
+
between 1 and 100 items, and the default is 10 items.
|
10436
10522
|
in: query
|
10437
10523
|
name: limit
|
10438
10524
|
required: false
|
@@ -10647,7 +10733,7 @@ paths:
|
|
10647
10733
|
required: false
|
10648
10734
|
type: string
|
10649
10735
|
- description: A limit on the number of objects to be returned. Limit can range
|
10650
|
-
between 1 and 100 items.
|
10736
|
+
between 1 and 100 items, and the default is 10 items.
|
10651
10737
|
in: query
|
10652
10738
|
name: limit
|
10653
10739
|
required: false
|
@@ -10751,7 +10837,7 @@ paths:
|
|
10751
10837
|
required: false
|
10752
10838
|
type: string
|
10753
10839
|
- description: A limit on the number of objects to be returned. Limit can range
|
10754
|
-
between 1 and 100 items.
|
10840
|
+
between 1 and 100 items, and the default is 10 items.
|
10755
10841
|
in: query
|
10756
10842
|
name: limit
|
10757
10843
|
required: false
|
@@ -10853,7 +10939,7 @@ paths:
|
|
10853
10939
|
type:
|
10854
10940
|
- integer
|
10855
10941
|
currency:
|
10856
|
-
description: Three-letter [ISO code for the currency](https://
|
10942
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
10857
10943
|
of the `amount_off` parameter (required if `amount_off` is passed).
|
10858
10944
|
title: currency
|
10859
10945
|
type:
|
@@ -11041,7 +11127,7 @@ paths:
|
|
11041
11127
|
required: false
|
11042
11128
|
type: string
|
11043
11129
|
- description: A limit on the number of objects to be returned. Limit can range
|
11044
|
-
between 1 and 100 items.
|
11130
|
+
between 1 and 100 items, and the default is 10 items.
|
11045
11131
|
in: query
|
11046
11132
|
name: limit
|
11047
11133
|
required: false
|
@@ -11146,6 +11232,11 @@ paths:
|
|
11146
11232
|
title: coupon
|
11147
11233
|
type:
|
11148
11234
|
- string
|
11235
|
+
default_source:
|
11236
|
+
description: ''
|
11237
|
+
title: default_source
|
11238
|
+
type:
|
11239
|
+
- string
|
11149
11240
|
description:
|
11150
11241
|
description: An arbitrary string that you can attach to a customer object.
|
11151
11242
|
It is displayed alongside the customer in the dashboard.
|
@@ -11180,9 +11271,10 @@ paths:
|
|
11180
11271
|
type:
|
11181
11272
|
- object
|
11182
11273
|
source:
|
11183
|
-
description: The source can either be a
|
11184
|
-
|
11185
|
-
credit card details (with the
|
11274
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
11275
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](/docs/elements),
|
11276
|
+
or a dictionary containing a user's credit card details (with the
|
11277
|
+
options shown below).
|
11186
11278
|
title: source
|
11187
11279
|
type:
|
11188
11280
|
- object
|
@@ -11292,6 +11384,11 @@ paths:
|
|
11292
11384
|
title: coupon
|
11293
11385
|
type:
|
11294
11386
|
- string
|
11387
|
+
default_source:
|
11388
|
+
description: ''
|
11389
|
+
title: default_source
|
11390
|
+
type:
|
11391
|
+
- string
|
11295
11392
|
description:
|
11296
11393
|
description: An arbitrary string that you can attach to a customer object.
|
11297
11394
|
It is displayed alongside the customer in the dashboard.
|
@@ -11326,9 +11423,10 @@ paths:
|
|
11326
11423
|
type:
|
11327
11424
|
- object
|
11328
11425
|
source:
|
11329
|
-
description: The source can either be a
|
11330
|
-
|
11331
|
-
credit card details (with the
|
11426
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
11427
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](/docs/elements),
|
11428
|
+
or a dictionary containing a user's credit card details (with the
|
11429
|
+
options shown below).
|
11332
11430
|
title: source
|
11333
11431
|
type:
|
11334
11432
|
- object
|
@@ -11353,7 +11451,7 @@ paths:
|
|
11353
11451
|
required: false
|
11354
11452
|
type: string
|
11355
11453
|
- description: A limit on the number of objects to be returned. Limit can range
|
11356
|
-
between 1 and 100 items.
|
11454
|
+
between 1 and 100 items, and the default is 10 items.
|
11357
11455
|
in: query
|
11358
11456
|
name: limit
|
11359
11457
|
required: false
|
@@ -11540,7 +11638,7 @@ paths:
|
|
11540
11638
|
required: false
|
11541
11639
|
type: string
|
11542
11640
|
- description: A limit on the number of objects to be returned. Limit can range
|
11543
|
-
between 1 and 100 items.
|
11641
|
+
between 1 and 100 items, and the default is 10 items.
|
11544
11642
|
in: query
|
11545
11643
|
name: limit
|
11546
11644
|
required: false
|
@@ -11863,7 +11961,7 @@ paths:
|
|
11863
11961
|
required: false
|
11864
11962
|
type: string
|
11865
11963
|
- description: A limit on the number of objects to be returned. Limit can range
|
11866
|
-
between 1 and 100 items.
|
11964
|
+
between 1 and 100 items, and the default is 10 items.
|
11867
11965
|
in: query
|
11868
11966
|
name: limit
|
11869
11967
|
required: false
|
@@ -12181,7 +12279,7 @@ paths:
|
|
12181
12279
|
required: false
|
12182
12280
|
type: string
|
12183
12281
|
- description: A limit on the number of objects to be returned. Limit can range
|
12184
|
-
between 1 and 100 items.
|
12282
|
+
between 1 and 100 items, and the default is 10 items.
|
12185
12283
|
in: query
|
12186
12284
|
name: limit
|
12187
12285
|
required: false
|
@@ -12506,7 +12604,7 @@ paths:
|
|
12506
12604
|
required: false
|
12507
12605
|
type: string
|
12508
12606
|
- description: A limit on the number of objects to be returned. Limit can range
|
12509
|
-
between 1 and 100 items.
|
12607
|
+
between 1 and 100 items, and the default is 10 items.
|
12510
12608
|
in: query
|
12511
12609
|
name: limit
|
12512
12610
|
required: false
|
@@ -12651,15 +12749,15 @@ paths:
|
|
12651
12749
|
type:
|
12652
12750
|
- integer
|
12653
12751
|
source:
|
12654
|
-
description: The source can either be a
|
12655
|
-
by [Elements](https://stripe.com/docs/elements),
|
12656
|
-
a user's credit card details (with the
|
12657
|
-
provide a source if the customer does
|
12658
|
-
attached, and you are subscribing
|
12659
|
-
not free. Passing `source` will create
|
12660
|
-
|
12661
|
-
one exists. If you want to add an additional
|
12662
|
-
instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
12752
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
12753
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements),
|
12754
|
+
or a dictionary containing a user's credit card details (with the
|
12755
|
+
options shown below). You must provide a source if the customer does
|
12756
|
+
not already have a valid source attached, and you are subscribing
|
12757
|
+
the customer for a plan that is not free. Passing `source` will create
|
12758
|
+
a new source object, make it the customer default source, and delete
|
12759
|
+
the old customer default if one exists. If you want to add an additional
|
12760
|
+
source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
12663
12761
|
to add the card and then the [customer update API](https://stripe.com/docs/api#update
|
12664
12762
|
customer) to set it as the default. Whenever you attach a card to
|
12665
12763
|
a customer, Stripe will automatically validate the card.
|
@@ -12860,15 +12958,15 @@ paths:
|
|
12860
12958
|
type:
|
12861
12959
|
- integer
|
12862
12960
|
source:
|
12863
|
-
description: The source can either be a
|
12864
|
-
by [Elements](https://stripe.com/docs/elements),
|
12865
|
-
a user's credit card details (with the
|
12866
|
-
provide a source if the customer does
|
12867
|
-
attached, and you are subscribing
|
12868
|
-
not free. Passing `source` will create
|
12869
|
-
|
12870
|
-
one exists. If you want to add an additional
|
12871
|
-
instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
12961
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
12962
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements),
|
12963
|
+
or a dictionary containing a user's credit card details (with the
|
12964
|
+
options shown below). You must provide a source if the customer does
|
12965
|
+
not already have a valid source attached, and you are subscribing
|
12966
|
+
the customer for a plan that is not free. Passing `source` will create
|
12967
|
+
a new source object, make it the customer default source, and delete
|
12968
|
+
the old customer default if one exists. If you want to add an additional
|
12969
|
+
source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
12872
12970
|
to add the card and then the [customer update API](https://stripe.com/docs/api#update
|
12873
12971
|
customer) to set it as the default. Whenever you attach a card to
|
12874
12972
|
a customer, Stripe will automatically validate the card.
|
@@ -12967,7 +13065,7 @@ paths:
|
|
12967
13065
|
required: false
|
12968
13066
|
type: string
|
12969
13067
|
- description: A limit on the number of objects to be returned. Limit can range
|
12970
|
-
between 1 and 100 items.
|
13068
|
+
between 1 and 100 items, and the default is 10 items.
|
12971
13069
|
in: query
|
12972
13070
|
name: limit
|
12973
13071
|
required: false
|
@@ -13107,6 +13205,14 @@ paths:
|
|
13107
13205
|
title: metadata
|
13108
13206
|
type:
|
13109
13207
|
- object
|
13208
|
+
submit:
|
13209
|
+
description: Whether or not to immediately submit evidence to the bank.
|
13210
|
+
If `false`, evidence is staged on the dispute. Staged evidence is
|
13211
|
+
visible in the API and Dashboard, and can be submitted to the bank
|
13212
|
+
by making another request with this attribute set to `true` (the default).
|
13213
|
+
title: submit
|
13214
|
+
type:
|
13215
|
+
- boolean
|
13110
13216
|
responses:
|
13111
13217
|
'200':
|
13112
13218
|
description: Successful response.
|
@@ -13154,6 +13260,77 @@ paths:
|
|
13154
13260
|
description: Error response.
|
13155
13261
|
schema:
|
13156
13262
|
"$ref": "#/definitions/error"
|
13263
|
+
"/v1/ephemeral_keys":
|
13264
|
+
post:
|
13265
|
+
description: "<p>Creates a short-lived API key for a given resource.</p>"
|
13266
|
+
operationId: CreateEphemeralKey
|
13267
|
+
parameters:
|
13268
|
+
- description: Body parameters for the request.
|
13269
|
+
in: body
|
13270
|
+
name: payload
|
13271
|
+
required: true
|
13272
|
+
schema:
|
13273
|
+
properties:
|
13274
|
+
customer:
|
13275
|
+
description: The ID of the Customer you'd like to modify using the resulting
|
13276
|
+
ephemeral key.
|
13277
|
+
title: customer
|
13278
|
+
type:
|
13279
|
+
- string
|
13280
|
+
expand:
|
13281
|
+
description: Specifies which fields in the response should be expanded.
|
13282
|
+
items:
|
13283
|
+
type:
|
13284
|
+
- string
|
13285
|
+
title: expand
|
13286
|
+
type:
|
13287
|
+
- array
|
13288
|
+
- string
|
13289
|
+
required:
|
13290
|
+
- customer
|
13291
|
+
responses:
|
13292
|
+
'200':
|
13293
|
+
description: Successful response.
|
13294
|
+
schema:
|
13295
|
+
"$ref": "#/definitions/ephemeral_key_with_secret"
|
13296
|
+
default:
|
13297
|
+
description: Error response.
|
13298
|
+
schema:
|
13299
|
+
"$ref": "#/definitions/error"
|
13300
|
+
"/v1/ephemeral_keys/{key}":
|
13301
|
+
delete:
|
13302
|
+
description: "<p>Invalidates a short-lived API key for a given resource.</p>"
|
13303
|
+
operationId: DeleteEphemeralKey
|
13304
|
+
parameters:
|
13305
|
+
- description: The ID of the key you'd like to invalidate.
|
13306
|
+
in: path
|
13307
|
+
name: key
|
13308
|
+
required: true
|
13309
|
+
type: string
|
13310
|
+
- description: Body parameters for the request.
|
13311
|
+
in: body
|
13312
|
+
name: payload
|
13313
|
+
required: false
|
13314
|
+
schema:
|
13315
|
+
properties:
|
13316
|
+
expand:
|
13317
|
+
description: Specifies which fields in the response should be expanded.
|
13318
|
+
items:
|
13319
|
+
type:
|
13320
|
+
- string
|
13321
|
+
title: expand
|
13322
|
+
type:
|
13323
|
+
- array
|
13324
|
+
- string
|
13325
|
+
responses:
|
13326
|
+
'200':
|
13327
|
+
description: Successful response.
|
13328
|
+
schema:
|
13329
|
+
"$ref": "#/definitions/ephemeral_key"
|
13330
|
+
default:
|
13331
|
+
description: Error response.
|
13332
|
+
schema:
|
13333
|
+
"$ref": "#/definitions/error"
|
13157
13334
|
"/v1/events":
|
13158
13335
|
get:
|
13159
13336
|
description: "<p>List events, going back up to 30 days.</p>"
|
@@ -13165,7 +13342,7 @@ paths:
|
|
13165
13342
|
required: false
|
13166
13343
|
type: string
|
13167
13344
|
- description: A limit on the number of objects to be returned. Limit can range
|
13168
|
-
between 1 and 100 items.
|
13345
|
+
between 1 and 100 items, and the default is 10 items.
|
13169
13346
|
in: query
|
13170
13347
|
name: limit
|
13171
13348
|
required: false
|
@@ -13206,7 +13383,7 @@ paths:
|
|
13206
13383
|
in: query
|
13207
13384
|
name: created
|
13208
13385
|
required: false
|
13209
|
-
type:
|
13386
|
+
type: string
|
13210
13387
|
responses:
|
13211
13388
|
'200':
|
13212
13389
|
description: Successful response.
|
@@ -13324,7 +13501,7 @@ paths:
|
|
13324
13501
|
required: false
|
13325
13502
|
type: string
|
13326
13503
|
- description: A limit on the number of objects to be returned. Limit can range
|
13327
|
-
between 1 and 100 items.
|
13504
|
+
between 1 and 100 items, and the default is 10 items.
|
13328
13505
|
in: query
|
13329
13506
|
name: limit
|
13330
13507
|
required: false
|
@@ -13423,7 +13600,7 @@ paths:
|
|
13423
13600
|
- integer
|
13424
13601
|
currency:
|
13425
13602
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
13426
|
-
in lowercase. Must be a [supported currency](https://
|
13603
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
13427
13604
|
title: currency
|
13428
13605
|
type:
|
13429
13606
|
- string
|
@@ -13622,7 +13799,7 @@ paths:
|
|
13622
13799
|
required: false
|
13623
13800
|
type: string
|
13624
13801
|
- description: A limit on the number of objects to be returned. Limit can range
|
13625
|
-
between 1 and 100 items.
|
13802
|
+
between 1 and 100 items, and the default is 10 items.
|
13626
13803
|
in: query
|
13627
13804
|
name: limit
|
13628
13805
|
required: false
|
@@ -14033,7 +14210,8 @@ paths:
|
|
14033
14210
|
name: ending_before
|
14034
14211
|
required: false
|
14035
14212
|
type: string
|
14036
|
-
- description: The
|
14213
|
+
- description: The ID of the invoice containing the lines to be retrieved. Use
|
14214
|
+
a value of **upcoming** to retrieve the upcoming invoice.
|
14037
14215
|
in: path
|
14038
14216
|
name: invoice
|
14039
14217
|
required: true
|
@@ -14184,6 +14362,13 @@ paths:
|
|
14184
14362
|
type:
|
14185
14363
|
- array
|
14186
14364
|
- string
|
14365
|
+
source:
|
14366
|
+
description: A payment source to be charged. The source must be the
|
14367
|
+
ID of a source belonging to the customer associated with the invoice
|
14368
|
+
being paid.
|
14369
|
+
title: source
|
14370
|
+
type:
|
14371
|
+
- string
|
14187
14372
|
responses:
|
14188
14373
|
'200':
|
14189
14374
|
description: Successful response.
|
@@ -14215,7 +14400,7 @@ paths:
|
|
14215
14400
|
required: false
|
14216
14401
|
type: integer
|
14217
14402
|
- description: A limit on the number of objects to be returned. Limit can range
|
14218
|
-
between 1 and 100 items.
|
14403
|
+
between 1 and 100 items, and the default is 10 items.
|
14219
14404
|
in: query
|
14220
14405
|
name: limit
|
14221
14406
|
required: false
|
@@ -14321,7 +14506,7 @@ paths:
|
|
14321
14506
|
required: false
|
14322
14507
|
type: string
|
14323
14508
|
- description: A limit on the number of objects to be returned. Limit can range
|
14324
|
-
between 1 and 100 items.
|
14509
|
+
between 1 and 100 items, and the default is 10 items.
|
14325
14510
|
in: query
|
14326
14511
|
name: limit
|
14327
14512
|
required: false
|
@@ -14440,7 +14625,7 @@ paths:
|
|
14440
14625
|
- string
|
14441
14626
|
currency:
|
14442
14627
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
14443
|
-
in lowercase. Must be a [supported currency](https://
|
14628
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
14444
14629
|
title: currency
|
14445
14630
|
type:
|
14446
14631
|
- string
|
@@ -14647,13 +14832,13 @@ paths:
|
|
14647
14832
|
type:
|
14648
14833
|
- string
|
14649
14834
|
source:
|
14650
|
-
description: The source can either be a
|
14651
|
-
|
14652
|
-
credit card details (with the
|
14653
|
-
|
14654
|
-
|
14655
|
-
|
14656
|
-
|
14835
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
14836
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](/docs/elements),
|
14837
|
+
or a dictionary containing a user's credit card details (with the
|
14838
|
+
options shown below). If no customer was attached to the order at
|
14839
|
+
creation, either `source` or `customer is required. Otherwise, the
|
14840
|
+
specified source will be charged intead of the customer attached to
|
14841
|
+
the order.
|
14657
14842
|
title: source
|
14658
14843
|
type:
|
14659
14844
|
- object
|
@@ -14720,7 +14905,7 @@ paths:
|
|
14720
14905
|
required: false
|
14721
14906
|
type: string
|
14722
14907
|
- description: A limit on the number of objects to be returned. Limit can range
|
14723
|
-
between 1 and 100 items.
|
14908
|
+
between 1 and 100 items, and the default is 10 items.
|
14724
14909
|
in: query
|
14725
14910
|
name: limit
|
14726
14911
|
required: false
|
@@ -14943,6 +15128,11 @@ paths:
|
|
14943
15128
|
title: source
|
14944
15129
|
type:
|
14945
15130
|
- string
|
15131
|
+
statement_address:
|
15132
|
+
description: ''
|
15133
|
+
title: statement_address
|
15134
|
+
type:
|
15135
|
+
- object
|
14946
15136
|
statement_descriptor:
|
14947
15137
|
description: ''
|
14948
15138
|
title: statement_descriptor
|
@@ -15022,7 +15212,7 @@ paths:
|
|
15022
15212
|
required: false
|
15023
15213
|
type: string
|
15024
15214
|
- description: A limit on the number of objects to be returned. Limit can range
|
15025
|
-
between 1 and 100 items.
|
15215
|
+
between 1 and 100 items, and the default is 10 items.
|
15026
15216
|
in: query
|
15027
15217
|
name: limit
|
15028
15218
|
required: false
|
@@ -15049,12 +15239,12 @@ paths:
|
|
15049
15239
|
in: query
|
15050
15240
|
name: arrival_date
|
15051
15241
|
required: false
|
15052
|
-
type:
|
15242
|
+
type: string
|
15053
15243
|
- description: ''
|
15054
15244
|
in: query
|
15055
15245
|
name: created
|
15056
15246
|
required: false
|
15057
|
-
type:
|
15247
|
+
type: string
|
15058
15248
|
- description: The ID of an external account - only return payouts sent to this
|
15059
15249
|
external account.
|
15060
15250
|
in: query
|
@@ -15062,7 +15252,7 @@ paths:
|
|
15062
15252
|
required: false
|
15063
15253
|
type: string
|
15064
15254
|
- description: 'Only return payouts that have the given status: `pending`, `paid`,
|
15065
|
-
`failed`,
|
15255
|
+
`failed`, or `canceled`.'
|
15066
15256
|
in: query
|
15067
15257
|
name: status
|
15068
15258
|
required: false
|
@@ -15137,10 +15327,16 @@ paths:
|
|
15137
15327
|
- integer
|
15138
15328
|
currency:
|
15139
15329
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
15140
|
-
in lowercase. Must be a [supported currency](https://
|
15330
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
15141
15331
|
title: currency
|
15142
15332
|
type:
|
15143
15333
|
- string
|
15334
|
+
description:
|
15335
|
+
description: An arbitrary string attached to the object. Often useful
|
15336
|
+
for displaying to users.
|
15337
|
+
title: description
|
15338
|
+
type:
|
15339
|
+
- string
|
15144
15340
|
destination:
|
15145
15341
|
description: The ID of a bank account or a card to send the payout to.
|
15146
15342
|
If no destination is supplied, the default external account for the
|
@@ -15174,8 +15370,8 @@ paths:
|
|
15174
15370
|
source_type:
|
15175
15371
|
description: 'The source balance to draw this payout from. Balances
|
15176
15372
|
for different payment sources are kept separately. You can find the
|
15177
|
-
amounts with the balances API. Valid options are:
|
15178
|
-
|
15373
|
+
amounts with the balances API. Valid options are: **alipay_account**,
|
15374
|
+
**bank_account**, and **card**.'
|
15179
15375
|
title: source_type
|
15180
15376
|
type:
|
15181
15377
|
- string
|
@@ -15316,7 +15512,7 @@ paths:
|
|
15316
15512
|
required: false
|
15317
15513
|
type: string
|
15318
15514
|
- description: A limit on the number of objects to be returned. Limit can range
|
15319
|
-
between 1 and 100 items.
|
15515
|
+
between 1 and 100 items, and the default is 10 items.
|
15320
15516
|
in: query
|
15321
15517
|
name: limit
|
15322
15518
|
required: false
|
@@ -15411,7 +15607,7 @@ paths:
|
|
15411
15607
|
- integer
|
15412
15608
|
currency:
|
15413
15609
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
15414
|
-
in lowercase. Must be a [supported currency](https://
|
15610
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
15415
15611
|
title: currency
|
15416
15612
|
type:
|
15417
15613
|
- string
|
@@ -15657,7 +15853,7 @@ paths:
|
|
15657
15853
|
required: false
|
15658
15854
|
type: string
|
15659
15855
|
- description: A limit on the number of objects to be returned. Limit can range
|
15660
|
-
between 1 and 100 items.
|
15856
|
+
between 1 and 100 items, and the default is 10 items.
|
15661
15857
|
in: query
|
15662
15858
|
name: limit
|
15663
15859
|
required: false
|
@@ -16003,7 +16199,7 @@ paths:
|
|
16003
16199
|
required: false
|
16004
16200
|
type: string
|
16005
16201
|
- description: A limit on the number of objects to be returned. Limit can range
|
16006
|
-
between 1 and 100 items.
|
16202
|
+
between 1 and 100 items, and the default is 10 items.
|
16007
16203
|
in: query
|
16008
16204
|
name: limit
|
16009
16205
|
required: false
|
@@ -16308,7 +16504,7 @@ paths:
|
|
16308
16504
|
required: false
|
16309
16505
|
type: string
|
16310
16506
|
- description: A limit on the number of objects to be returned. Limit can range
|
16311
|
-
between 1 and 100 items.
|
16507
|
+
between 1 and 100 items, and the default is 10 items.
|
16312
16508
|
in: query
|
16313
16509
|
name: limit
|
16314
16510
|
required: false
|
@@ -16574,7 +16770,7 @@ paths:
|
|
16574
16770
|
required: false
|
16575
16771
|
type: string
|
16576
16772
|
- description: A limit on the number of objects to be returned. Limit can range
|
16577
|
-
between 1 and 100 items.
|
16773
|
+
between 1 and 100 items, and the default is 10 items.
|
16578
16774
|
in: query
|
16579
16775
|
name: limit
|
16580
16776
|
required: false
|
@@ -16785,7 +16981,7 @@ paths:
|
|
16785
16981
|
required: false
|
16786
16982
|
type: string
|
16787
16983
|
- description: A limit on the number of objects to be returned. Limit can range
|
16788
|
-
between 1 and 100 items.
|
16984
|
+
between 1 and 100 items, and the default is 10 items.
|
16789
16985
|
in: query
|
16790
16986
|
name: limit
|
16791
16987
|
required: false
|
@@ -16911,7 +17107,7 @@ paths:
|
|
16911
17107
|
- object
|
16912
17108
|
currency:
|
16913
17109
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
16914
|
-
in lowercase. Must be a [supported currency](https://
|
17110
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
16915
17111
|
title: currency
|
16916
17112
|
type:
|
16917
17113
|
- string
|
@@ -16956,7 +17152,7 @@ paths:
|
|
16956
17152
|
price:
|
16957
17153
|
description: The cost of the item as a nonnegative integer in the smallest
|
16958
17154
|
currency unit (that is, 100 cents to charge $1.00, or 100 to charge
|
16959
|
-
¥100, Japanese Yen being a
|
17155
|
+
¥100, Japanese Yen being a zero-decimal currency).
|
16960
17156
|
title: price
|
16961
17157
|
type:
|
16962
17158
|
- integer
|
@@ -17070,7 +17266,7 @@ paths:
|
|
17070
17266
|
- object
|
17071
17267
|
currency:
|
17072
17268
|
description: Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html),
|
17073
|
-
in lowercase. Must be a [supported currency](https://
|
17269
|
+
in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
|
17074
17270
|
title: currency
|
17075
17271
|
type:
|
17076
17272
|
- string
|
@@ -17109,7 +17305,7 @@ paths:
|
|
17109
17305
|
price:
|
17110
17306
|
description: The cost of the item as a positive integer in the smallest
|
17111
17307
|
currency unit (that is, 100 cents to charge $1.00, or 100 to charge
|
17112
|
-
¥100, Japanese Yen being a
|
17308
|
+
¥100, Japanese Yen being a zero-decimal currency).
|
17113
17309
|
title: price
|
17114
17310
|
type:
|
17115
17311
|
- integer
|
@@ -17148,7 +17344,7 @@ paths:
|
|
17148
17344
|
type:
|
17149
17345
|
- integer
|
17150
17346
|
currency:
|
17151
|
-
description: Three-letter [ISO code for the currency](https://
|
17347
|
+
description: Three-letter [ISO code for the currency](https://stripe.com/docs/currencies)
|
17152
17348
|
associated with the source. This is the currency for which the source
|
17153
17349
|
will be chargeable once ready.
|
17154
17350
|
title: currency
|
@@ -17346,7 +17542,7 @@ paths:
|
|
17346
17542
|
required: false
|
17347
17543
|
type: string
|
17348
17544
|
- description: A limit on the number of objects to be returned. Limit can range
|
17349
|
-
between 1 and 100 items.
|
17545
|
+
between 1 and 100 items, and the default is 10 items.
|
17350
17546
|
in: query
|
17351
17547
|
name: limit
|
17352
17548
|
required: false
|
@@ -17623,7 +17819,7 @@ paths:
|
|
17623
17819
|
required: false
|
17624
17820
|
type: string
|
17625
17821
|
- description: A limit on the number of objects to be returned. Limit can range
|
17626
|
-
between 1 and 100 items.
|
17822
|
+
between 1 and 100 items, and the default is 10 items.
|
17627
17823
|
in: query
|
17628
17824
|
name: limit
|
17629
17825
|
required: false
|
@@ -17788,15 +17984,15 @@ paths:
|
|
17788
17984
|
type:
|
17789
17985
|
- integer
|
17790
17986
|
source:
|
17791
|
-
description: The source can either be a
|
17792
|
-
by [Elements](https://stripe.com/docs/elements),
|
17793
|
-
a user's credit card details (with the
|
17794
|
-
provide a source if the customer does
|
17795
|
-
attached, and you are subscribing
|
17796
|
-
not free. Passing `source` will create
|
17797
|
-
|
17798
|
-
one exists. If you want to add an additional
|
17799
|
-
instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
17987
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
17988
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements),
|
17989
|
+
or a dictionary containing a user's credit card details (with the
|
17990
|
+
options shown below). You must provide a source if the customer does
|
17991
|
+
not already have a valid source attached, and you are subscribing
|
17992
|
+
the customer for a plan that is not free. Passing `source` will create
|
17993
|
+
a new source object, make it the customer default source, and delete
|
17994
|
+
the old customer default if one exists. If you want to add an additional
|
17995
|
+
source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
17800
17996
|
to add the card and then the [customer update API](https://stripe.com/docs/api#update
|
17801
17997
|
customer) to set it as the default. Whenever you attach a card to
|
17802
17998
|
a customer, Stripe will automatically validate the card.
|
@@ -17999,15 +18195,15 @@ paths:
|
|
17999
18195
|
type:
|
18000
18196
|
- integer
|
18001
18197
|
source:
|
18002
|
-
description: The source can either be a
|
18003
|
-
by [Elements](https://stripe.com/docs/elements),
|
18004
|
-
a user's credit card details (with the
|
18005
|
-
provide a source if the customer does
|
18006
|
-
attached, and you are subscribing
|
18007
|
-
not free. Passing `source` will create
|
18008
|
-
|
18009
|
-
one exists. If you want to add an additional
|
18010
|
-
instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
18198
|
+
description: The source can either be a [Token](/docs/api#tokens)'s
|
18199
|
+
or a [Source](/docs/api#sources)'s ID, as returned by [Elements](https://stripe.com/docs/elements),
|
18200
|
+
or a dictionary containing a user's credit card details (with the
|
18201
|
+
options shown below). You must provide a source if the customer does
|
18202
|
+
not already have a valid source attached, and you are subscribing
|
18203
|
+
the customer for a plan that is not free. Passing `source` will create
|
18204
|
+
a new source object, make it the customer default source, and delete
|
18205
|
+
the old customer default if one exists. If you want to add an additional
|
18206
|
+
source to use with subscriptions, instead use the [card creation API](https://stripe.com/docs/api#create_card)
|
18011
18207
|
to add the card and then the [customer update API](https://stripe.com/docs/api#update
|
18012
18208
|
customer) to set it as the default. Whenever you attach a card to
|
18013
18209
|
a customer, Stripe will automatically validate the card.
|
@@ -18103,6 +18299,11 @@ paths:
|
|
18103
18299
|
title: payment_user_agent
|
18104
18300
|
type:
|
18105
18301
|
- string
|
18302
|
+
referrer:
|
18303
|
+
description: ''
|
18304
|
+
title: referrer
|
18305
|
+
type:
|
18306
|
+
- string
|
18106
18307
|
request_id:
|
18107
18308
|
description: ''
|
18108
18309
|
title: request_id
|
@@ -18154,7 +18355,7 @@ paths:
|
|
18154
18355
|
required: false
|
18155
18356
|
type: string
|
18156
18357
|
- description: A limit on the number of objects to be returned. Limit can range
|
18157
|
-
between 1 and 100 items.
|
18358
|
+
between 1 and 100 items, and the default is 10 items.
|
18158
18359
|
in: query
|
18159
18360
|
name: limit
|
18160
18361
|
required: false
|
@@ -18181,7 +18382,7 @@ paths:
|
|
18181
18382
|
in: query
|
18182
18383
|
name: created
|
18183
18384
|
required: false
|
18184
|
-
type:
|
18385
|
+
type: string
|
18185
18386
|
- description: Only return transfers for the destination specified by this account
|
18186
18387
|
ID.
|
18187
18388
|
in: query
|
@@ -18241,7 +18442,7 @@ paths:
|
|
18241
18442
|
"$ref": "#/definitions/error"
|
18242
18443
|
post:
|
18243
18444
|
description: ''
|
18244
|
-
operationId:
|
18445
|
+
operationId: TransferCreate
|
18245
18446
|
parameters:
|
18246
18447
|
- description: Body parameters for the request.
|
18247
18448
|
in: body
|
@@ -18259,6 +18460,11 @@ paths:
|
|
18259
18460
|
title: currency
|
18260
18461
|
type:
|
18261
18462
|
- string
|
18463
|
+
description:
|
18464
|
+
description: ''
|
18465
|
+
title: description
|
18466
|
+
type:
|
18467
|
+
- string
|
18262
18468
|
destination:
|
18263
18469
|
description: ''
|
18264
18470
|
title: destination
|
@@ -18370,40 +18576,6 @@ paths:
|
|
18370
18576
|
description: Error response.
|
18371
18577
|
schema:
|
18372
18578
|
"$ref": "#/definitions/error"
|
18373
|
-
"/v1/transfers/{id}/cancel":
|
18374
|
-
post:
|
18375
|
-
description: ''
|
18376
|
-
operationId: ReverseNonStripeTransferOnSlashCancel
|
18377
|
-
parameters:
|
18378
|
-
- description: ''
|
18379
|
-
in: path
|
18380
|
-
name: id
|
18381
|
-
required: true
|
18382
|
-
type: string
|
18383
|
-
- description: Body parameters for the request.
|
18384
|
-
in: body
|
18385
|
-
name: payload
|
18386
|
-
required: false
|
18387
|
-
schema:
|
18388
|
-
properties:
|
18389
|
-
expand:
|
18390
|
-
description: Specifies which fields in the response should be expanded.
|
18391
|
-
items:
|
18392
|
-
type:
|
18393
|
-
- string
|
18394
|
-
title: expand
|
18395
|
-
type:
|
18396
|
-
- array
|
18397
|
-
- string
|
18398
|
-
responses:
|
18399
|
-
'200':
|
18400
|
-
description: Successful response.
|
18401
|
-
schema:
|
18402
|
-
"$ref": "#/definitions/legacy_transfer"
|
18403
|
-
default:
|
18404
|
-
description: Error response.
|
18405
|
-
schema:
|
18406
|
-
"$ref": "#/definitions/error"
|
18407
18579
|
"/v1/transfers/{id}/reversals":
|
18408
18580
|
get:
|
18409
18581
|
description: "<p>You can see a list of the reversals belonging to a specific
|
@@ -18419,7 +18591,7 @@ paths:
|
|
18419
18591
|
required: false
|
18420
18592
|
type: string
|
18421
18593
|
- description: A limit on the number of objects to be returned. Limit can range
|
18422
|
-
between 1 and 100 items.
|
18594
|
+
between 1 and 100 items, and the default is 10 items.
|
18423
18595
|
in: query
|
18424
18596
|
name: limit
|
18425
18597
|
required: false
|