stripe 8.0.0 → 8.1.0.pre.beta.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +60 -39
- data/OPENAPI_VERSION +1 -1
- data/VERSION +1 -1
- data/lib/stripe/object_types.rb +10 -0
- data/lib/stripe/resources/account_session.rb +17 -0
- data/lib/stripe/resources/capital/financing_offer.rb +32 -0
- data/lib/stripe/resources/capital/financing_summary.rb +12 -0
- data/lib/stripe/resources/capital/financing_transaction.rb +13 -0
- data/lib/stripe/resources/gift_cards/card.rb +25 -0
- data/lib/stripe/resources/gift_cards/transaction.rb +56 -0
- data/lib/stripe/resources/order.rb +89 -0
- data/lib/stripe/resources/quote.rb +108 -0
- data/lib/stripe/resources/quote_phase.rb +29 -0
- data/lib/stripe/resources/subscription_schedule.rb +18 -0
- data/lib/stripe/resources/tax_calculation.rb +29 -0
- data/lib/stripe/resources/tax_transaction.rb +20 -0
- data/lib/stripe/resources/terminal/reader.rb +18 -0
- data/lib/stripe/resources.rb +10 -0
- data/lib/stripe/stripe_configuration.rb +2 -0
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +1 -0
- metadata +15 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7fa1351b66838b7806285da2a479099fbbfcc2083ac1f227f363f3dd34842f48
|
4
|
+
data.tar.gz: '0669c2151ae39aeeffe8f99dce91d7232d4038b63ebbf9ff77b0ba64e0ae2cb0'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 41226fd0a4e4bc70f4338d775d7beb3cd69497ac269357a4a60ef737c66738490e948befb2f70981f2f2f413958ec7e21841c66754f3a69b10aaa25fdc376084
|
7
|
+
data.tar.gz: b96050e968077fd86319f4f2329948ccd18e346e289c87370da55cda392f1ab8e957066b7931f3392212724070515a5970ffb09ec84eca908139eb2ec93fb4d0
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,21 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 8.1.0-beta.2 - 2022-12-15
|
4
|
+
* [#1156](https://github.com/stripe/stripe-ruby/pull/1156) API Updates for beta branch
|
5
|
+
* Updated stable APIs to the latest version
|
6
|
+
* Add support for new resources `TaxCalculation`, and `TaxTransaction`
|
7
|
+
* Add support for `create` and `list_line_items` methods on resource `TaxCalculation`
|
8
|
+
* Add support for `create_reversal`, `create`, and `retrieve` methods on resource `TaxTransaction`
|
9
|
+
* [#1155](https://github.com/stripe/stripe-ruby/pull/1155) API Updates for beta branch
|
10
|
+
* Updated stable APIs to the latest version
|
11
|
+
* Add support for new resource `QuoteLine`.
|
12
|
+
|
13
|
+
## 8.1.0-beta.1 - 2022-12-08
|
14
|
+
* [#1153](https://github.com/stripe/stripe-ruby/pull/1153) API Updates for beta branch
|
15
|
+
* Updated stable APIs to the latest version
|
16
|
+
* [#1146](https://github.com/stripe/stripe-ruby/pull/1146) API Updates for beta branch
|
17
|
+
* Updated stable APIs to the latest version
|
18
|
+
|
3
19
|
## 8.0.0 - 2022-11-16
|
4
20
|
* [#1144](https://github.com/stripe/stripe-ruby/pull/1144) Next major release changes
|
5
21
|
|
@@ -7,30 +23,29 @@ Breaking changes that arose during code generation of the library that we postpo
|
|
7
23
|
|
8
24
|
"⚠️" symbol highlights breaking changes.
|
9
25
|
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
# after
|
19
|
-
Stripe::Refund.update("re_123", description: "Refund description")
|
20
|
-
```
|
26
|
+
## 7.2.0-beta.5 - 2022-11-02
|
27
|
+
* [#1139](https://github.com/stripe/stripe-ruby/pull/1139) API Updates for beta branch
|
28
|
+
* Updated beta APIs to the latest stable version
|
29
|
+
* [#1135](https://github.com/stripe/stripe-ruby/pull/1135) API Updates for beta branch
|
30
|
+
* Updated stable APIs to the latest version
|
31
|
+
|
32
|
+
## 7.2.0-beta.4 - 2022-10-07
|
33
|
+
* [#999](https://github.com/stripe/stripe-ruby/pull/999) DESCRIBE CHANGES HERE (try to use the same style, tense, etc. as the other entries)
|
21
34
|
|
22
|
-
|
23
|
-
-
|
24
|
-
|
25
|
-
|
26
|
-
```ruby
|
27
|
-
# before
|
28
|
-
Stripe::Subscription::delete("sub_12345")
|
35
|
+
## 7.2.0-beta.3 - 2022-09-26
|
36
|
+
* [#1129](https://github.com/stripe/stripe-ruby/pull/1129) API Updates for beta branch
|
37
|
+
* Updated stable APIs to the latest version
|
38
|
+
* Add `FinancingOffer`, `FinancingSummary` and `FinancingTransaction` resources.
|
29
39
|
|
30
|
-
|
31
|
-
|
32
|
-
|
40
|
+
## 7.2.0-beta.2 - 2022-08-26
|
41
|
+
* [#1127](https://github.com/stripe/stripe-ruby/pull/1127) API Updates for beta branch
|
42
|
+
* Updated stable APIs to the latest version
|
43
|
+
* Add support for the beta [Gift Card API](https://stripe.com/docs/gift-cards).
|
33
44
|
|
45
|
+
## 7.2.0-beta.1 - 2022-08-23
|
46
|
+
* [#1122](https://github.com/stripe/stripe-ruby/pull/1122) API Updates for beta branch
|
47
|
+
- Updated stable APIs to the latest version
|
48
|
+
- `Stripe-Version` beta headers are not pinned by-default and need to be manually specified, please refer to [beta SDKs README section](https://github.com/stripe/stripe-ruby/blob/master/README.md#beta-sdks)
|
34
49
|
|
35
50
|
## 7.1.0 - 2022-08-19
|
36
51
|
* [#1116](https://github.com/stripe/stripe-ruby/pull/1116) API Updates
|
@@ -39,6 +54,16 @@ Breaking changes that arose during code generation of the library that we postpo
|
|
39
54
|
* [#1117](https://github.com/stripe/stripe-ruby/pull/1117) Refresh rubocop config.
|
40
55
|
* [#1115](https://github.com/stripe/stripe-ruby/pull/1115) Add a support section to the readme
|
41
56
|
|
57
|
+
## 7.1.0-beta.2 - 2022-08-11
|
58
|
+
* [#1113](https://github.com/stripe/stripe-ruby/pull/1113) API Updates for beta branch
|
59
|
+
- Updated stable APIs to the latest version
|
60
|
+
- Add `refund_payment` method to Terminal resource
|
61
|
+
|
62
|
+
## 7.1.0-beta.1 - 2022-08-03
|
63
|
+
* [#1107](https://github.com/stripe/stripe-ruby/pull/1107) API Updates for beta branch
|
64
|
+
- Updated stable APIs to the latest version
|
65
|
+
- Added the `Order` resource support
|
66
|
+
|
42
67
|
## 7.0.0 - 2022-08-02
|
43
68
|
|
44
69
|
Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the SDK, read more detailed description at https://github.com/stripe/stripe-ruby/wiki/Migration-guide-for-v7. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-08-01.
|
@@ -50,21 +75,19 @@ Breaking changes that arose during code generation of the library that we postpo
|
|
50
75
|
* [#1090](https://github.com/stripe/stripe-ruby/pull/1090) Use auto-generation for `Invoice` methods
|
51
76
|
* [#1103](https://github.com/stripe/stripe-ruby/pull/1103) Next major release changes
|
52
77
|
|
53
|
-
|
54
|
-
*
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
*
|
64
|
-
|
65
|
-
*
|
66
|
-
* Remove ability to list `Card` resource for a `Recipient`.
|
67
|
-
* Remove `cancel` method from `Transfer` resource. The method was deprecated.
|
78
|
+
## 6.6.0-beta.1 - 2022-07-22
|
79
|
+
* [#1100](https://github.com/stripe/stripe-ruby/pull/1100) API Updates for beta branch
|
80
|
+
- Updated stable APIs to the latest version
|
81
|
+
- Add `QuotePhase` resource
|
82
|
+
* [#1097](https://github.com/stripe/stripe-ruby/pull/1097) API Updates for beta branch
|
83
|
+
- Updated stable APIs to the latest version
|
84
|
+
- Add `SubscriptionSchedule.amend` method.
|
85
|
+
* [#1093](https://github.com/stripe/stripe-ruby/pull/1093) API Updates for beta branch
|
86
|
+
- Include `server_side_confirmation_beta=v1` beta
|
87
|
+
- Add `secretKeyConfirmation` to `PaymentIntent`
|
88
|
+
* [#1085](https://github.com/stripe/stripe-ruby/pull/1085) API Updates for beta branch
|
89
|
+
- Updated stable APIs to the latest version
|
90
|
+
* [#1075](https://github.com/stripe/stripe-ruby/pull/1075) Use the generated API version
|
68
91
|
|
69
92
|
## 6.5.0 - 2022-06-29
|
70
93
|
* [#1084](https://github.com/stripe/stripe-ruby/pull/1084) API Updates
|
@@ -94,8 +117,6 @@ Breaking changes that arose during code generation of the library that we postpo
|
|
94
117
|
* Add support for new resources `Treasury.CreditReversal`, `Treasury.DebitReversal`, `Treasury.FinancialAccountFeatures`, `Treasury.FinancialAccount`, `Treasury.FlowDetails`, `Treasury.InboundTransfer`, `Treasury.OutboundPayment`, `Treasury.OutboundTransfer`, `Treasury.ReceivedCredit`, `Treasury.ReceivedDebit`, `Treasury.TransactionEntry`, and `Treasury.Transaction`
|
95
118
|
* Add support for `retrieve_payment_method` method on resource `Customer`
|
96
119
|
* Add support for `list_owners` and `list` methods on resource `FinancialConnections.Account`
|
97
|
-
|
98
|
-
|
99
120
|
|
100
121
|
## 6.0.0 - 2022-05-09
|
101
122
|
* [#1056](https://github.com/stripe/stripe-ruby/pull/1056) API Updates
|
@@ -111,7 +132,6 @@ Breaking changes that arose during code generation of the library that we postpo
|
|
111
132
|
## 5.55.0 - 2022-05-05
|
112
133
|
* [#1055](https://github.com/stripe/stripe-ruby/pull/1055) API Updates
|
113
134
|
* Add support for new resources `FinancialConnections.AccountOwner`, `FinancialConnections.AccountOwnership`, `FinancialConnections.Account`, and `FinancialConnections.Session`
|
114
|
-
|
115
135
|
|
116
136
|
## 5.54.0 - 2022-05-03
|
117
137
|
* [#1053](https://github.com/stripe/stripe-ruby/pull/1053) API Updates
|
@@ -1142,3 +1162,4 @@ Identical to 1.56.0 above. I incorrectly cut a patch-level release.
|
|
1142
1162
|
<!--
|
1143
1163
|
# vim: set tw=0:
|
1144
1164
|
-->
|
1165
|
+
|
data/OPENAPI_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
v215
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
8.0.
|
1
|
+
8.1.0-beta.2
|
data/lib/stripe/object_types.rb
CHANGED
@@ -14,6 +14,7 @@ module Stripe
|
|
14
14
|
# business objects
|
15
15
|
Account::OBJECT_NAME => Account,
|
16
16
|
AccountLink::OBJECT_NAME => AccountLink,
|
17
|
+
AccountSession::OBJECT_NAME => AccountSession,
|
17
18
|
ApplePayDomain::OBJECT_NAME => ApplePayDomain,
|
18
19
|
ApplicationFee::OBJECT_NAME => ApplicationFee,
|
19
20
|
ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
|
@@ -24,6 +25,9 @@ module Stripe
|
|
24
25
|
BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
|
25
26
|
BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
|
26
27
|
Capability::OBJECT_NAME => Capability,
|
28
|
+
Capital::FinancingOffer::OBJECT_NAME => Capital::FinancingOffer,
|
29
|
+
Capital::FinancingSummary::OBJECT_NAME => Capital::FinancingSummary,
|
30
|
+
Capital::FinancingTransaction::OBJECT_NAME => Capital::FinancingTransaction,
|
27
31
|
Card::OBJECT_NAME => Card,
|
28
32
|
CashBalance::OBJECT_NAME => CashBalance,
|
29
33
|
Charge::OBJECT_NAME => Charge,
|
@@ -49,6 +53,8 @@ module Stripe
|
|
49
53
|
FinancialConnections::AccountOwnership,
|
50
54
|
FinancialConnections::Session::OBJECT_NAME => FinancialConnections::Session,
|
51
55
|
FundingInstructions::OBJECT_NAME => FundingInstructions,
|
56
|
+
GiftCards::Card::OBJECT_NAME => GiftCards::Card,
|
57
|
+
GiftCards::Transaction::OBJECT_NAME => GiftCards::Transaction,
|
52
58
|
Identity::VerificationReport::OBJECT_NAME => Identity::VerificationReport,
|
53
59
|
Identity::VerificationSession::OBJECT_NAME => Identity::VerificationSession,
|
54
60
|
Invoice::OBJECT_NAME => Invoice,
|
@@ -62,6 +68,7 @@ module Stripe
|
|
62
68
|
LineItem::OBJECT_NAME => LineItem,
|
63
69
|
LoginLink::OBJECT_NAME => LoginLink,
|
64
70
|
Mandate::OBJECT_NAME => Mandate,
|
71
|
+
Order::OBJECT_NAME => Order,
|
65
72
|
PaymentIntent::OBJECT_NAME => PaymentIntent,
|
66
73
|
PaymentLink::OBJECT_NAME => PaymentLink,
|
67
74
|
PaymentMethod::OBJECT_NAME => PaymentMethod,
|
@@ -72,6 +79,7 @@ module Stripe
|
|
72
79
|
Product::OBJECT_NAME => Product,
|
73
80
|
PromotionCode::OBJECT_NAME => PromotionCode,
|
74
81
|
Quote::OBJECT_NAME => Quote,
|
82
|
+
QuotePhase::OBJECT_NAME => QuotePhase,
|
75
83
|
Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
|
76
84
|
Radar::ValueList::OBJECT_NAME => Radar::ValueList,
|
77
85
|
Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
|
@@ -89,9 +97,11 @@ module Stripe
|
|
89
97
|
Subscription::OBJECT_NAME => Subscription,
|
90
98
|
SubscriptionItem::OBJECT_NAME => SubscriptionItem,
|
91
99
|
SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
|
100
|
+
TaxCalculation::OBJECT_NAME => TaxCalculation,
|
92
101
|
TaxCode::OBJECT_NAME => TaxCode,
|
93
102
|
TaxId::OBJECT_NAME => TaxId,
|
94
103
|
TaxRate::OBJECT_NAME => TaxRate,
|
104
|
+
TaxTransaction::OBJECT_NAME => TaxTransaction,
|
95
105
|
Terminal::Configuration::OBJECT_NAME => Terminal::Configuration,
|
96
106
|
Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,
|
97
107
|
Terminal::Location::OBJECT_NAME => Terminal::Location,
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
# An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded UIs.
|
6
|
+
#
|
7
|
+
# We recommend that you create an AccountSession each time you need to display an embedded UI
|
8
|
+
# to your user. Do not save AccountSessions to your database as they expire relatively
|
9
|
+
# quickly, and cannot be used more than once.
|
10
|
+
#
|
11
|
+
# Related guide: [Connect embedded UIs](https://stripe.com/docs/connect/get-started-connect-embedded-uis).
|
12
|
+
class AccountSession < APIResource
|
13
|
+
extend Stripe::APIOperations::Create
|
14
|
+
|
15
|
+
OBJECT_NAME = "account_session"
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module Capital
|
6
|
+
# This is an object representing an offer of financing from
|
7
|
+
# Stripe Capital to a Connect subaccount.
|
8
|
+
class FinancingOffer < APIResource
|
9
|
+
extend Stripe::APIOperations::List
|
10
|
+
|
11
|
+
OBJECT_NAME = "capital.financing_offer"
|
12
|
+
|
13
|
+
def mark_delivered(params = {}, opts = {})
|
14
|
+
request_stripe_object(
|
15
|
+
method: :post,
|
16
|
+
path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(self["id"]) }),
|
17
|
+
params: params,
|
18
|
+
opts: opts
|
19
|
+
)
|
20
|
+
end
|
21
|
+
|
22
|
+
def self.mark_delivered(financing_offer, params = {}, opts = {})
|
23
|
+
request_stripe_object(
|
24
|
+
method: :post,
|
25
|
+
path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
|
26
|
+
params: params,
|
27
|
+
opts: opts
|
28
|
+
)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module Capital
|
6
|
+
# A financing object describes an account's current financing state. Used by Connect
|
7
|
+
# platforms to read the state of Capital offered to their connected accounts.
|
8
|
+
class FinancingSummary < SingletonAPIResource
|
9
|
+
OBJECT_NAME = "capital.financing_summary"
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module Capital
|
6
|
+
# This is an object representing the details of a transaction on a Capital financing object.
|
7
|
+
class FinancingTransaction < APIResource
|
8
|
+
extend Stripe::APIOperations::List
|
9
|
+
|
10
|
+
OBJECT_NAME = "capital.financing_transaction"
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module GiftCards
|
6
|
+
# A gift card represents a single gift card owned by a customer, including the
|
7
|
+
# remaining balance, gift card code, and whether or not it is active.
|
8
|
+
class Card < APIResource
|
9
|
+
extend Stripe::APIOperations::Create
|
10
|
+
extend Stripe::APIOperations::List
|
11
|
+
include Stripe::APIOperations::Save
|
12
|
+
|
13
|
+
OBJECT_NAME = "gift_cards.card"
|
14
|
+
|
15
|
+
def self.validate(params = {}, opts = {})
|
16
|
+
request_stripe_object(
|
17
|
+
method: :post,
|
18
|
+
path: "/v1/gift_cards/cards/validate",
|
19
|
+
params: params,
|
20
|
+
opts: opts
|
21
|
+
)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module GiftCards
|
6
|
+
# A gift card transaction represents a single transaction on a referenced gift card.
|
7
|
+
# A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
|
8
|
+
# transaction is one that has added/deducted funds. A `held` transaction has created a
|
9
|
+
# temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
|
10
|
+
# can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
|
11
|
+
# A `canceled` transaction has no effect on a gift card's balance.
|
12
|
+
class Transaction < APIResource
|
13
|
+
extend Stripe::APIOperations::Create
|
14
|
+
extend Stripe::APIOperations::List
|
15
|
+
include Stripe::APIOperations::Save
|
16
|
+
|
17
|
+
OBJECT_NAME = "gift_cards.transaction"
|
18
|
+
|
19
|
+
def cancel(params = {}, opts = {})
|
20
|
+
request_stripe_object(
|
21
|
+
method: :post,
|
22
|
+
path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
|
23
|
+
params: params,
|
24
|
+
opts: opts
|
25
|
+
)
|
26
|
+
end
|
27
|
+
|
28
|
+
def confirm(params = {}, opts = {})
|
29
|
+
request_stripe_object(
|
30
|
+
method: :post,
|
31
|
+
path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
|
32
|
+
params: params,
|
33
|
+
opts: opts
|
34
|
+
)
|
35
|
+
end
|
36
|
+
|
37
|
+
def self.cancel(id, params = {}, opts = {})
|
38
|
+
request_stripe_object(
|
39
|
+
method: :post,
|
40
|
+
path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
|
41
|
+
params: params,
|
42
|
+
opts: opts
|
43
|
+
)
|
44
|
+
end
|
45
|
+
|
46
|
+
def self.confirm(id, params = {}, opts = {})
|
47
|
+
request_stripe_object(
|
48
|
+
method: :post,
|
49
|
+
path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
|
50
|
+
params: params,
|
51
|
+
opts: opts
|
52
|
+
)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
@@ -0,0 +1,89 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
# An Order describes a purchase being made by a customer, including the
|
6
|
+
# products & quantities being purchased, the order status, the payment information,
|
7
|
+
# and the billing/shipping details.
|
8
|
+
#
|
9
|
+
# Related guide: [Orders overview](https://stripe.com/docs/orders)
|
10
|
+
class Order < APIResource
|
11
|
+
extend Stripe::APIOperations::Create
|
12
|
+
extend Stripe::APIOperations::List
|
13
|
+
include Stripe::APIOperations::Save
|
14
|
+
|
15
|
+
OBJECT_NAME = "order"
|
16
|
+
|
17
|
+
def cancel(params = {}, opts = {})
|
18
|
+
request_stripe_object(
|
19
|
+
method: :post,
|
20
|
+
path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
|
21
|
+
params: params,
|
22
|
+
opts: opts
|
23
|
+
)
|
24
|
+
end
|
25
|
+
|
26
|
+
def list_line_items(params = {}, opts = {})
|
27
|
+
request_stripe_object(
|
28
|
+
method: :get,
|
29
|
+
path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(self["id"]) }),
|
30
|
+
params: params,
|
31
|
+
opts: opts
|
32
|
+
)
|
33
|
+
end
|
34
|
+
|
35
|
+
def reopen(params = {}, opts = {})
|
36
|
+
request_stripe_object(
|
37
|
+
method: :post,
|
38
|
+
path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(self["id"]) }),
|
39
|
+
params: params,
|
40
|
+
opts: opts
|
41
|
+
)
|
42
|
+
end
|
43
|
+
|
44
|
+
def submit(params = {}, opts = {})
|
45
|
+
request_stripe_object(
|
46
|
+
method: :post,
|
47
|
+
path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(self["id"]) }),
|
48
|
+
params: params,
|
49
|
+
opts: opts
|
50
|
+
)
|
51
|
+
end
|
52
|
+
|
53
|
+
def self.cancel(id, params = {}, opts = {})
|
54
|
+
request_stripe_object(
|
55
|
+
method: :post,
|
56
|
+
path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
|
57
|
+
params: params,
|
58
|
+
opts: opts
|
59
|
+
)
|
60
|
+
end
|
61
|
+
|
62
|
+
def self.list_line_items(id, params = {}, opts = {})
|
63
|
+
request_stripe_object(
|
64
|
+
method: :get,
|
65
|
+
path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
|
66
|
+
params: params,
|
67
|
+
opts: opts
|
68
|
+
)
|
69
|
+
end
|
70
|
+
|
71
|
+
def self.reopen(id, params = {}, opts = {})
|
72
|
+
request_stripe_object(
|
73
|
+
method: :post,
|
74
|
+
path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
|
75
|
+
params: params,
|
76
|
+
opts: opts
|
77
|
+
)
|
78
|
+
end
|
79
|
+
|
80
|
+
def self.submit(id, params = {}, opts = {})
|
81
|
+
request_stripe_object(
|
82
|
+
method: :post,
|
83
|
+
path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
|
84
|
+
params: params,
|
85
|
+
opts: opts
|
86
|
+
)
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
@@ -29,6 +29,15 @@ module Stripe
|
|
29
29
|
)
|
30
30
|
end
|
31
31
|
|
32
|
+
def draft_quote(params = {}, opts = {})
|
33
|
+
request_stripe_object(
|
34
|
+
method: :post,
|
35
|
+
path: format("/v1/quotes/%<quote>s/draft", { quote: CGI.escape(self["id"]) }),
|
36
|
+
params: params,
|
37
|
+
opts: opts
|
38
|
+
)
|
39
|
+
end
|
40
|
+
|
32
41
|
def finalize_quote(params = {}, opts = {})
|
33
42
|
request_stripe_object(
|
34
43
|
method: :post,
|
@@ -56,6 +65,51 @@ module Stripe
|
|
56
65
|
)
|
57
66
|
end
|
58
67
|
|
68
|
+
def list_lines(params = {}, opts = {})
|
69
|
+
request_stripe_object(
|
70
|
+
method: :get,
|
71
|
+
path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(self["id"]) }),
|
72
|
+
params: params,
|
73
|
+
opts: opts
|
74
|
+
)
|
75
|
+
end
|
76
|
+
|
77
|
+
def preview_invoice_lines(params = {}, opts = {})
|
78
|
+
request_stripe_object(
|
79
|
+
method: :get,
|
80
|
+
path: format("/v1/quotes/%<quote>s/preview_invoice_lines", { quote: CGI.escape(self["id"]) }),
|
81
|
+
params: params,
|
82
|
+
opts: opts
|
83
|
+
)
|
84
|
+
end
|
85
|
+
|
86
|
+
def preview_invoices(params = {}, opts = {})
|
87
|
+
request_stripe_object(
|
88
|
+
method: :get,
|
89
|
+
path: format("/v1/quotes/%<quote>s/preview_invoices", { quote: CGI.escape(self["id"]) }),
|
90
|
+
params: params,
|
91
|
+
opts: opts
|
92
|
+
)
|
93
|
+
end
|
94
|
+
|
95
|
+
def preview_subscription_schedules(params = {}, opts = {})
|
96
|
+
request_stripe_object(
|
97
|
+
method: :get,
|
98
|
+
path: format("/v1/quotes/%<quote>s/preview_subscription_schedules", { quote: CGI.escape(self["id"]) }),
|
99
|
+
params: params,
|
100
|
+
opts: opts
|
101
|
+
)
|
102
|
+
end
|
103
|
+
|
104
|
+
def reestimate(params = {}, opts = {})
|
105
|
+
request_stripe_object(
|
106
|
+
method: :post,
|
107
|
+
path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(self["id"]) }),
|
108
|
+
params: params,
|
109
|
+
opts: opts
|
110
|
+
)
|
111
|
+
end
|
112
|
+
|
59
113
|
def self.accept(quote, params = {}, opts = {})
|
60
114
|
request_stripe_object(
|
61
115
|
method: :post,
|
@@ -74,6 +128,15 @@ module Stripe
|
|
74
128
|
)
|
75
129
|
end
|
76
130
|
|
131
|
+
def self.draft_quote(quote, params = {}, opts = {})
|
132
|
+
request_stripe_object(
|
133
|
+
method: :post,
|
134
|
+
path: format("/v1/quotes/%<quote>s/draft", { quote: CGI.escape(quote) }),
|
135
|
+
params: params,
|
136
|
+
opts: opts
|
137
|
+
)
|
138
|
+
end
|
139
|
+
|
77
140
|
def self.finalize_quote(quote, params = {}, opts = {})
|
78
141
|
request_stripe_object(
|
79
142
|
method: :post,
|
@@ -101,6 +164,51 @@ module Stripe
|
|
101
164
|
)
|
102
165
|
end
|
103
166
|
|
167
|
+
def self.list_lines(quote, params = {}, opts = {})
|
168
|
+
request_stripe_object(
|
169
|
+
method: :get,
|
170
|
+
path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(quote) }),
|
171
|
+
params: params,
|
172
|
+
opts: opts
|
173
|
+
)
|
174
|
+
end
|
175
|
+
|
176
|
+
def self.preview_invoice_lines(quote, params = {}, opts = {})
|
177
|
+
request_stripe_object(
|
178
|
+
method: :get,
|
179
|
+
path: format("/v1/quotes/%<quote>s/preview_invoice_lines", { quote: CGI.escape(quote) }),
|
180
|
+
params: params,
|
181
|
+
opts: opts
|
182
|
+
)
|
183
|
+
end
|
184
|
+
|
185
|
+
def self.preview_invoices(quote, params = {}, opts = {})
|
186
|
+
request_stripe_object(
|
187
|
+
method: :get,
|
188
|
+
path: format("/v1/quotes/%<quote>s/preview_invoices", { quote: CGI.escape(quote) }),
|
189
|
+
params: params,
|
190
|
+
opts: opts
|
191
|
+
)
|
192
|
+
end
|
193
|
+
|
194
|
+
def self.preview_subscription_schedules(quote, params = {}, opts = {})
|
195
|
+
request_stripe_object(
|
196
|
+
method: :get,
|
197
|
+
path: format("/v1/quotes/%<quote>s/preview_subscription_schedules", { quote: CGI.escape(quote) }),
|
198
|
+
params: params,
|
199
|
+
opts: opts
|
200
|
+
)
|
201
|
+
end
|
202
|
+
|
203
|
+
def self.reestimate(quote, params = {}, opts = {})
|
204
|
+
request_stripe_object(
|
205
|
+
method: :post,
|
206
|
+
path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(quote) }),
|
207
|
+
params: params,
|
208
|
+
opts: opts
|
209
|
+
)
|
210
|
+
end
|
211
|
+
|
104
212
|
def pdf(params = {}, opts = {}, &read_body_chunk_block)
|
105
213
|
unless block_given?
|
106
214
|
raise ArgumentError, "A read_body_chunk_block block parameter is required when calling the pdf method."
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
# A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.
|
6
|
+
class QuotePhase < APIResource
|
7
|
+
extend Stripe::APIOperations::List
|
8
|
+
|
9
|
+
OBJECT_NAME = "quote_phase"
|
10
|
+
|
11
|
+
def list_line_items(params = {}, opts = {})
|
12
|
+
request_stripe_object(
|
13
|
+
method: :get,
|
14
|
+
path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(self["id"]) }),
|
15
|
+
params: params,
|
16
|
+
opts: opts
|
17
|
+
)
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.list_line_items(quote_phase, params = {}, opts = {})
|
21
|
+
request_stripe_object(
|
22
|
+
method: :get,
|
23
|
+
path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(quote_phase) }),
|
24
|
+
params: params,
|
25
|
+
opts: opts
|
26
|
+
)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -12,6 +12,15 @@ module Stripe
|
|
12
12
|
|
13
13
|
OBJECT_NAME = "subscription_schedule"
|
14
14
|
|
15
|
+
def amend(params = {}, opts = {})
|
16
|
+
request_stripe_object(
|
17
|
+
method: :post,
|
18
|
+
path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
|
19
|
+
params: params,
|
20
|
+
opts: opts
|
21
|
+
)
|
22
|
+
end
|
23
|
+
|
15
24
|
def cancel(params = {}, opts = {})
|
16
25
|
request_stripe_object(
|
17
26
|
method: :post,
|
@@ -30,6 +39,15 @@ module Stripe
|
|
30
39
|
)
|
31
40
|
end
|
32
41
|
|
42
|
+
def self.amend(schedule, params = {}, opts = {})
|
43
|
+
request_stripe_object(
|
44
|
+
method: :post,
|
45
|
+
path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
|
46
|
+
params: params,
|
47
|
+
opts: opts
|
48
|
+
)
|
49
|
+
end
|
50
|
+
|
33
51
|
def self.cancel(schedule, params = {}, opts = {})
|
34
52
|
request_stripe_object(
|
35
53
|
method: :post,
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
# A Tax `Calculation` allows you to calculate the tax to collect from your customer.
|
6
|
+
class TaxCalculation < APIResource
|
7
|
+
extend Stripe::APIOperations::Create
|
8
|
+
|
9
|
+
OBJECT_NAME = "tax.calculation"
|
10
|
+
|
11
|
+
def list_line_items(params = {}, opts = {})
|
12
|
+
request_stripe_object(
|
13
|
+
method: :get,
|
14
|
+
path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(self["id"]) }),
|
15
|
+
params: params,
|
16
|
+
opts: opts
|
17
|
+
)
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.list_line_items(calculation, params = {}, opts = {})
|
21
|
+
request_stripe_object(
|
22
|
+
method: :get,
|
23
|
+
path: format("/v1/tax/calculations/%<calculation>s/line_items", { calculation: CGI.escape(calculation) }),
|
24
|
+
params: params,
|
25
|
+
opts: opts
|
26
|
+
)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
# A Tax `Transaction` records the tax collected from or refunded to your customer.
|
6
|
+
class TaxTransaction < APIResource
|
7
|
+
extend Stripe::APIOperations::Create
|
8
|
+
|
9
|
+
OBJECT_NAME = "tax.transaction"
|
10
|
+
|
11
|
+
def self.create_reversal(params = {}, opts = {})
|
12
|
+
request_stripe_object(
|
13
|
+
method: :post,
|
14
|
+
path: "/v1/tax/transactions/create_reversal",
|
15
|
+
params: params,
|
16
|
+
opts: opts
|
17
|
+
)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -41,6 +41,15 @@ module Stripe
|
|
41
41
|
)
|
42
42
|
end
|
43
43
|
|
44
|
+
def refund_payment(params = {}, opts = {})
|
45
|
+
request_stripe_object(
|
46
|
+
method: :post,
|
47
|
+
path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(self["id"]) }),
|
48
|
+
params: params,
|
49
|
+
opts: opts
|
50
|
+
)
|
51
|
+
end
|
52
|
+
|
44
53
|
def set_reader_display(params = {}, opts = {})
|
45
54
|
request_stripe_object(
|
46
55
|
method: :post,
|
@@ -77,6 +86,15 @@ module Stripe
|
|
77
86
|
)
|
78
87
|
end
|
79
88
|
|
89
|
+
def self.refund_payment(reader, params = {}, opts = {})
|
90
|
+
request_stripe_object(
|
91
|
+
method: :post,
|
92
|
+
path: format("/v1/terminal/readers/%<reader>s/refund_payment", { reader: CGI.escape(reader) }),
|
93
|
+
params: params,
|
94
|
+
opts: opts
|
95
|
+
)
|
96
|
+
end
|
97
|
+
|
80
98
|
def self.set_reader_display(reader, params = {}, opts = {})
|
81
99
|
request_stripe_object(
|
82
100
|
method: :post,
|
data/lib/stripe/resources.rb
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
|
4
4
|
require "stripe/resources/account"
|
5
5
|
require "stripe/resources/account_link"
|
6
|
+
require "stripe/resources/account_session"
|
6
7
|
require "stripe/resources/apple_pay_domain"
|
7
8
|
require "stripe/resources/application_fee"
|
8
9
|
require "stripe/resources/application_fee_refund"
|
@@ -13,6 +14,9 @@ require "stripe/resources/bank_account"
|
|
13
14
|
require "stripe/resources/billing_portal/configuration"
|
14
15
|
require "stripe/resources/billing_portal/session"
|
15
16
|
require "stripe/resources/capability"
|
17
|
+
require "stripe/resources/capital/financing_offer"
|
18
|
+
require "stripe/resources/capital/financing_summary"
|
19
|
+
require "stripe/resources/capital/financing_transaction"
|
16
20
|
require "stripe/resources/card"
|
17
21
|
require "stripe/resources/cash_balance"
|
18
22
|
require "stripe/resources/charge"
|
@@ -36,6 +40,8 @@ require "stripe/resources/financial_connections/account_owner"
|
|
36
40
|
require "stripe/resources/financial_connections/account_ownership"
|
37
41
|
require "stripe/resources/financial_connections/session"
|
38
42
|
require "stripe/resources/funding_instructions"
|
43
|
+
require "stripe/resources/gift_cards/card"
|
44
|
+
require "stripe/resources/gift_cards/transaction"
|
39
45
|
require "stripe/resources/identity/verification_report"
|
40
46
|
require "stripe/resources/identity/verification_session"
|
41
47
|
require "stripe/resources/invoice"
|
@@ -49,6 +55,7 @@ require "stripe/resources/issuing/transaction"
|
|
49
55
|
require "stripe/resources/line_item"
|
50
56
|
require "stripe/resources/login_link"
|
51
57
|
require "stripe/resources/mandate"
|
58
|
+
require "stripe/resources/order"
|
52
59
|
require "stripe/resources/payment_intent"
|
53
60
|
require "stripe/resources/payment_link"
|
54
61
|
require "stripe/resources/payment_method"
|
@@ -59,6 +66,7 @@ require "stripe/resources/price"
|
|
59
66
|
require "stripe/resources/product"
|
60
67
|
require "stripe/resources/promotion_code"
|
61
68
|
require "stripe/resources/quote"
|
69
|
+
require "stripe/resources/quote_phase"
|
62
70
|
require "stripe/resources/radar/early_fraud_warning"
|
63
71
|
require "stripe/resources/radar/value_list"
|
64
72
|
require "stripe/resources/radar/value_list_item"
|
@@ -76,9 +84,11 @@ require "stripe/resources/source_transaction"
|
|
76
84
|
require "stripe/resources/subscription"
|
77
85
|
require "stripe/resources/subscription_item"
|
78
86
|
require "stripe/resources/subscription_schedule"
|
87
|
+
require "stripe/resources/tax_calculation"
|
79
88
|
require "stripe/resources/tax_code"
|
80
89
|
require "stripe/resources/tax_id"
|
81
90
|
require "stripe/resources/tax_rate"
|
91
|
+
require "stripe/resources/tax_transaction"
|
82
92
|
require "stripe/resources/terminal/configuration"
|
83
93
|
require "stripe/resources/terminal/connection_token"
|
84
94
|
require "stripe/resources/terminal/location"
|
data/lib/stripe/version.rb
CHANGED
data/lib/stripe.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: stripe
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 8.0.
|
4
|
+
version: 8.1.0.pre.beta.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Stripe
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-12-16 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: Stripe is the easiest way to accept payments online. See https://stripe.com
|
14
14
|
for details.
|
@@ -53,6 +53,7 @@ files:
|
|
53
53
|
- lib/stripe/resources.rb
|
54
54
|
- lib/stripe/resources/account.rb
|
55
55
|
- lib/stripe/resources/account_link.rb
|
56
|
+
- lib/stripe/resources/account_session.rb
|
56
57
|
- lib/stripe/resources/alipay_account.rb
|
57
58
|
- lib/stripe/resources/apple_pay_domain.rb
|
58
59
|
- lib/stripe/resources/application_fee.rb
|
@@ -64,6 +65,9 @@ files:
|
|
64
65
|
- lib/stripe/resources/billing_portal/configuration.rb
|
65
66
|
- lib/stripe/resources/billing_portal/session.rb
|
66
67
|
- lib/stripe/resources/capability.rb
|
68
|
+
- lib/stripe/resources/capital/financing_offer.rb
|
69
|
+
- lib/stripe/resources/capital/financing_summary.rb
|
70
|
+
- lib/stripe/resources/capital/financing_transaction.rb
|
67
71
|
- lib/stripe/resources/card.rb
|
68
72
|
- lib/stripe/resources/cash_balance.rb
|
69
73
|
- lib/stripe/resources/charge.rb
|
@@ -87,6 +91,8 @@ files:
|
|
87
91
|
- lib/stripe/resources/financial_connections/account_ownership.rb
|
88
92
|
- lib/stripe/resources/financial_connections/session.rb
|
89
93
|
- lib/stripe/resources/funding_instructions.rb
|
94
|
+
- lib/stripe/resources/gift_cards/card.rb
|
95
|
+
- lib/stripe/resources/gift_cards/transaction.rb
|
90
96
|
- lib/stripe/resources/identity/verification_report.rb
|
91
97
|
- lib/stripe/resources/identity/verification_session.rb
|
92
98
|
- lib/stripe/resources/invoice.rb
|
@@ -100,6 +106,7 @@ files:
|
|
100
106
|
- lib/stripe/resources/line_item.rb
|
101
107
|
- lib/stripe/resources/login_link.rb
|
102
108
|
- lib/stripe/resources/mandate.rb
|
109
|
+
- lib/stripe/resources/order.rb
|
103
110
|
- lib/stripe/resources/payment_intent.rb
|
104
111
|
- lib/stripe/resources/payment_link.rb
|
105
112
|
- lib/stripe/resources/payment_method.rb
|
@@ -110,6 +117,7 @@ files:
|
|
110
117
|
- lib/stripe/resources/product.rb
|
111
118
|
- lib/stripe/resources/promotion_code.rb
|
112
119
|
- lib/stripe/resources/quote.rb
|
120
|
+
- lib/stripe/resources/quote_phase.rb
|
113
121
|
- lib/stripe/resources/radar/early_fraud_warning.rb
|
114
122
|
- lib/stripe/resources/radar/value_list.rb
|
115
123
|
- lib/stripe/resources/radar/value_list_item.rb
|
@@ -128,9 +136,11 @@ files:
|
|
128
136
|
- lib/stripe/resources/subscription.rb
|
129
137
|
- lib/stripe/resources/subscription_item.rb
|
130
138
|
- lib/stripe/resources/subscription_schedule.rb
|
139
|
+
- lib/stripe/resources/tax_calculation.rb
|
131
140
|
- lib/stripe/resources/tax_code.rb
|
132
141
|
- lib/stripe/resources/tax_id.rb
|
133
142
|
- lib/stripe/resources/tax_rate.rb
|
143
|
+
- lib/stripe/resources/tax_transaction.rb
|
134
144
|
- lib/stripe/resources/terminal/configuration.rb
|
135
145
|
- lib/stripe/resources/terminal/connection_token.rb
|
136
146
|
- lib/stripe/resources/terminal/location.rb
|
@@ -183,11 +193,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
183
193
|
version: 2.3.0
|
184
194
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
185
195
|
requirements:
|
186
|
-
- - "
|
196
|
+
- - ">"
|
187
197
|
- !ruby/object:Gem::Version
|
188
|
-
version:
|
198
|
+
version: 1.3.1
|
189
199
|
requirements: []
|
190
|
-
rubygems_version: 3.3.
|
200
|
+
rubygems_version: 3.3.26
|
191
201
|
signing_key:
|
192
202
|
specification_version: 4
|
193
203
|
summary: Ruby bindings for the Stripe API
|