stripe 13.3.0.pre.beta.3 → 13.3.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/CHANGELOG.md +650 -1402
- data/OPENAPI_VERSION +1 -1
- data/VERSION +1 -1
- data/lib/stripe/object_types.rb +0 -32
- data/lib/stripe/resources/account.rb +2 -232
- data/lib/stripe/resources/account_link.rb +0 -9
- data/lib/stripe/resources/account_session.rb +0 -103
- data/lib/stripe/resources/apple_pay_domain.rb +2 -20
- data/lib/stripe/resources/application_fee.rb +2 -36
- data/lib/stripe/resources/application_fee_refund.rb +0 -17
- data/lib/stripe/resources/apps/secret.rb +2 -24
- data/lib/stripe/resources/balance.rb +0 -59
- data/lib/stripe/resources/balance_transaction.rb +2 -36
- data/lib/stripe/resources/bank_account.rb +3 -61
- data/lib/stripe/resources/billing/alert.rb +2 -23
- data/lib/stripe/resources/billing/credit_balance_summary.rb +0 -25
- data/lib/stripe/resources/billing/credit_balance_transaction.rb +2 -50
- data/lib/stripe/resources/billing/credit_grant.rb +2 -46
- data/lib/stripe/resources/billing/meter.rb +2 -44
- data/lib/stripe/resources/billing/meter_event.rb +0 -15
- data/lib/stripe/resources/billing/meter_event_adjustment.rb +0 -16
- data/lib/stripe/resources/billing/meter_event_summary.rb +0 -15
- data/lib/stripe/resources/billing_portal/configuration.rb +2 -72
- data/lib/stripe/resources/billing_portal/session.rb +0 -61
- data/lib/stripe/resources/capability.rb +0 -38
- data/lib/stripe/resources/card.rb +1 -77
- data/lib/stripe/resources/cash_balance.rb +0 -14
- data/lib/stripe/resources/charge.rb +2 -471
- data/lib/stripe/resources/checkout/session.rb +2 -498
- data/lib/stripe/resources/climate/order.rb +2 -57
- data/lib/stripe/resources/climate/product.rb +2 -26
- data/lib/stripe/resources/climate/supplier.rb +2 -20
- data/lib/stripe/resources/confirmation_token.rb +0 -297
- data/lib/stripe/resources/country_spec.rb +2 -29
- data/lib/stripe/resources/coupon.rb +2 -46
- data/lib/stripe/resources/credit_note.rb +2 -93
- data/lib/stripe/resources/credit_note_line_item.rb +0 -46
- data/lib/stripe/resources/customer.rb +2 -95
- data/lib/stripe/resources/customer_balance_transaction.rb +0 -27
- data/lib/stripe/resources/customer_cash_balance_transaction.rb +0 -72
- data/lib/stripe/resources/customer_session.rb +0 -34
- data/lib/stripe/resources/discount.rb +0 -29
- data/lib/stripe/resources/dispute.rb +2 -98
- data/lib/stripe/resources/entitlements/active_entitlement.rb +2 -13
- data/lib/stripe/resources/entitlements/feature.rb +2 -17
- data/lib/stripe/resources/ephemeral_key.rb +0 -13
- data/lib/stripe/resources/event.rb +2 -46
- data/lib/stripe/resources/exchange_rate.rb +2 -9
- data/lib/stripe/resources/file.rb +2 -25
- data/lib/stripe/resources/file_link.rb +2 -21
- data/lib/stripe/resources/financial_connections/account.rb +2 -89
- data/lib/stripe/resources/financial_connections/account_owner.rb +0 -17
- data/lib/stripe/resources/financial_connections/account_ownership.rb +0 -9
- data/lib/stripe/resources/financial_connections/session.rb +0 -49
- data/lib/stripe/resources/financial_connections/transaction.rb +2 -30
- data/lib/stripe/resources/forwarding/request.rb +2 -42
- data/lib/stripe/resources/funding_instructions.rb +0 -82
- data/lib/stripe/resources/identity/verification_report.rb +2 -94
- data/lib/stripe/resources/identity/verification_session.rb +2 -78
- data/lib/stripe/resources/invoice.rb +2 -420
- data/lib/stripe/resources/invoice_item.rb +2 -56
- data/lib/stripe/resources/invoice_line_item.rb +0 -83
- data/lib/stripe/resources/invoice_rendering_template.rb +2 -19
- data/lib/stripe/resources/issuing/authorization.rb +2 -131
- data/lib/stripe/resources/issuing/card.rb +2 -88
- data/lib/stripe/resources/issuing/cardholder.rb +2 -78
- data/lib/stripe/resources/issuing/dispute.rb +2 -67
- data/lib/stripe/resources/issuing/personalization_design.rb +2 -40
- data/lib/stripe/resources/issuing/physical_bundle.rb +2 -20
- data/lib/stripe/resources/issuing/token.rb +2 -48
- data/lib/stripe/resources/issuing/transaction.rb +2 -108
- data/lib/stripe/resources/line_item.rb +0 -50
- data/lib/stripe/resources/login_link.rb +0 -7
- data/lib/stripe/resources/mandate.rb +0 -78
- data/lib/stripe/resources/payment_intent.rb +2 -714
- data/lib/stripe/resources/payment_link.rb +2 -200
- data/lib/stripe/resources/payment_method.rb +2 -370
- data/lib/stripe/resources/payment_method_configuration.rb +2 -432
- data/lib/stripe/resources/payment_method_domain.rb +2 -59
- data/lib/stripe/resources/payout.rb +2 -58
- data/lib/stripe/resources/person.rb +0 -128
- data/lib/stripe/resources/plan.rb +2 -54
- data/lib/stripe/resources/price.rb +2 -79
- data/lib/stripe/resources/product.rb +2 -62
- data/lib/stripe/resources/product_feature.rb +0 -12
- data/lib/stripe/resources/promotion_code.rb +2 -37
- data/lib/stripe/resources/quote.rb +2 -358
- data/lib/stripe/resources/radar/early_fraud_warning.rb +2 -19
- data/lib/stripe/resources/radar/value_list.rb +2 -25
- data/lib/stripe/resources/radar/value_list_item.rb +2 -19
- data/lib/stripe/resources/refund.rb +2 -132
- data/lib/stripe/resources/reporting/report_run.rb +2 -31
- data/lib/stripe/resources/reporting/report_type.rb +2 -21
- data/lib/stripe/resources/reversal.rb +0 -21
- data/lib/stripe/resources/review.rb +2 -38
- data/lib/stripe/resources/setup_attempt.rb +2 -103
- data/lib/stripe/resources/setup_intent.rb +2 -160
- data/lib/stripe/resources/shipping_rate.rb +2 -44
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +2 -28
- data/lib/stripe/resources/source.rb +0 -197
- data/lib/stripe/resources/source_transaction.rb +0 -48
- data/lib/stripe/resources/subscription.rb +2 -216
- data/lib/stripe/resources/subscription_item.rb +2 -48
- data/lib/stripe/resources/subscription_schedule.rb +2 -175
- data/lib/stripe/resources/tax/calculation.rb +0 -72
- data/lib/stripe/resources/tax/calculation_line_item.rb +0 -33
- data/lib/stripe/resources/tax/registration.rb +2 -381
- data/lib/stripe/resources/tax/settings.rb +0 -33
- data/lib/stripe/resources/tax/transaction.rb +0 -68
- data/lib/stripe/resources/tax/transaction_line_item.rb +0 -30
- data/lib/stripe/resources/tax_code.rb +2 -11
- data/lib/stripe/resources/tax_id.rb +2 -32
- data/lib/stripe/resources/tax_rate.rb +2 -44
- data/lib/stripe/resources/terminal/configuration.rb +2 -109
- data/lib/stripe/resources/terminal/connection_token.rb +0 -7
- data/lib/stripe/resources/terminal/location.rb +2 -22
- data/lib/stripe/resources/terminal/reader.rb +2 -180
- data/lib/stripe/resources/test_helpers/test_clock.rb +2 -29
- data/lib/stripe/resources/token.rb +0 -29
- data/lib/stripe/resources/topup.rb +2 -35
- data/lib/stripe/resources/transfer.rb +2 -37
- data/lib/stripe/resources/treasury/credit_reversal.rb +2 -34
- data/lib/stripe/resources/treasury/debit_reversal.rb +2 -40
- data/lib/stripe/resources/treasury/financial_account.rb +2 -59
- data/lib/stripe/resources/treasury/financial_account_features.rb +0 -91
- data/lib/stripe/resources/treasury/inbound_transfer.rb +2 -68
- data/lib/stripe/resources/treasury/outbound_payment.rb +2 -87
- data/lib/stripe/resources/treasury/outbound_transfer.rb +2 -84
- data/lib/stripe/resources/treasury/received_credit.rb +2 -72
- data/lib/stripe/resources/treasury/received_debit.rb +2 -69
- data/lib/stripe/resources/treasury/transaction.rb +2 -44
- data/lib/stripe/resources/treasury/transaction_entry.rb +2 -36
- data/lib/stripe/resources/usage_record.rb +0 -13
- data/lib/stripe/resources/usage_record_summary.rb +0 -18
- data/lib/stripe/resources/v2/billing/meter_event.rb +0 -18
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +0 -20
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +0 -14
- data/lib/stripe/resources/v2/event.rb +0 -21
- data/lib/stripe/resources/v2/event_destination.rb +0 -49
- data/lib/stripe/resources/webhook_endpoint.rb +2 -34
- data/lib/stripe/resources.rb +0 -31
- data/lib/stripe/services/financial_connections/account_service.rb +1 -3
- data/lib/stripe/services/financial_connections_service.rb +1 -2
- data/lib/stripe/services/invoice_service.rb +1 -44
- data/lib/stripe/services/issuing_service.rb +1 -5
- data/lib/stripe/services/payment_intent_service.rb +0 -37
- data/lib/stripe/services/quote_service.rb +1 -49
- data/lib/stripe/services/subscription_schedule_service.rb +0 -11
- data/lib/stripe/services/tax_service.rb +1 -3
- data/lib/stripe/services/terminal/reader_service.rb +0 -33
- data/lib/stripe/services/terminal_service.rb +1 -2
- data/lib/stripe/services/v1_services.rb +1 -8
- data/lib/stripe/services.rb +0 -25
- data/lib/stripe/stripe_client.rb +1 -1
- data/lib/stripe/stripe_configuration.rb +1 -3
- data/lib/stripe/stripe_object.rb +3 -8
- data/lib/stripe/util.rb +2 -8
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +0 -45
- data/stripe.gemspec +1 -2
- metadata +4 -62
- data/lib/stripe/request_signing_authenticator.rb +0 -79
- data/lib/stripe/resources/account_notice.rb +0 -60
- data/lib/stripe/resources/application.rb +0 -20
- data/lib/stripe/resources/billing/alert_triggered.rb +0 -26
- data/lib/stripe/resources/billing/meter_error_report.rb +0 -44
- data/lib/stripe/resources/capital/financing_offer.rb +0 -94
- data/lib/stripe/resources/capital/financing_summary.rb +0 -32
- data/lib/stripe/resources/capital/financing_transaction.rb +0 -56
- data/lib/stripe/resources/connect_collection_transfer.rb +0 -24
- data/lib/stripe/resources/entitlements/active_entitlement_summary.rb +0 -23
- data/lib/stripe/resources/financial_connections/account_inferred_balance.rb +0 -27
- data/lib/stripe/resources/financial_connections/institution.rb +0 -61
- data/lib/stripe/resources/gift_cards/card.rb +0 -96
- data/lib/stripe/resources/gift_cards/transaction.rb +0 -132
- data/lib/stripe/resources/invoice_payment.rb +0 -46
- data/lib/stripe/resources/issuing/credit_underwriting_record.rb +0 -145
- data/lib/stripe/resources/issuing/dispute_settlement_detail.rb +0 -49
- data/lib/stripe/resources/issuing/fraud_liability_debit.rb +0 -43
- data/lib/stripe/resources/issuing/settlement.rb +0 -49
- data/lib/stripe/resources/margin.rb +0 -56
- data/lib/stripe/resources/order.rb +0 -322
- data/lib/stripe/resources/payment_attempt_record.rb +0 -100
- data/lib/stripe/resources/payment_record.rb +0 -188
- data/lib/stripe/resources/quote_line.rb +0 -136
- data/lib/stripe/resources/quote_preview_invoice.rb +0 -374
- data/lib/stripe/resources/quote_preview_subscription_schedule.rb +0 -170
- data/lib/stripe/resources/reserve_transaction.rb +0 -22
- data/lib/stripe/resources/source_mandate_notification.rb +0 -59
- data/lib/stripe/resources/tax/association.rb +0 -60
- data/lib/stripe/resources/tax/form.rb +0 -124
- data/lib/stripe/resources/tax_deducted_at_source.rb +0 -22
- data/lib/stripe/resources/terminal/reader_collected_data.rb +0 -30
- data/lib/stripe/resources/v2/amount.rb +0 -9
- data/lib/stripe/services/account_notice_service.rb +0 -39
- data/lib/stripe/services/capital/financing_offer_service.rb +0 -42
- data/lib/stripe/services/capital/financing_summary_service.rb +0 -19
- data/lib/stripe/services/capital/financing_transaction_service.rb +0 -31
- data/lib/stripe/services/capital_service.rb +0 -15
- data/lib/stripe/services/financial_connections/account_inferred_balance_service.rb +0 -19
- data/lib/stripe/services/financial_connections/institution_service.rb +0 -30
- data/lib/stripe/services/gift_cards/card_service.rb +0 -63
- data/lib/stripe/services/gift_cards/transaction_service.rb +0 -74
- data/lib/stripe/services/gift_cards_service.rb +0 -14
- data/lib/stripe/services/invoice_payment_service.rb +0 -28
- data/lib/stripe/services/issuing/credit_underwriting_record_service.rb +0 -74
- data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb +0 -30
- data/lib/stripe/services/issuing/fraud_liability_debit_service.rb +0 -30
- data/lib/stripe/services/margin_service.rb +0 -50
- data/lib/stripe/services/order_line_item_service.rb +0 -17
- data/lib/stripe/services/order_service.rb +0 -78
- data/lib/stripe/services/payment_attempt_record_service.rb +0 -28
- data/lib/stripe/services/payment_record_service.rb +0 -78
- data/lib/stripe/services/quote_line_service.rb +0 -17
- data/lib/stripe/services/quote_preview_invoice_service.rb +0 -17
- data/lib/stripe/services/quote_preview_subscription_schedule_service.rb +0 -17
- data/lib/stripe/services/tax/association_service.rb +0 -19
- data/lib/stripe/services/tax/form_service.rb +0 -37
- data/lib/stripe/services/terminal/reader_collected_data_service.rb +0 -19
@@ -1,188 +0,0 @@
|
|
1
|
-
# File generated from our OpenAPI spec
|
2
|
-
# frozen_string_literal: true
|
3
|
-
|
4
|
-
module Stripe
|
5
|
-
# A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe.
|
6
|
-
# For example, you can create a Payment Record to model a payment made on a different payment processor,
|
7
|
-
# in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or
|
8
|
-
# more Payment Attempt Records, which represent individual attempts made on a payment network.
|
9
|
-
class PaymentRecord < APIResource
|
10
|
-
OBJECT_NAME = "payment_record"
|
11
|
-
def self.object_name
|
12
|
-
"payment_record"
|
13
|
-
end
|
14
|
-
|
15
|
-
class AmountCanceled < Stripe::StripeObject
|
16
|
-
attr_reader :currency, :value
|
17
|
-
end
|
18
|
-
|
19
|
-
class AmountFailed < Stripe::StripeObject
|
20
|
-
attr_reader :currency, :value
|
21
|
-
end
|
22
|
-
|
23
|
-
class AmountGuaranteed < Stripe::StripeObject
|
24
|
-
attr_reader :currency, :value
|
25
|
-
end
|
26
|
-
|
27
|
-
class AmountRequested < Stripe::StripeObject
|
28
|
-
attr_reader :currency, :value
|
29
|
-
end
|
30
|
-
|
31
|
-
class CustomerDetails < Stripe::StripeObject
|
32
|
-
attr_reader :customer, :email, :name, :phone
|
33
|
-
end
|
34
|
-
|
35
|
-
class PaymentMethodDetails < Stripe::StripeObject
|
36
|
-
class BillingDetails < Stripe::StripeObject
|
37
|
-
class Address < Stripe::StripeObject
|
38
|
-
attr_reader :city, :country, :line1, :line2, :postal_code, :state
|
39
|
-
end
|
40
|
-
attr_reader :address, :email, :name, :phone
|
41
|
-
end
|
42
|
-
|
43
|
-
class Custom < Stripe::StripeObject
|
44
|
-
attr_reader :display_name, :type
|
45
|
-
end
|
46
|
-
attr_reader :billing_details, :custom, :payment_method, :type
|
47
|
-
end
|
48
|
-
|
49
|
-
class ShippingDetails < Stripe::StripeObject
|
50
|
-
class Address < Stripe::StripeObject
|
51
|
-
attr_reader :city, :country, :line1, :line2, :postal_code, :state
|
52
|
-
end
|
53
|
-
attr_reader :address, :name, :phone
|
54
|
-
end
|
55
|
-
# A representation of an amount of money, consisting of an amount and a currency.
|
56
|
-
attr_reader :amount_canceled
|
57
|
-
# A representation of an amount of money, consisting of an amount and a currency.
|
58
|
-
attr_reader :amount_failed
|
59
|
-
# A representation of an amount of money, consisting of an amount and a currency.
|
60
|
-
attr_reader :amount_guaranteed
|
61
|
-
# A representation of an amount of money, consisting of an amount and a currency.
|
62
|
-
attr_reader :amount_requested
|
63
|
-
# Time at which the object was created. Measured in seconds since the Unix epoch.
|
64
|
-
attr_reader :created
|
65
|
-
# Customer information for this payment.
|
66
|
-
attr_reader :customer_details
|
67
|
-
# Indicates whether the customer was present in your checkout flow during this payment.
|
68
|
-
attr_reader :customer_presence
|
69
|
-
# An arbitrary string attached to the object. Often useful for displaying to users.
|
70
|
-
attr_reader :description
|
71
|
-
# Unique identifier for the object.
|
72
|
-
attr_reader :id
|
73
|
-
# ID of the latest Payment Attempt Record attached to this Payment Record.
|
74
|
-
attr_reader :latest_payment_attempt_record
|
75
|
-
# Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
76
|
-
attr_reader :livemode
|
77
|
-
# Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
|
78
|
-
attr_reader :metadata
|
79
|
-
# String representing the object's type. Objects of the same type share the same value.
|
80
|
-
attr_reader :object
|
81
|
-
# Information about the Payment Method debited for this payment.
|
82
|
-
attr_reader :payment_method_details
|
83
|
-
# An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.
|
84
|
-
attr_reader :payment_reference
|
85
|
-
# Shipping information for this payment.
|
86
|
-
attr_reader :shipping_details
|
87
|
-
|
88
|
-
# Report a new Payment Record. You may report a Payment Record as it is
|
89
|
-
# initialized and later report updates through the other report_* methods, or report Payment
|
90
|
-
# Records in a terminal state directly, through this method.
|
91
|
-
def self.report_payment(params = {}, opts = {})
|
92
|
-
request_stripe_object(
|
93
|
-
method: :post,
|
94
|
-
path: "/v1/payment_records/report_payment",
|
95
|
-
params: params,
|
96
|
-
opts: opts
|
97
|
-
)
|
98
|
-
end
|
99
|
-
|
100
|
-
# Report a new payment attempt on the specified Payment Record. A new payment
|
101
|
-
# attempt can only be specified if all other payment attempts are canceled or failed.
|
102
|
-
def report_payment_attempt(params = {}, opts = {})
|
103
|
-
request_stripe_object(
|
104
|
-
method: :post,
|
105
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt", { id: CGI.escape(self["id"]) }),
|
106
|
-
params: params,
|
107
|
-
opts: opts
|
108
|
-
)
|
109
|
-
end
|
110
|
-
|
111
|
-
# Report a new payment attempt on the specified Payment Record. A new payment
|
112
|
-
# attempt can only be specified if all other payment attempts are canceled or failed.
|
113
|
-
def self.report_payment_attempt(id, params = {}, opts = {})
|
114
|
-
request_stripe_object(
|
115
|
-
method: :post,
|
116
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt", { id: CGI.escape(id) }),
|
117
|
-
params: params,
|
118
|
-
opts: opts
|
119
|
-
)
|
120
|
-
end
|
121
|
-
|
122
|
-
# Report that the most recent payment attempt on the specified Payment Record
|
123
|
-
# was canceled.
|
124
|
-
def report_payment_attempt_canceled(params = {}, opts = {})
|
125
|
-
request_stripe_object(
|
126
|
-
method: :post,
|
127
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt_canceled", { id: CGI.escape(self["id"]) }),
|
128
|
-
params: params,
|
129
|
-
opts: opts
|
130
|
-
)
|
131
|
-
end
|
132
|
-
|
133
|
-
# Report that the most recent payment attempt on the specified Payment Record
|
134
|
-
# was canceled.
|
135
|
-
def self.report_payment_attempt_canceled(id, params = {}, opts = {})
|
136
|
-
request_stripe_object(
|
137
|
-
method: :post,
|
138
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt_canceled", { id: CGI.escape(id) }),
|
139
|
-
params: params,
|
140
|
-
opts: opts
|
141
|
-
)
|
142
|
-
end
|
143
|
-
|
144
|
-
# Report that the most recent payment attempt on the specified Payment Record
|
145
|
-
# failed or errored.
|
146
|
-
def report_payment_attempt_failed(params = {}, opts = {})
|
147
|
-
request_stripe_object(
|
148
|
-
method: :post,
|
149
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt_failed", { id: CGI.escape(self["id"]) }),
|
150
|
-
params: params,
|
151
|
-
opts: opts
|
152
|
-
)
|
153
|
-
end
|
154
|
-
|
155
|
-
# Report that the most recent payment attempt on the specified Payment Record
|
156
|
-
# failed or errored.
|
157
|
-
def self.report_payment_attempt_failed(id, params = {}, opts = {})
|
158
|
-
request_stripe_object(
|
159
|
-
method: :post,
|
160
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt_failed", { id: CGI.escape(id) }),
|
161
|
-
params: params,
|
162
|
-
opts: opts
|
163
|
-
)
|
164
|
-
end
|
165
|
-
|
166
|
-
# Report that the most recent payment attempt on the specified Payment Record
|
167
|
-
# was guaranteed.
|
168
|
-
def report_payment_attempt_guaranteed(params = {}, opts = {})
|
169
|
-
request_stripe_object(
|
170
|
-
method: :post,
|
171
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt_guaranteed", { id: CGI.escape(self["id"]) }),
|
172
|
-
params: params,
|
173
|
-
opts: opts
|
174
|
-
)
|
175
|
-
end
|
176
|
-
|
177
|
-
# Report that the most recent payment attempt on the specified Payment Record
|
178
|
-
# was guaranteed.
|
179
|
-
def self.report_payment_attempt_guaranteed(id, params = {}, opts = {})
|
180
|
-
request_stripe_object(
|
181
|
-
method: :post,
|
182
|
-
path: format("/v1/payment_records/%<id>s/report_payment_attempt_guaranteed", { id: CGI.escape(id) }),
|
183
|
-
params: params,
|
184
|
-
opts: opts
|
185
|
-
)
|
186
|
-
end
|
187
|
-
end
|
188
|
-
end
|
@@ -1,136 +0,0 @@
|
|
1
|
-
# File generated from our OpenAPI spec
|
2
|
-
# frozen_string_literal: true
|
3
|
-
|
4
|
-
module Stripe
|
5
|
-
# A quote line defines a set of changes, in the order provided, that will be applied upon quote acceptance.
|
6
|
-
class QuoteLine < APIResource
|
7
|
-
OBJECT_NAME = "quote_line"
|
8
|
-
def self.object_name
|
9
|
-
"quote_line"
|
10
|
-
end
|
11
|
-
|
12
|
-
class Action < Stripe::StripeObject
|
13
|
-
class AddDiscount < Stripe::StripeObject
|
14
|
-
class DiscountEnd < Stripe::StripeObject
|
15
|
-
attr_reader :type
|
16
|
-
end
|
17
|
-
attr_reader :coupon, :discount, :discount_end, :index, :promotion_code
|
18
|
-
end
|
19
|
-
|
20
|
-
class AddItem < Stripe::StripeObject
|
21
|
-
class Discount < Stripe::StripeObject
|
22
|
-
class DiscountEnd < Stripe::StripeObject
|
23
|
-
attr_reader :timestamp, :type
|
24
|
-
end
|
25
|
-
attr_reader :coupon, :discount, :discount_end, :promotion_code
|
26
|
-
end
|
27
|
-
|
28
|
-
class Trial < Stripe::StripeObject
|
29
|
-
attr_reader :converts_to, :type
|
30
|
-
end
|
31
|
-
attr_reader :discounts, :metadata, :price, :quantity, :tax_rates, :trial
|
32
|
-
end
|
33
|
-
|
34
|
-
class RemoveDiscount < Stripe::StripeObject
|
35
|
-
class DiscountEnd < Stripe::StripeObject
|
36
|
-
attr_reader :timestamp, :type
|
37
|
-
end
|
38
|
-
attr_reader :coupon, :discount, :discount_end, :promotion_code
|
39
|
-
end
|
40
|
-
|
41
|
-
class RemoveItem < Stripe::StripeObject
|
42
|
-
attr_reader :price
|
43
|
-
end
|
44
|
-
|
45
|
-
class SetDiscount < Stripe::StripeObject
|
46
|
-
class DiscountEnd < Stripe::StripeObject
|
47
|
-
attr_reader :timestamp, :type
|
48
|
-
end
|
49
|
-
attr_reader :coupon, :discount, :discount_end, :promotion_code
|
50
|
-
end
|
51
|
-
|
52
|
-
class SetItem < Stripe::StripeObject
|
53
|
-
class Discount < Stripe::StripeObject
|
54
|
-
class DiscountEnd < Stripe::StripeObject
|
55
|
-
attr_reader :timestamp, :type
|
56
|
-
end
|
57
|
-
attr_reader :coupon, :discount, :discount_end, :promotion_code
|
58
|
-
end
|
59
|
-
|
60
|
-
class Trial < Stripe::StripeObject
|
61
|
-
attr_reader :converts_to, :type
|
62
|
-
end
|
63
|
-
attr_reader :discounts, :metadata, :price, :quantity, :tax_rates, :trial
|
64
|
-
end
|
65
|
-
attr_reader :add_discount, :add_item, :add_metadata, :remove_discount, :remove_item, :remove_metadata, :set_discounts, :set_items, :set_metadata, :type
|
66
|
-
end
|
67
|
-
|
68
|
-
class AppliesTo < Stripe::StripeObject
|
69
|
-
attr_reader :new_reference, :subscription_schedule, :type
|
70
|
-
end
|
71
|
-
|
72
|
-
class CancelSubscriptionSchedule < Stripe::StripeObject
|
73
|
-
attr_reader :cancel_at, :invoice_now, :prorate
|
74
|
-
end
|
75
|
-
|
76
|
-
class EndsAt < Stripe::StripeObject
|
77
|
-
class DiscountEnd < Stripe::StripeObject
|
78
|
-
attr_reader :discount
|
79
|
-
end
|
80
|
-
|
81
|
-
class Duration < Stripe::StripeObject
|
82
|
-
attr_reader :interval, :interval_count
|
83
|
-
end
|
84
|
-
attr_reader :computed, :discount_end, :duration, :timestamp, :type
|
85
|
-
end
|
86
|
-
|
87
|
-
class SetPauseCollection < Stripe::StripeObject
|
88
|
-
class Set < Stripe::StripeObject
|
89
|
-
attr_reader :behavior
|
90
|
-
end
|
91
|
-
attr_reader :set, :type
|
92
|
-
end
|
93
|
-
|
94
|
-
class StartsAt < Stripe::StripeObject
|
95
|
-
class DiscountEnd < Stripe::StripeObject
|
96
|
-
attr_reader :discount
|
97
|
-
end
|
98
|
-
|
99
|
-
class LineEndsAt < Stripe::StripeObject
|
100
|
-
attr_reader :id
|
101
|
-
end
|
102
|
-
attr_reader :computed, :discount_end, :line_ends_at, :timestamp, :type
|
103
|
-
end
|
104
|
-
|
105
|
-
class TrialSettings < Stripe::StripeObject
|
106
|
-
class EndBehavior < Stripe::StripeObject
|
107
|
-
attr_reader :prorate_up_front
|
108
|
-
end
|
109
|
-
attr_reader :end_behavior
|
110
|
-
end
|
111
|
-
# A list of items the customer is being quoted for.
|
112
|
-
attr_reader :actions
|
113
|
-
# Details to identify the subscription schedule the quote line applies to.
|
114
|
-
attr_reader :applies_to
|
115
|
-
# For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
|
116
|
-
attr_reader :billing_cycle_anchor
|
117
|
-
# A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
|
118
|
-
attr_reader :cancel_subscription_schedule
|
119
|
-
# Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
|
120
|
-
attr_reader :ends_at
|
121
|
-
# Unique identifier for the object.
|
122
|
-
attr_reader :id
|
123
|
-
# String representing the object's type. Objects of the same type share the same value.
|
124
|
-
attr_reader :object
|
125
|
-
# Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
|
126
|
-
attr_reader :proration_behavior
|
127
|
-
# Details to modify the pause_collection behavior of the subscription schedule.
|
128
|
-
attr_reader :set_pause_collection
|
129
|
-
# Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
|
130
|
-
attr_reader :set_schedule_end
|
131
|
-
# Details to identify the earliest timestamp where the proposed change should take effect.
|
132
|
-
attr_reader :starts_at
|
133
|
-
# Settings related to subscription trials.
|
134
|
-
attr_reader :trial_settings
|
135
|
-
end
|
136
|
-
end
|