stripe 15.0.0 → 15.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/API_VERSION +1 -0
- data/CHANGELOG.md +129 -44
- data/CONTRIBUTING.md +25 -0
- data/Gemfile +1 -1
- data/OPENAPI_VERSION +1 -1
- data/README.md +28 -55
- data/VERSION +1 -1
- data/lib/stripe/api_operations/nested_resource.rb +35 -35
- data/lib/stripe/api_requestor.rb +1 -1
- data/lib/stripe/api_version.rb +2 -1
- data/lib/stripe/connection_manager.rb +1 -3
- data/lib/stripe/event_types.rb +1 -0
- data/lib/stripe/events/v1_billing_meter_error_report_triggered_event.rb +1 -1
- data/lib/stripe/events/v1_billing_meter_no_meter_found_event.rb +1 -1
- data/lib/stripe/events/v2_core_event_destination_ping_event.rb +21 -0
- data/lib/stripe/oauth.rb +1 -1
- data/lib/stripe/resources/account.rb +198 -28
- data/lib/stripe/resources/account_session.rb +176 -72
- data/lib/stripe/resources/apple_pay_domain.rb +1 -2
- data/lib/stripe/resources/balance.rb +42 -0
- data/lib/stripe/resources/balance_transaction.rb +2 -0
- data/lib/stripe/resources/bank_account.rb +2 -2
- data/lib/stripe/resources/billing_portal/session.rb +3 -3
- data/lib/stripe/resources/capability.rb +1 -1
- data/lib/stripe/resources/charge.rb +43 -20
- data/lib/stripe/resources/checkout/session.rb +120 -19
- data/lib/stripe/resources/confirmation_token.rb +119 -100
- data/lib/stripe/resources/country_spec.rb +1 -1
- data/lib/stripe/resources/coupon.rb +2 -3
- data/lib/stripe/resources/credit_note.rb +21 -18
- data/lib/stripe/resources/customer.rb +4 -6
- data/lib/stripe/resources/customer_session.rb +5 -5
- data/lib/stripe/resources/dispute.rb +2 -2
- data/lib/stripe/resources/event.rb +3 -1
- data/lib/stripe/resources/file.rb +1 -1
- data/lib/stripe/resources/funding_instructions.rb +1 -1
- data/lib/stripe/resources/identity/verification_report.rb +6 -0
- data/lib/stripe/resources/identity/verification_session.rb +51 -11
- data/lib/stripe/resources/invoice.rb +146 -32
- data/lib/stripe/resources/invoice_item.rb +3 -7
- data/lib/stripe/resources/invoice_line_item.rb +1 -1
- data/lib/stripe/resources/invoice_payment.rb +9 -2
- data/lib/stripe/resources/issuing/authorization.rb +8 -8
- data/lib/stripe/resources/issuing/card.rb +1 -1
- data/lib/stripe/resources/issuing/dispute.rb +3 -3
- data/lib/stripe/resources/login_link.rb +2 -1
- data/lib/stripe/resources/mandate.rb +3 -0
- data/lib/stripe/resources/payment_intent.rb +602 -325
- data/lib/stripe/resources/payment_method.rb +76 -117
- data/lib/stripe/resources/payment_method_configuration.rb +356 -2
- data/lib/stripe/resources/payment_method_domain.rb +15 -2
- data/lib/stripe/resources/payout.rb +4 -4
- data/lib/stripe/resources/person.rb +27 -3
- data/lib/stripe/resources/plan.rb +2 -3
- data/lib/stripe/resources/price.rb +1 -1
- data/lib/stripe/resources/product.rb +1 -2
- data/lib/stripe/resources/quote.rb +28 -3
- data/lib/stripe/resources/radar/value_list.rb +1 -2
- data/lib/stripe/resources/radar/value_list_item.rb +1 -2
- data/lib/stripe/resources/refund.rb +8 -1
- data/lib/stripe/resources/reversal.rb +1 -1
- data/lib/stripe/resources/review.rb +1 -1
- data/lib/stripe/resources/setup_attempt.rb +1 -1
- data/lib/stripe/resources/setup_intent.rb +414 -293
- data/lib/stripe/resources/source.rb +1 -1
- data/lib/stripe/resources/subscription.rb +149 -27
- data/lib/stripe/resources/subscription_item.rb +33 -0
- data/lib/stripe/resources/subscription_schedule.rb +141 -4
- data/lib/stripe/resources/tax/calculation.rb +6 -2
- data/lib/stripe/resources/tax/calculation_line_item.rb +2 -0
- data/lib/stripe/resources/tax/registration.rb +261 -1
- data/lib/stripe/resources/tax/transaction.rb +1 -1
- data/lib/stripe/resources/tax_id.rb +3 -4
- data/lib/stripe/resources/tax_rate.rb +2 -2
- data/lib/stripe/resources/terminal/configuration.rb +2 -2
- data/lib/stripe/resources/terminal/location.rb +2 -3
- data/lib/stripe/resources/terminal/reader.rb +426 -6
- data/lib/stripe/resources/test_helpers/test_clock.rb +1 -2
- data/lib/stripe/resources/token.rb +63 -2
- data/lib/stripe/resources/transfer.rb +1 -1
- data/lib/stripe/resources/treasury/financial_account.rb +5 -1
- data/lib/stripe/resources/v2/billing/meter_event.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb +2 -2
- data/lib/stripe/resources/v2/billing/meter_event_session.rb +2 -2
- data/lib/stripe/resources/v2/event.rb +2 -2
- data/lib/stripe/resources/v2/event_destination.rb +2 -2
- data/lib/stripe/resources/webhook_endpoint.rb +1 -2
- data/lib/stripe/resources.rb +1 -0
- data/lib/stripe/services/account_external_account_service.rb +3 -4
- data/lib/stripe/services/account_login_link_service.rb +1 -1
- data/lib/stripe/services/account_person_service.rb +85 -2
- data/lib/stripe/services/account_service.rb +169 -20
- data/lib/stripe/services/account_session_service.rb +115 -47
- data/lib/stripe/services/apple_pay_domain_service.rb +1 -2
- data/lib/stripe/services/application_fee_service.rb +1 -1
- data/lib/stripe/services/apps_service.rb +1 -1
- data/lib/stripe/services/balance_service.rb +1 -1
- data/lib/stripe/services/billing/meter_service.rb +1 -1
- data/lib/stripe/services/billing_portal/session_service.rb +1 -1
- data/lib/stripe/services/billing_portal_service.rb +1 -1
- data/lib/stripe/services/billing_service.rb +1 -1
- data/lib/stripe/services/charge_service.rb +4 -4
- data/lib/stripe/services/checkout/session_service.rb +94 -15
- data/lib/stripe/services/checkout_service.rb +1 -1
- data/lib/stripe/services/climate_service.rb +1 -1
- data/lib/stripe/services/coupon_service.rb +1 -2
- data/lib/stripe/services/credit_note_preview_lines_service.rb +3 -3
- data/lib/stripe/services/credit_note_service.rb +14 -15
- data/lib/stripe/services/customer_balance_transaction_service.rb +3 -3
- data/lib/stripe/services/customer_cash_balance_transaction_service.rb +2 -2
- data/lib/stripe/services/customer_payment_method_service.rb +1 -1
- data/lib/stripe/services/customer_payment_source_service.rb +1 -1
- data/lib/stripe/services/customer_service.rb +5 -7
- data/lib/stripe/services/customer_session_service.rb +1 -1
- data/lib/stripe/services/customer_tax_id_service.rb +2 -3
- data/lib/stripe/services/dispute_service.rb +1 -1
- data/lib/stripe/services/entitlements_service.rb +1 -1
- data/lib/stripe/services/file_service.rb +1 -1
- data/lib/stripe/services/financial_connections/account_service.rb +1 -1
- data/lib/stripe/services/financial_connections_service.rb +1 -1
- data/lib/stripe/services/forwarding_service.rb +1 -1
- data/lib/stripe/services/identity/verification_session_service.rb +21 -5
- data/lib/stripe/services/identity_service.rb +1 -1
- data/lib/stripe/services/invoice_item_service.rb +1 -2
- data/lib/stripe/services/invoice_service.rb +122 -28
- data/lib/stripe/services/issuing/authorization_service.rb +4 -4
- data/lib/stripe/services/issuing/card_service.rb +1 -1
- data/lib/stripe/services/issuing/dispute_service.rb +2 -2
- data/lib/stripe/services/issuing_service.rb +1 -1
- data/lib/stripe/services/payment_intent_service.rb +563 -313
- data/lib/stripe/services/payment_link_service.rb +1 -1
- data/lib/stripe/services/payment_method_configuration_service.rb +254 -2
- data/lib/stripe/services/payment_method_domain_service.rb +1 -1
- data/lib/stripe/services/payment_method_service.rb +59 -105
- data/lib/stripe/services/payout_service.rb +2 -2
- data/lib/stripe/services/plan_service.rb +2 -3
- data/lib/stripe/services/price_service.rb +2 -2
- data/lib/stripe/services/product_feature_service.rb +1 -2
- data/lib/stripe/services/product_service.rb +3 -4
- data/lib/stripe/services/promotion_code_service.rb +1 -1
- data/lib/stripe/services/quote_service.rb +21 -4
- data/lib/stripe/services/radar/early_fraud_warning_service.rb +1 -1
- data/lib/stripe/services/radar/value_list_item_service.rb +1 -2
- data/lib/stripe/services/radar/value_list_service.rb +1 -2
- data/lib/stripe/services/radar_service.rb +1 -1
- data/lib/stripe/services/reporting_service.rb +1 -1
- data/lib/stripe/services/setup_intent_service.rb +403 -291
- data/lib/stripe/services/sigma_service.rb +1 -1
- data/lib/stripe/services/source_service.rb +2 -2
- data/lib/stripe/services/subscription_item_service.rb +26 -0
- data/lib/stripe/services/subscription_schedule_service.rb +106 -3
- data/lib/stripe/services/subscription_service.rb +121 -26
- data/lib/stripe/services/tax/calculation_service.rb +6 -2
- data/lib/stripe/services/tax/registration_service.rb +170 -1
- data/lib/stripe/services/tax/transaction_service.rb +1 -1
- data/lib/stripe/services/tax_id_service.rb +2 -3
- data/lib/stripe/services/tax_service.rb +1 -1
- data/lib/stripe/services/terminal/configuration_service.rb +1 -2
- data/lib/stripe/services/terminal/location_service.rb +2 -3
- data/lib/stripe/services/terminal/reader_service.rb +196 -2
- data/lib/stripe/services/terminal_service.rb +1 -1
- data/lib/stripe/services/test_helpers/confirmation_token_service.rb +90 -91
- data/lib/stripe/services/test_helpers/issuing_service.rb +1 -1
- data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
- data/lib/stripe/services/test_helpers/terminal_service.rb +1 -1
- data/lib/stripe/services/test_helpers/test_clock_service.rb +1 -2
- data/lib/stripe/services/test_helpers/treasury_service.rb +1 -1
- data/lib/stripe/services/test_helpers_service.rb +1 -1
- data/lib/stripe/services/token_service.rb +62 -1
- data/lib/stripe/services/transfer_service.rb +2 -2
- data/lib/stripe/services/treasury/financial_account_service.rb +6 -2
- data/lib/stripe/services/treasury_service.rb +1 -1
- data/lib/stripe/services/v1_services.rb +1 -1
- data/lib/stripe/services/v2/billing/meter_event_session_service.rb +1 -2
- data/lib/stripe/services/v2/billing_service.rb +3 -3
- data/lib/stripe/services/v2/core/event_destination_service.rb +17 -23
- data/lib/stripe/services/v2/core/event_service.rb +1 -2
- data/lib/stripe/services/v2/core_service.rb +1 -1
- data/lib/stripe/services/v2_services.rb +1 -1
- data/lib/stripe/services/webhook_endpoint_service.rb +1 -2
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe/webhook.rb +1 -1
- data/rbi/stripe/resources/account.rbi +190 -35
- data/rbi/stripe/resources/account_session.rbi +196 -77
- data/rbi/stripe/resources/apple_pay_domain.rbi +1 -3
- data/rbi/stripe/resources/balance.rbi +55 -0
- data/rbi/stripe/resources/balance_transaction.rbi +3 -0
- data/rbi/stripe/resources/bank_account.rbi +2 -2
- data/rbi/stripe/resources/billing/alert.rbi +2 -2
- data/rbi/stripe/resources/billing_portal/session.rbi +3 -3
- data/rbi/stripe/resources/capability.rbi +1 -1
- data/rbi/stripe/resources/charge.rbi +52 -20
- data/rbi/stripe/resources/checkout/session.rbi +133 -24
- data/rbi/stripe/resources/confirmation_token.rbi +140 -115
- data/rbi/stripe/resources/country_spec.rbi +1 -1
- data/rbi/stripe/resources/coupon.rbi +2 -4
- data/rbi/stripe/resources/credit_note.rbi +23 -18
- data/rbi/stripe/resources/customer.rbi +4 -8
- data/rbi/stripe/resources/customer_session.rbi +5 -5
- data/rbi/stripe/resources/dispute.rbi +2 -2
- data/rbi/stripe/resources/event.rbi +4 -1
- data/rbi/stripe/resources/file.rbi +1 -1
- data/rbi/stripe/resources/identity/verification_report.rbi +9 -0
- data/rbi/stripe/resources/identity/verification_session.rbi +59 -12
- data/rbi/stripe/resources/invoice.rbi +149 -40
- data/rbi/stripe/resources/invoice_item.rbi +3 -8
- data/rbi/stripe/resources/invoice_line_item.rbi +2 -2
- data/rbi/stripe/resources/invoice_payment.rbi +9 -2
- data/rbi/stripe/resources/issuing/authorization.rbi +8 -8
- data/rbi/stripe/resources/issuing/card.rbi +1 -1
- data/rbi/stripe/resources/issuing/dispute.rbi +3 -3
- data/rbi/stripe/resources/login_link.rbi +2 -1
- data/rbi/stripe/resources/mandate.rbi +4 -0
- data/rbi/stripe/resources/payment_intent.rbi +637 -381
- data/rbi/stripe/resources/payment_method.rbi +81 -133
- data/rbi/stripe/resources/payment_method_configuration.rbi +400 -4
- data/rbi/stripe/resources/payment_method_domain.rbi +18 -2
- data/rbi/stripe/resources/payout.rbi +4 -4
- data/rbi/stripe/resources/person.rbi +33 -3
- data/rbi/stripe/resources/plan.rbi +2 -4
- data/rbi/stripe/resources/price.rbi +1 -1
- data/rbi/stripe/resources/product.rbi +1 -3
- data/rbi/stripe/resources/quote.rbi +25 -3
- data/rbi/stripe/resources/radar/value_list.rbi +1 -3
- data/rbi/stripe/resources/radar/value_list_item.rbi +1 -3
- data/rbi/stripe/resources/refund.rbi +8 -1
- data/rbi/stripe/resources/reversal.rbi +1 -1
- data/rbi/stripe/resources/review.rbi +1 -1
- data/rbi/stripe/resources/setup_attempt.rbi +1 -1
- data/rbi/stripe/resources/setup_intent.rbi +464 -346
- data/rbi/stripe/resources/source.rbi +1 -1
- data/rbi/stripe/resources/subscription.rbi +150 -34
- data/rbi/stripe/resources/subscription_item.rbi +36 -2
- data/rbi/stripe/resources/subscription_schedule.rbi +161 -11
- data/rbi/stripe/resources/tax/calculation.rbi +7 -3
- data/rbi/stripe/resources/tax/calculation_line_item.rbi +4 -1
- data/rbi/stripe/resources/tax/registration.rbi +249 -2
- data/rbi/stripe/resources/tax/transaction.rbi +1 -1
- data/rbi/stripe/resources/tax_id.rbi +3 -5
- data/rbi/stripe/resources/tax_rate.rbi +2 -2
- data/rbi/stripe/resources/terminal/configuration.rbi +2 -3
- data/rbi/stripe/resources/terminal/location.rbi +4 -6
- data/rbi/stripe/resources/terminal/reader.rbi +415 -8
- data/rbi/stripe/resources/test_helpers/test_clock.rbi +1 -3
- data/rbi/stripe/resources/token.rbi +70 -4
- data/rbi/stripe/resources/transfer.rbi +1 -1
- data/rbi/stripe/resources/treasury/financial_account.rbi +6 -2
- data/rbi/stripe/resources/v2/billing/meter_event.rbi +3 -3
- data/rbi/stripe/resources/v2/billing/meter_event_adjustment.rbi +3 -3
- data/rbi/stripe/resources/v2/billing/meter_event_session.rbi +3 -3
- data/rbi/stripe/resources/v2/event.rbi +3 -3
- data/rbi/stripe/resources/v2/event_destination.rbi +3 -3
- data/rbi/stripe/resources/webhook_endpoint.rbi +1 -3
- data/rbi/stripe/services/account_external_account_service.rbi +3 -5
- data/rbi/stripe/services/account_login_link_service.rbi +1 -1
- data/rbi/stripe/services/account_person_service.rbi +93 -5
- data/rbi/stripe/services/account_service.rbi +166 -28
- data/rbi/stripe/services/account_session_service.rbi +126 -52
- data/rbi/stripe/services/apple_pay_domain_service.rbi +1 -3
- data/rbi/stripe/services/balance_service.rbi +1 -1
- data/rbi/stripe/services/billing/alert_service.rbi +2 -2
- data/rbi/stripe/services/billing_portal/session_service.rbi +1 -1
- data/rbi/stripe/services/charge_service.rbi +4 -4
- data/rbi/stripe/services/checkout/session_service.rbi +104 -19
- data/rbi/stripe/services/coupon_service.rbi +1 -3
- data/rbi/stripe/services/credit_note_preview_lines_service.rbi +3 -3
- data/rbi/stripe/services/credit_note_service.rbi +13 -14
- data/rbi/stripe/services/customer_balance_transaction_service.rbi +3 -3
- data/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +2 -2
- data/rbi/stripe/services/customer_payment_method_service.rbi +1 -1
- data/rbi/stripe/services/customer_payment_source_service.rbi +1 -1
- data/rbi/stripe/services/customer_service.rbi +4 -8
- data/rbi/stripe/services/customer_session_service.rbi +1 -1
- data/rbi/stripe/services/customer_tax_id_service.rbi +2 -4
- data/rbi/stripe/services/dispute_service.rbi +1 -1
- data/rbi/stripe/services/file_service.rbi +1 -1
- data/rbi/stripe/services/identity/verification_session_service.rbi +22 -6
- data/rbi/stripe/services/invoice_item_service.rbi +1 -3
- data/rbi/stripe/services/invoice_service.rbi +126 -35
- data/rbi/stripe/services/issuing/authorization_service.rbi +4 -4
- data/rbi/stripe/services/issuing/card_service.rbi +1 -1
- data/rbi/stripe/services/issuing/dispute_service.rbi +2 -2
- data/rbi/stripe/services/payment_intent_service.rbi +599 -369
- data/rbi/stripe/services/payment_method_configuration_service.rbi +280 -4
- data/rbi/stripe/services/payment_method_domain_service.rbi +1 -1
- data/rbi/stripe/services/payment_method_service.rbi +62 -121
- data/rbi/stripe/services/payout_service.rbi +2 -2
- data/rbi/stripe/services/plan_service.rbi +2 -4
- data/rbi/stripe/services/price_service.rbi +2 -2
- data/rbi/stripe/services/product_feature_service.rbi +1 -3
- data/rbi/stripe/services/product_service.rbi +2 -4
- data/rbi/stripe/services/promotion_code_service.rbi +1 -1
- data/rbi/stripe/services/quote_service.rbi +16 -3
- data/rbi/stripe/services/radar/early_fraud_warning_service.rbi +1 -1
- data/rbi/stripe/services/radar/value_list_item_service.rbi +1 -3
- data/rbi/stripe/services/radar/value_list_service.rbi +1 -3
- data/rbi/stripe/services/setup_intent_service.rbi +457 -344
- data/rbi/stripe/services/source_service.rbi +1 -1
- data/rbi/stripe/services/subscription_item_service.rbi +28 -2
- data/rbi/stripe/services/subscription_schedule_service.rbi +119 -10
- data/rbi/stripe/services/subscription_service.rbi +121 -33
- data/rbi/stripe/services/tax/calculation_service.rbi +6 -2
- data/rbi/stripe/services/tax/registration_service.rbi +171 -2
- data/rbi/stripe/services/tax_id_service.rbi +2 -4
- data/rbi/stripe/services/terminal/configuration_service.rbi +1 -3
- data/rbi/stripe/services/terminal/location_service.rbi +4 -6
- data/rbi/stripe/services/terminal/reader_service.rbi +200 -4
- data/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +106 -106
- data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +31 -0
- data/rbi/stripe/services/test_helpers/test_clock_service.rbi +1 -3
- data/rbi/stripe/services/token_service.rbi +71 -3
- data/rbi/stripe/services/transfer_service.rbi +1 -1
- data/rbi/stripe/services/treasury/financial_account_service.rbi +6 -2
- data/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +1 -3
- data/rbi/stripe/services/v2/billing_service.rbi +1 -1
- data/rbi/stripe/services/v2/core/event_destination_service.rbi +14 -22
- data/rbi/stripe/services/v2/core/event_service.rbi +1 -3
- data/rbi/stripe/services/webhook_endpoint_service.rbi +1 -3
- metadata +5 -2
@@ -1181,6 +1181,45 @@ module Stripe
|
|
1181
1181
|
def initialize(capture_method: nil, setup_future_usage: nil); end
|
1182
1182
|
end
|
1183
1183
|
class Klarna < Stripe::RequestParams
|
1184
|
+
class Subscription < Stripe::RequestParams
|
1185
|
+
class NextBilling < Stripe::RequestParams
|
1186
|
+
# The amount of the next charge for the subscription.
|
1187
|
+
sig { returns(Integer) }
|
1188
|
+
attr_accessor :amount
|
1189
|
+
# The date of the next charge for the subscription in YYYY-MM-DD format.
|
1190
|
+
sig { returns(String) }
|
1191
|
+
attr_accessor :date
|
1192
|
+
sig { params(amount: Integer, date: String).void }
|
1193
|
+
def initialize(amount: nil, date: nil); end
|
1194
|
+
end
|
1195
|
+
# Unit of time between subscription charges.
|
1196
|
+
sig { returns(String) }
|
1197
|
+
attr_accessor :interval
|
1198
|
+
# The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
|
1199
|
+
sig { returns(T.nilable(Integer)) }
|
1200
|
+
attr_accessor :interval_count
|
1201
|
+
# Name for subscription.
|
1202
|
+
sig { returns(T.nilable(String)) }
|
1203
|
+
attr_accessor :name
|
1204
|
+
# Describes the upcoming charge for this subscription.
|
1205
|
+
sig {
|
1206
|
+
returns(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling)
|
1207
|
+
}
|
1208
|
+
attr_accessor :next_billing
|
1209
|
+
# A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
|
1210
|
+
sig { returns(String) }
|
1211
|
+
attr_accessor :reference
|
1212
|
+
sig {
|
1213
|
+
params(interval: String, interval_count: T.nilable(Integer), name: T.nilable(String), next_billing: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription::NextBilling, reference: String).void
|
1214
|
+
}
|
1215
|
+
def initialize(
|
1216
|
+
interval: nil,
|
1217
|
+
interval_count: nil,
|
1218
|
+
name: nil,
|
1219
|
+
next_billing: nil,
|
1220
|
+
reference: nil
|
1221
|
+
); end
|
1222
|
+
end
|
1184
1223
|
# Indicates that you intend to make future payments with this PaymentIntent's payment method.
|
1185
1224
|
#
|
1186
1225
|
# If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
|
@@ -1190,8 +1229,15 @@ module Stripe
|
|
1190
1229
|
# When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
|
1191
1230
|
sig { returns(T.nilable(String)) }
|
1192
1231
|
attr_accessor :setup_future_usage
|
1193
|
-
|
1194
|
-
|
1232
|
+
# Subscription details if the Checkout Session sets up a future subscription.
|
1233
|
+
sig {
|
1234
|
+
returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription]))))
|
1235
|
+
}
|
1236
|
+
attr_accessor :subscriptions
|
1237
|
+
sig {
|
1238
|
+
params(setup_future_usage: T.nilable(String), subscriptions: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::Klarna::Subscription])))).void
|
1239
|
+
}
|
1240
|
+
def initialize(setup_future_usage: nil, subscriptions: nil); end
|
1195
1241
|
end
|
1196
1242
|
class Konbini < Stripe::RequestParams
|
1197
1243
|
# The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
|
@@ -1322,9 +1368,7 @@ module Stripe
|
|
1322
1368
|
}
|
1323
1369
|
def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end
|
1324
1370
|
end
|
1325
|
-
class PayByBank < Stripe::RequestParams
|
1326
|
-
|
1327
|
-
end
|
1371
|
+
class PayByBank < Stripe::RequestParams; end
|
1328
1372
|
class Payco < Stripe::RequestParams
|
1329
1373
|
# Controls when the funds will be captured from the customer's account.
|
1330
1374
|
sig { returns(T.nilable(String)) }
|
@@ -1785,13 +1829,20 @@ module Stripe
|
|
1785
1829
|
# Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout.
|
1786
1830
|
sig { returns(T.nilable(T::Array[String])) }
|
1787
1831
|
attr_accessor :allow_redisplay_filters
|
1832
|
+
# Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
|
1833
|
+
sig { returns(T.nilable(String)) }
|
1834
|
+
attr_accessor :payment_method_remove
|
1788
1835
|
# Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
|
1789
1836
|
sig { returns(T.nilable(String)) }
|
1790
1837
|
attr_accessor :payment_method_save
|
1791
1838
|
sig {
|
1792
|
-
params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_save: T.nilable(String)).void
|
1839
|
+
params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String)).void
|
1793
1840
|
}
|
1794
|
-
def initialize(
|
1841
|
+
def initialize(
|
1842
|
+
allow_redisplay_filters: nil,
|
1843
|
+
payment_method_remove: nil,
|
1844
|
+
payment_method_save: nil
|
1845
|
+
); end
|
1795
1846
|
end
|
1796
1847
|
class SetupIntentData < Stripe::RequestParams
|
1797
1848
|
# An arbitrary string attached to the object. Often useful for displaying to users.
|
@@ -1933,6 +1984,13 @@ module Stripe
|
|
1933
1984
|
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
|
1934
1985
|
end
|
1935
1986
|
class SubscriptionData < Stripe::RequestParams
|
1987
|
+
class BillingMode < Stripe::RequestParams
|
1988
|
+
# Attribute for param field type
|
1989
|
+
sig { returns(String) }
|
1990
|
+
attr_accessor :type
|
1991
|
+
sig { params(type: String).void }
|
1992
|
+
def initialize(type: nil); end
|
1993
|
+
end
|
1936
1994
|
class InvoiceSettings < Stripe::RequestParams
|
1937
1995
|
class Issuer < Stripe::RequestParams
|
1938
1996
|
# The connected account being referenced when `type` is `account`.
|
@@ -1988,6 +2046,11 @@ module Stripe
|
|
1988
2046
|
# A future timestamp to anchor the subscription's billing cycle for new subscriptions.
|
1989
2047
|
sig { returns(T.nilable(Integer)) }
|
1990
2048
|
attr_accessor :billing_cycle_anchor
|
2049
|
+
# Controls how prorations and invoices for subscriptions are calculated and orchestrated.
|
2050
|
+
sig {
|
2051
|
+
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode))
|
2052
|
+
}
|
2053
|
+
attr_accessor :billing_mode
|
1991
2054
|
# The tax rates that will apply to any subscription item that does not have
|
1992
2055
|
# `tax_rates` set. Invoices created will have their `default_tax_rates` populated
|
1993
2056
|
# from the subscription.
|
@@ -2017,13 +2080,10 @@ module Stripe
|
|
2017
2080
|
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData))
|
2018
2081
|
}
|
2019
2082
|
attr_accessor :transfer_data
|
2020
|
-
# Unix timestamp representing the end of the trial period the customer
|
2021
|
-
# will get before being charged for the first time. Has to be at least
|
2022
|
-
# 48 hours in the future.
|
2083
|
+
# Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
|
2023
2084
|
sig { returns(T.nilable(Integer)) }
|
2024
2085
|
attr_accessor :trial_end
|
2025
|
-
# Integer representing the number of trial period days before the
|
2026
|
-
# customer is charged for the first time. Has to be at least 1.
|
2086
|
+
# Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
|
2027
2087
|
sig { returns(T.nilable(Integer)) }
|
2028
2088
|
attr_accessor :trial_period_days
|
2029
2089
|
# Settings related to subscription trials.
|
@@ -2032,11 +2092,12 @@ module Stripe
|
|
2032
2092
|
}
|
2033
2093
|
attr_accessor :trial_settings
|
2034
2094
|
sig {
|
2035
|
-
params(application_fee_percent: T.nilable(Float), billing_cycle_anchor: T.nilable(Integer), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData), trial_end: T.nilable(Integer), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)).void
|
2095
|
+
params(application_fee_percent: T.nilable(Float), billing_cycle_anchor: T.nilable(Integer), billing_mode: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::BillingMode), default_tax_rates: T.nilable(T::Array[String]), description: T.nilable(String), invoice_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::InvoiceSettings), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TransferData), trial_end: T.nilable(Integer), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData::TrialSettings)).void
|
2036
2096
|
}
|
2037
2097
|
def initialize(
|
2038
2098
|
application_fee_percent: nil,
|
2039
2099
|
billing_cycle_anchor: nil,
|
2100
|
+
billing_mode: nil,
|
2040
2101
|
default_tax_rates: nil,
|
2041
2102
|
description: nil,
|
2042
2103
|
invoice_settings: nil,
|
@@ -2059,6 +2120,24 @@ module Stripe
|
|
2059
2120
|
sig { params(enabled: T::Boolean, required: T.nilable(String)).void }
|
2060
2121
|
def initialize(enabled: nil, required: nil); end
|
2061
2122
|
end
|
2123
|
+
class WalletOptions < Stripe::RequestParams
|
2124
|
+
class Link < Stripe::RequestParams
|
2125
|
+
# Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.
|
2126
|
+
sig { returns(T.nilable(String)) }
|
2127
|
+
attr_accessor :display
|
2128
|
+
sig { params(display: T.nilable(String)).void }
|
2129
|
+
def initialize(display: nil); end
|
2130
|
+
end
|
2131
|
+
# contains details about the Link wallet options.
|
2132
|
+
sig {
|
2133
|
+
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link))
|
2134
|
+
}
|
2135
|
+
attr_accessor :link
|
2136
|
+
sig {
|
2137
|
+
params(link: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions::Link)).void
|
2138
|
+
}
|
2139
|
+
def initialize(link: nil); end
|
2140
|
+
end
|
2062
2141
|
# Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
|
2063
2142
|
sig {
|
2064
2143
|
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing))
|
@@ -2152,7 +2231,7 @@ module Stripe
|
|
2152
2231
|
returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation))
|
2153
2232
|
}
|
2154
2233
|
attr_accessor :invoice_creation
|
2155
|
-
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
|
2234
|
+
# A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). The parameter is required for `payment` and `subscription` mode.
|
2156
2235
|
#
|
2157
2236
|
# For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
|
2158
2237
|
#
|
@@ -2220,9 +2299,9 @@ module Stripe
|
|
2220
2299
|
# other characteristics.
|
2221
2300
|
sig { returns(T.nilable(T::Array[String])) }
|
2222
2301
|
attr_accessor :payment_method_types
|
2223
|
-
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object.
|
2302
|
+
# This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.
|
2224
2303
|
#
|
2225
|
-
# For specific permissions, please refer to their dedicated subsections, such as `permissions.
|
2304
|
+
# For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
|
2226
2305
|
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions)) }
|
2227
2306
|
attr_accessor :permissions
|
2228
2307
|
# Controls phone number collection settings for the session.
|
@@ -2287,8 +2366,11 @@ module Stripe
|
|
2287
2366
|
# The UI mode of the Session. Defaults to `hosted`.
|
2288
2367
|
sig { returns(T.nilable(String)) }
|
2289
2368
|
attr_accessor :ui_mode
|
2369
|
+
# Wallet-specific configuration.
|
2370
|
+
sig { returns(T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)) }
|
2371
|
+
attr_accessor :wallet_options
|
2290
2372
|
sig {
|
2291
|
-
params(adaptive_pricing: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), cancel_url: T.nilable(String), client_reference_id: T.nilable(String), consent_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText), customer: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]), locale: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), mode: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection), ui_mode: T.nilable(String)).void
|
2373
|
+
params(adaptive_pricing: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AdaptivePricing), after_expiration: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AfterExpiration), allow_promotion_codes: T.nilable(T::Boolean), automatic_tax: T.nilable(::Stripe::Checkout::SessionService::CreateParams::AutomaticTax), billing_address_collection: T.nilable(String), cancel_url: T.nilable(String), client_reference_id: T.nilable(String), consent_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ConsentCollection), currency: T.nilable(String), custom_fields: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::CustomField]), custom_text: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomText), customer: T.nilable(String), customer_creation: T.nilable(String), customer_email: T.nilable(String), customer_update: T.nilable(::Stripe::Checkout::SessionService::CreateParams::CustomerUpdate), discounts: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::Discount]), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), invoice_creation: T.nilable(::Stripe::Checkout::SessionService::CreateParams::InvoiceCreation), line_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::LineItem]), locale: T.nilable(String), metadata: T.nilable(T::Hash[String, String]), mode: T.nilable(String), optional_items: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::OptionalItem]), payment_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentIntentData), payment_method_collection: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodData), payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), permissions: T.nilable(::Stripe::Checkout::SessionService::CreateParams::Permissions), phone_number_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::PhoneNumberCollection), redirect_on_completion: T.nilable(String), return_url: T.nilable(String), saved_payment_method_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SavedPaymentMethodOptions), setup_intent_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SetupIntentData), shipping_address_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::ShippingAddressCollection), shipping_options: T.nilable(T::Array[::Stripe::Checkout::SessionService::CreateParams::ShippingOption]), submit_type: T.nilable(String), subscription_data: T.nilable(::Stripe::Checkout::SessionService::CreateParams::SubscriptionData), success_url: T.nilable(String), tax_id_collection: T.nilable(::Stripe::Checkout::SessionService::CreateParams::TaxIdCollection), ui_mode: T.nilable(String), wallet_options: T.nilable(::Stripe::Checkout::SessionService::CreateParams::WalletOptions)).void
|
2292
2374
|
}
|
2293
2375
|
def initialize(
|
2294
2376
|
adaptive_pricing: nil,
|
@@ -2333,7 +2415,8 @@ module Stripe
|
|
2333
2415
|
subscription_data: nil,
|
2334
2416
|
success_url: nil,
|
2335
2417
|
tax_id_collection: nil,
|
2336
|
-
ui_mode: nil
|
2418
|
+
ui_mode: nil,
|
2419
|
+
wallet_options: nil
|
2337
2420
|
); end
|
2338
2421
|
end
|
2339
2422
|
class RetrieveParams < Stripe::RequestParams
|
@@ -2516,7 +2599,7 @@ module Stripe
|
|
2516
2599
|
}
|
2517
2600
|
def initialize(shipping_rate: nil, shipping_rate_data: nil); end
|
2518
2601
|
end
|
2519
|
-
# Information about the customer collected within the Checkout Session.
|
2602
|
+
# Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
|
2520
2603
|
sig {
|
2521
2604
|
returns(T.nilable(::Stripe::Checkout::SessionService::UpdateParams::CollectedInformation))
|
2522
2605
|
}
|
@@ -2576,6 +2659,8 @@ module Stripe
|
|
2576
2659
|
def retrieve(session, params = {}, opts = {}); end
|
2577
2660
|
|
2578
2661
|
# Updates a Checkout Session object.
|
2662
|
+
#
|
2663
|
+
# Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
|
2579
2664
|
sig {
|
2580
2665
|
params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session)
|
2581
2666
|
}
|
@@ -4,9 +4,7 @@
|
|
4
4
|
# typed: true
|
5
5
|
module Stripe
|
6
6
|
class CouponService < StripeService
|
7
|
-
class DeleteParams < Stripe::RequestParams
|
8
|
-
|
9
|
-
end
|
7
|
+
class DeleteParams < Stripe::RequestParams; end
|
10
8
|
class RetrieveParams < Stripe::RequestParams
|
11
9
|
# Specifies which fields in the response should be expanded.
|
12
10
|
sig { returns(T.nilable(T::Array[String])) }
|
@@ -80,7 +80,7 @@ module Stripe
|
|
80
80
|
sig { params(shipping_rate: T.nilable(String)).void }
|
81
81
|
def initialize(shipping_rate: nil); end
|
82
82
|
end
|
83
|
-
# The integer amount in cents (or local equivalent) representing the total amount of the credit note.
|
83
|
+
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
84
84
|
sig { returns(T.nilable(Integer)) }
|
85
85
|
attr_accessor :amount
|
86
86
|
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
|
@@ -104,7 +104,7 @@ module Stripe
|
|
104
104
|
# A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
|
105
105
|
sig { returns(T.nilable(Integer)) }
|
106
106
|
attr_accessor :limit
|
107
|
-
# Line items that make up the credit note.
|
107
|
+
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
108
108
|
sig {
|
109
109
|
returns(T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Line]))
|
110
110
|
}
|
@@ -129,7 +129,7 @@ module Stripe
|
|
129
129
|
returns(T.nilable(T::Array[::Stripe::CreditNotePreviewLinesService::ListParams::Refund]))
|
130
130
|
}
|
131
131
|
attr_accessor :refunds
|
132
|
-
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
|
132
|
+
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
133
133
|
sig { returns(T.nilable(::Stripe::CreditNotePreviewLinesService::ListParams::ShippingCost)) }
|
134
134
|
attr_accessor :shipping_cost
|
135
135
|
# A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
|
@@ -135,7 +135,7 @@ module Stripe
|
|
135
135
|
sig { params(shipping_rate: T.nilable(String)).void }
|
136
136
|
def initialize(shipping_rate: nil); end
|
137
137
|
end
|
138
|
-
# The integer amount in cents (or local equivalent) representing the total amount of the credit note.
|
138
|
+
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
139
139
|
sig { returns(T.nilable(Integer)) }
|
140
140
|
attr_accessor :amount
|
141
141
|
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
|
@@ -153,7 +153,7 @@ module Stripe
|
|
153
153
|
# ID of the invoice.
|
154
154
|
sig { returns(String) }
|
155
155
|
attr_accessor :invoice
|
156
|
-
# Line items that make up the credit note.
|
156
|
+
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
157
157
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Line])) }
|
158
158
|
attr_accessor :lines
|
159
159
|
# The credit note's memo appears on the credit note PDF.
|
@@ -174,7 +174,7 @@ module Stripe
|
|
174
174
|
# Refunds to link to this credit note.
|
175
175
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::CreateParams::Refund])) }
|
176
176
|
attr_accessor :refunds
|
177
|
-
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
|
177
|
+
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
178
178
|
sig { returns(T.nilable(::Stripe::CreditNoteService::CreateParams::ShippingCost)) }
|
179
179
|
attr_accessor :shipping_cost
|
180
180
|
sig {
|
@@ -295,7 +295,7 @@ module Stripe
|
|
295
295
|
sig { params(shipping_rate: T.nilable(String)).void }
|
296
296
|
def initialize(shipping_rate: nil); end
|
297
297
|
end
|
298
|
-
# The integer amount in cents (or local equivalent) representing the total amount of the credit note.
|
298
|
+
# The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
299
299
|
sig { returns(T.nilable(Integer)) }
|
300
300
|
attr_accessor :amount
|
301
301
|
# The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
|
@@ -313,7 +313,7 @@ module Stripe
|
|
313
313
|
# ID of the invoice.
|
314
314
|
sig { returns(String) }
|
315
315
|
attr_accessor :invoice
|
316
|
-
# Line items that make up the credit note.
|
316
|
+
# Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
317
317
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Line])) }
|
318
318
|
attr_accessor :lines
|
319
319
|
# The credit note's memo appears on the credit note PDF.
|
@@ -334,7 +334,7 @@ module Stripe
|
|
334
334
|
# Refunds to link to this credit note.
|
335
335
|
sig { returns(T.nilable(T::Array[::Stripe::CreditNoteService::PreviewParams::Refund])) }
|
336
336
|
attr_accessor :refunds
|
337
|
-
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.
|
337
|
+
# When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
|
338
338
|
sig { returns(T.nilable(::Stripe::CreditNoteService::PreviewParams::ShippingCost)) }
|
339
339
|
attr_accessor :shipping_cost
|
340
340
|
sig {
|
@@ -364,20 +364,19 @@ module Stripe
|
|
364
364
|
sig { params(expand: T.nilable(T::Array[String])).void }
|
365
365
|
def initialize(expand: nil); end
|
366
366
|
end
|
367
|
-
# Issue a credit note to adjust the amount of a finalized invoice.
|
368
|
-
#
|
369
|
-
# in any combination of the following:
|
367
|
+
# Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero.
|
368
|
+
# This amount is indicated by the credit note's pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
|
370
369
|
#
|
371
370
|
#
|
372
|
-
#
|
371
|
+
# Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
|
373
372
|
# Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
|
374
373
|
# Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
|
375
374
|
#
|
376
375
|
#
|
377
|
-
#
|
376
|
+
# The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
|
378
377
|
#
|
379
|
-
# You may issue multiple credit notes for an invoice. Each credit note
|
380
|
-
# or
|
378
|
+
# You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount,
|
379
|
+
# post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation.
|
381
380
|
sig {
|
382
381
|
params(params: T.any(::Stripe::CreditNoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
|
383
382
|
}
|
@@ -407,7 +406,7 @@ module Stripe
|
|
407
406
|
}
|
408
407
|
def update(id, params = {}, opts = {}); end
|
409
408
|
|
410
|
-
# Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
|
409
|
+
# Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding).
|
411
410
|
sig {
|
412
411
|
params(id: String, params: T.any(::Stripe::CreditNoteService::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote)
|
413
412
|
}
|
@@ -65,19 +65,19 @@ module Stripe
|
|
65
65
|
}
|
66
66
|
def initialize(description: nil, expand: nil, metadata: nil); end
|
67
67
|
end
|
68
|
-
# Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).
|
68
|
+
# Creates an immutable transaction that updates the customer's credit [balance](https://docs.stripe.com/docs/billing/customer/balance).
|
69
69
|
sig {
|
70
70
|
params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
|
71
71
|
}
|
72
72
|
def create(customer, params = {}, opts = {}); end
|
73
73
|
|
74
|
-
# Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
|
74
|
+
# Returns a list of transactions that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
|
75
75
|
sig {
|
76
76
|
params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
|
77
77
|
}
|
78
78
|
def list(customer, params = {}, opts = {}); end
|
79
79
|
|
80
|
-
# Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
|
80
|
+
# Retrieves a specific customer balance transaction that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance).
|
81
81
|
sig {
|
82
82
|
params(customer: String, transaction: String, params: T.any(::Stripe::CustomerBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction)
|
83
83
|
}
|
@@ -29,13 +29,13 @@ module Stripe
|
|
29
29
|
sig { params(expand: T.nilable(T::Array[String])).void }
|
30
30
|
def initialize(expand: nil); end
|
31
31
|
end
|
32
|
-
# Returns a list of transactions that modified the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
|
32
|
+
# Returns a list of transactions that modified the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
|
33
33
|
sig {
|
34
34
|
params(customer: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
|
35
35
|
}
|
36
36
|
def list(customer, params = {}, opts = {}); end
|
37
37
|
|
38
|
-
# Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
|
38
|
+
# Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance).
|
39
39
|
sig {
|
40
40
|
params(customer: String, transaction: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerCashBalanceTransaction)
|
41
41
|
}
|
@@ -5,7 +5,7 @@
|
|
5
5
|
module Stripe
|
6
6
|
class CustomerPaymentMethodService < StripeService
|
7
7
|
class ListParams < Stripe::RequestParams
|
8
|
-
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
|
8
|
+
# This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow.
|
9
9
|
sig { returns(T.nilable(String)) }
|
10
10
|
attr_accessor :allow_redisplay
|
11
11
|
# A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
@@ -193,7 +193,7 @@ module Stripe
|
|
193
193
|
#
|
194
194
|
# If the card's owner has no default card, then the new card will become the default.
|
195
195
|
# However, if the owner already has a default, then it will not change.
|
196
|
-
# To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source.
|
196
|
+
# To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source.
|
197
197
|
sig {
|
198
198
|
params(customer: String, params: T.any(::Stripe::CustomerPaymentSourceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(T.any(Stripe::Account, Stripe::BankAccount, Stripe::Card, Stripe::Source))
|
199
199
|
}
|
@@ -11,9 +11,7 @@ module Stripe
|
|
11
11
|
attr_reader :tax_ids
|
12
12
|
attr_reader :payment_methods
|
13
13
|
attr_reader :funding_instructions
|
14
|
-
class DeleteParams < Stripe::RequestParams
|
15
|
-
|
16
|
-
end
|
14
|
+
class DeleteParams < Stripe::RequestParams; end
|
17
15
|
class RetrieveParams < Stripe::RequestParams
|
18
16
|
# Specifies which fields in the response should be expanded.
|
19
17
|
sig { returns(T.nilable(T::Array[String])) }
|
@@ -267,9 +265,7 @@ module Stripe
|
|
267
265
|
validate: nil
|
268
266
|
); end
|
269
267
|
end
|
270
|
-
class DeleteDiscountParams < Stripe::RequestParams
|
271
|
-
|
272
|
-
end
|
268
|
+
class DeleteDiscountParams < Stripe::RequestParams; end
|
273
269
|
class ListParams < Stripe::RequestParams
|
274
270
|
class Created < Stripe::RequestParams
|
275
271
|
# Minimum value to filter by (exclusive)
|
@@ -480,7 +476,7 @@ module Stripe
|
|
480
476
|
def initialize(ip_address: nil, validate_location: nil); end
|
481
477
|
end
|
482
478
|
class TaxIdDatum < Stripe::RequestParams
|
483
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
479
|
+
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
484
480
|
sig { returns(String) }
|
485
481
|
attr_accessor :type
|
486
482
|
# Value of the tax ID.
|
@@ -631,7 +627,7 @@ module Stripe
|
|
631
627
|
}
|
632
628
|
def retrieve(customer, params = {}, opts = {}); end
|
633
629
|
|
634
|
-
# Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
|
630
|
+
# Search for customers you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
|
635
631
|
# Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
|
636
632
|
# conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
|
637
633
|
# to an hour behind during outages. Search functionality is not available to merchants in India.
|
@@ -23,7 +23,7 @@ module Stripe
|
|
23
23
|
# Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
|
24
24
|
sig { returns(T.nilable(String)) }
|
25
25
|
attr_accessor :payment_method_redisplay
|
26
|
-
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.
|
26
|
+
# Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
|
27
27
|
sig { returns(T.nilable(Integer)) }
|
28
28
|
attr_accessor :payment_method_redisplay_limit
|
29
29
|
# Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
|
@@ -4,9 +4,7 @@
|
|
4
4
|
# typed: true
|
5
5
|
module Stripe
|
6
6
|
class CustomerTaxIdService < StripeService
|
7
|
-
class DeleteParams < Stripe::RequestParams
|
8
|
-
|
9
|
-
end
|
7
|
+
class DeleteParams < Stripe::RequestParams; end
|
10
8
|
class RetrieveParams < Stripe::RequestParams
|
11
9
|
# Specifies which fields in the response should be expanded.
|
12
10
|
sig { returns(T.nilable(T::Array[String])) }
|
@@ -36,7 +34,7 @@ module Stripe
|
|
36
34
|
# Specifies which fields in the response should be expanded.
|
37
35
|
sig { returns(T.nilable(T::Array[String])) }
|
38
36
|
attr_accessor :expand
|
39
|
-
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
37
|
+
# Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`
|
40
38
|
sig { returns(String) }
|
41
39
|
attr_accessor :type
|
42
40
|
# Value of the tax ID.
|
@@ -415,7 +415,7 @@ module Stripe
|
|
415
415
|
|
416
416
|
# When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
|
417
417
|
#
|
418
|
-
# Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
|
418
|
+
# Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://docs.stripe.com/docs/disputes/categories).
|
419
419
|
sig {
|
420
420
|
params(dispute: String, params: T.any(::Stripe::DisputeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute)
|
421
421
|
}
|
@@ -107,7 +107,7 @@ module Stripe
|
|
107
107
|
}
|
108
108
|
def list(params = {}, opts = {}); end
|
109
109
|
|
110
|
-
# Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
|
110
|
+
# Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://docs.stripe.com/docs/file-upload#download-file-contents).
|
111
111
|
sig {
|
112
112
|
params(file: String, params: T.any(::Stripe::FileService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File)
|
113
113
|
}
|
@@ -109,6 +109,16 @@ module Stripe
|
|
109
109
|
sig { params(email: T.nilable(String), phone: T.nilable(String)).void }
|
110
110
|
def initialize(email: nil, phone: nil); end
|
111
111
|
end
|
112
|
+
class RelatedPerson < Stripe::RequestParams
|
113
|
+
# A token representing a connected account. If provided, the person parameter is also required and must be associated with the account.
|
114
|
+
sig { returns(String) }
|
115
|
+
attr_accessor :account
|
116
|
+
# A token referencing a Person resource that this verification is being used to verify.
|
117
|
+
sig { returns(String) }
|
118
|
+
attr_accessor :person
|
119
|
+
sig { params(account: String, person: String).void }
|
120
|
+
def initialize(account: nil, person: nil); end
|
121
|
+
end
|
112
122
|
# A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
|
113
123
|
sig { returns(T.nilable(String)) }
|
114
124
|
attr_accessor :client_reference_id
|
@@ -131,6 +141,11 @@ module Stripe
|
|
131
141
|
# Customer ID
|
132
142
|
sig { returns(T.nilable(String)) }
|
133
143
|
attr_accessor :related_customer
|
144
|
+
# Tokens referencing a Person resource and it's associated account.
|
145
|
+
sig {
|
146
|
+
returns(T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson))
|
147
|
+
}
|
148
|
+
attr_accessor :related_person
|
134
149
|
# The URL that the user will be redirected to upon completing the verification flow.
|
135
150
|
sig { returns(T.nilable(String)) }
|
136
151
|
attr_accessor :return_url
|
@@ -141,7 +156,7 @@ module Stripe
|
|
141
156
|
sig { returns(T.nilable(String)) }
|
142
157
|
attr_accessor :verification_flow
|
143
158
|
sig {
|
144
|
-
params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails), related_customer: T.nilable(String), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
159
|
+
params(client_reference_id: T.nilable(String), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), options: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::Options), provided_details: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails), related_customer: T.nilable(String), related_person: T.nilable(::Stripe::Identity::VerificationSessionService::CreateParams::RelatedPerson), return_url: T.nilable(String), type: T.nilable(String), verification_flow: T.nilable(String)).void
|
145
160
|
}
|
146
161
|
def initialize(
|
147
162
|
client_reference_id: nil,
|
@@ -150,6 +165,7 @@ module Stripe
|
|
150
165
|
options: nil,
|
151
166
|
provided_details: nil,
|
152
167
|
related_customer: nil,
|
168
|
+
related_person: nil,
|
153
169
|
return_url: nil,
|
154
170
|
type: nil,
|
155
171
|
verification_flow: nil
|
@@ -251,9 +267,9 @@ module Stripe
|
|
251
267
|
sig { params(expand: T.nilable(T::Array[String])).void }
|
252
268
|
def initialize(expand: nil); end
|
253
269
|
end
|
254
|
-
# A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
|
270
|
+
# A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
|
255
271
|
#
|
256
|
-
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
|
272
|
+
# Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
|
257
273
|
sig {
|
258
274
|
params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
259
275
|
}
|
@@ -265,7 +281,7 @@ module Stripe
|
|
265
281
|
#
|
266
282
|
# If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
|
267
283
|
#
|
268
|
-
# Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
|
284
|
+
# Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
|
269
285
|
sig {
|
270
286
|
params(params: T.any(::Stripe::Identity::VerificationSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
271
287
|
}
|
@@ -282,7 +298,7 @@ module Stripe
|
|
282
298
|
# request logs, etc.
|
283
299
|
#
|
284
300
|
# A VerificationSession object can be redacted when it is in requires_input or verified
|
285
|
-
# [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
|
301
|
+
# [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
|
286
302
|
# state will automatically cancel it.
|
287
303
|
#
|
288
304
|
# The redaction process may take up to four days. When the redaction process is in progress, the
|
@@ -295,7 +311,7 @@ module Stripe
|
|
295
311
|
# placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
|
296
312
|
# used for any purpose.
|
297
313
|
#
|
298
|
-
# [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
|
314
|
+
# [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
|
299
315
|
sig {
|
300
316
|
params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession)
|
301
317
|
}
|