From c3f9f455093f6694047cc4818cab1d9e0ebd721b Mon Sep 17 00:00:00 2001 From: "stripe-openapi[bot]" <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 27 May 2025 13:34:38 -0700 Subject: [PATCH 1/2] Update generated code (#1605) * Update generated code for v1758 * Update generated code for v1770 * Update generated code for v1770 * Update generated code for v1772 * Update generated code for v1773 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> --- OPENAPI_VERSION | 2 +- lib/stripe/api_version.rb | 2 +- lib/stripe/resources/account.rb | 67 ++- lib/stripe/resources/account_session.rb | 118 +++- lib/stripe/resources/apple_pay_domain.rb | 3 +- lib/stripe/resources/balance.rb | 42 ++ lib/stripe/resources/balance_transaction.rb | 2 + lib/stripe/resources/bank_account.rb | 4 +- .../resources/billing_portal/session.rb | 2 +- lib/stripe/resources/capability.rb | 2 +- lib/stripe/resources/charge.rb | 18 +- lib/stripe/resources/checkout/session.rb | 24 +- lib/stripe/resources/confirmation_token.rb | 120 ++-- lib/stripe/resources/country_spec.rb | 2 +- lib/stripe/resources/coupon.rb | 3 +- lib/stripe/resources/credit_note.rb | 21 +- lib/stripe/resources/customer.rb | 6 +- lib/stripe/resources/customer_session.rb | 6 +- lib/stripe/resources/dispute.rb | 4 +- lib/stripe/resources/event.rb | 2 +- lib/stripe/resources/file.rb | 2 +- .../resources/identity/verification_report.rb | 6 + .../identity/verification_session.rb | 28 +- lib/stripe/resources/invoice.rb | 141 ++++- lib/stripe/resources/invoice_item.rb | 5 +- lib/stripe/resources/invoice_line_item.rb | 2 +- lib/stripe/resources/invoice_payment.rb | 11 +- lib/stripe/resources/issuing/authorization.rb | 16 +- lib/stripe/resources/issuing/card.rb | 2 +- lib/stripe/resources/issuing/dispute.rb | 6 +- lib/stripe/resources/payment_intent.rb | 498 +++++++--------- lib/stripe/resources/payment_method.rb | 149 ++--- .../resources/payment_method_configuration.rb | 299 +++++++++- lib/stripe/resources/payment_method_domain.rb | 4 +- lib/stripe/resources/payout.rb | 8 +- lib/stripe/resources/person.rb | 4 +- lib/stripe/resources/plan.rb | 5 +- lib/stripe/resources/price.rb | 2 +- lib/stripe/resources/product.rb | 3 +- lib/stripe/resources/radar/value_list.rb | 3 +- lib/stripe/resources/radar/value_list_item.rb | 3 +- lib/stripe/resources/refund.rb | 7 +- lib/stripe/resources/reversal.rb | 2 +- lib/stripe/resources/review.rb | 2 +- lib/stripe/resources/setup_intent.rb | 392 ++++--------- lib/stripe/resources/source.rb | 2 +- lib/stripe/resources/subscription.rb | 118 +++- lib/stripe/resources/subscription_item.rb | 33 ++ lib/stripe/resources/subscription_schedule.rb | 123 +++- lib/stripe/resources/tax/calculation.rb | 4 + .../resources/tax/calculation_line_item.rb | 2 + lib/stripe/resources/tax/registration.rb | 2 +- lib/stripe/resources/tax_id.rb | 3 +- lib/stripe/resources/tax_rate.rb | 4 +- .../resources/terminal/configuration.rb | 3 +- lib/stripe/resources/terminal/location.rb | 5 +- lib/stripe/resources/terminal/reader.rb | 278 ++++++++- .../resources/test_helpers/test_clock.rb | 3 +- lib/stripe/resources/token.rb | 4 +- lib/stripe/resources/transfer.rb | 2 +- lib/stripe/resources/webhook_endpoint.rb | 3 +- .../account_external_account_service.rb | 5 +- .../services/account_login_link_service.rb | 2 +- lib/stripe/services/account_person_service.rb | 3 +- lib/stripe/services/account_service.rb | 51 +- .../services/account_session_service.rb | 82 ++- .../services/apple_pay_domain_service.rb | 3 +- lib/stripe/services/balance_service.rb | 2 +- lib/stripe/services/charge_service.rb | 8 +- .../services/checkout/session_service.rb | 14 +- lib/stripe/services/coupon_service.rb | 3 +- lib/stripe/services/credit_note_service.rb | 15 +- .../customer_balance_transaction_service.rb | 6 +- ...stomer_cash_balance_transaction_service.rb | 4 +- .../customer_payment_source_service.rb | 2 +- lib/stripe/services/customer_service.rb | 8 +- .../services/customer_tax_id_service.rb | 3 +- lib/stripe/services/dispute_service.rb | 2 +- lib/stripe/services/file_service.rb | 2 +- .../identity/verification_session_service.rb | 10 +- lib/stripe/services/invoice_item_service.rb | 3 +- lib/stripe/services/invoice_service.rb | 115 +++- .../services/issuing/authorization_service.rb | 8 +- lib/stripe/services/issuing/card_service.rb | 2 +- .../services/issuing/dispute_service.rb | 4 +- lib/stripe/services/payment_intent_service.rb | 468 ++++++--------- .../payment_method_configuration_service.rb | 214 ++++++- .../services/payment_method_domain_service.rb | 2 +- lib/stripe/services/payment_method_service.rb | 143 ++--- lib/stripe/services/payout_service.rb | 4 +- lib/stripe/services/plan_service.rb | 5 +- lib/stripe/services/price_service.rb | 4 +- .../services/product_feature_service.rb | 3 +- lib/stripe/services/product_service.rb | 5 +- lib/stripe/services/promotion_code_service.rb | 2 +- .../radar/early_fraud_warning_service.rb | 2 +- .../services/radar/value_list_item_service.rb | 3 +- .../services/radar/value_list_service.rb | 3 +- lib/stripe/services/setup_intent_service.rb | 390 ++++--------- lib/stripe/services/source_service.rb | 2 +- .../services/subscription_item_service.rb | 26 + .../services/subscription_schedule_service.rb | 96 ++- lib/stripe/services/subscription_service.rb | 103 +++- .../services/tax/calculation_service.rb | 4 + .../services/tax/registration_service.rb | 2 +- lib/stripe/services/tax_id_service.rb | 3 +- .../terminal/configuration_service.rb | 3 +- .../services/terminal/location_service.rb | 5 +- .../services/terminal/reader_service.rb | 108 +++- .../confirmation_token_service.rb | 120 ++-- .../test_helpers/terminal/reader_service.rb | 43 ++ .../test_helpers/test_clock_service.rb | 3 +- lib/stripe/services/token_service.rb | 2 +- lib/stripe/services/transfer_service.rb | 2 +- .../v2/billing/meter_event_session_service.rb | 3 +- .../v2/core/event_destination_service.rb | 14 +- lib/stripe/services/v2/core/event_service.rb | 3 +- .../services/webhook_endpoint_service.rb | 3 +- rbi/stripe/resources/account.rbi | 69 ++- rbi/stripe/resources/account_session.rbi | 143 ++++- rbi/stripe/resources/apple_pay_domain.rbi | 4 +- rbi/stripe/resources/balance.rbi | 55 ++ rbi/stripe/resources/balance_transaction.rbi | 3 + rbi/stripe/resources/bank_account.rbi | 4 +- rbi/stripe/resources/billing/alert.rbi | 4 +- .../resources/billing_portal/session.rbi | 2 +- rbi/stripe/resources/capability.rbi | 2 +- rbi/stripe/resources/charge.rbi | 22 +- rbi/stripe/resources/checkout/session.rbi | 28 +- rbi/stripe/resources/confirmation_token.rbi | 132 ++--- rbi/stripe/resources/country_spec.rbi | 2 +- rbi/stripe/resources/coupon.rbi | 4 +- rbi/stripe/resources/credit_note.rbi | 23 +- rbi/stripe/resources/customer.rbi | 8 +- rbi/stripe/resources/customer_session.rbi | 6 +- rbi/stripe/resources/dispute.rbi | 4 +- rbi/stripe/resources/event.rbi | 2 +- rbi/stripe/resources/file.rbi | 2 +- .../identity/verification_report.rbi | 9 + .../identity/verification_session.rbi | 31 +- rbi/stripe/resources/invoice.rbi | 142 +++-- rbi/stripe/resources/invoice_item.rbi | 6 +- rbi/stripe/resources/invoice_line_item.rbi | 2 +- rbi/stripe/resources/invoice_payment.rbi | 11 +- .../resources/issuing/authorization.rbi | 16 +- rbi/stripe/resources/issuing/card.rbi | 2 +- rbi/stripe/resources/issuing/dispute.rbi | 6 +- rbi/stripe/resources/payment_intent.rbi | 550 +++++++----------- rbi/stripe/resources/payment_method.rbi | 162 ++---- .../payment_method_configuration.rbi | 338 ++++++++++- .../resources/payment_method_domain.rbi | 4 +- rbi/stripe/resources/payout.rbi | 8 +- rbi/stripe/resources/person.rbi | 4 +- rbi/stripe/resources/plan.rbi | 6 +- rbi/stripe/resources/price.rbi | 2 +- rbi/stripe/resources/product.rbi | 4 +- rbi/stripe/resources/radar/value_list.rbi | 4 +- .../resources/radar/value_list_item.rbi | 4 +- rbi/stripe/resources/refund.rbi | 6 +- rbi/stripe/resources/reversal.rbi | 2 +- rbi/stripe/resources/review.rbi | 2 +- rbi/stripe/resources/setup_intent.rbi | 436 ++++---------- rbi/stripe/resources/source.rbi | 2 +- rbi/stripe/resources/subscription.rbi | 135 +++-- rbi/stripe/resources/subscription_item.rbi | 38 +- .../resources/subscription_schedule.rbi | 148 ++++- rbi/stripe/resources/tax/calculation.rbi | 6 +- .../resources/tax/calculation_line_item.rbi | 3 + rbi/stripe/resources/tax/registration.rbi | 2 +- rbi/stripe/resources/tax_id.rbi | 4 +- rbi/stripe/resources/tax_rate.rbi | 4 +- .../resources/terminal/configuration.rbi | 4 +- rbi/stripe/resources/terminal/location.rbi | 6 +- rbi/stripe/resources/terminal/reader.rbi | 270 ++++++++- .../resources/test_helpers/test_clock.rbi | 4 +- rbi/stripe/resources/token.rbi | 4 +- rbi/stripe/resources/transfer.rbi | 2 +- rbi/stripe/resources/webhook_endpoint.rbi | 4 +- .../account_external_account_service.rbi | 6 +- .../services/account_login_link_service.rbi | 2 +- .../services/account_person_service.rbi | 4 +- rbi/stripe/services/account_service.rbi | 56 +- .../services/account_session_service.rbi | 98 +++- .../services/apple_pay_domain_service.rbi | 4 +- rbi/stripe/services/balance_service.rbi | 2 +- rbi/stripe/services/billing/alert_service.rbi | 4 +- rbi/stripe/services/charge_service.rbi | 8 +- .../services/checkout/session_service.rbi | 17 +- rbi/stripe/services/coupon_service.rbi | 4 +- rbi/stripe/services/credit_note_service.rbi | 15 +- .../customer_balance_transaction_service.rbi | 6 +- ...tomer_cash_balance_transaction_service.rbi | 4 +- .../customer_payment_source_service.rbi | 2 +- rbi/stripe/services/customer_service.rbi | 10 +- .../services/customer_tax_id_service.rbi | 4 +- rbi/stripe/services/dispute_service.rbi | 2 +- rbi/stripe/services/file_service.rbi | 2 +- .../identity/verification_session_service.rbi | 10 +- rbi/stripe/services/invoice_item_service.rbi | 4 +- rbi/stripe/services/invoice_service.rbi | 119 +++- .../issuing/authorization_service.rbi | 8 +- rbi/stripe/services/issuing/card_service.rbi | 2 +- .../services/issuing/dispute_service.rbi | 4 +- .../services/payment_intent_service.rbi | 518 ++++++----------- .../payment_method_configuration_service.rbi | 240 +++++++- .../payment_method_domain_service.rbi | 2 +- .../services/payment_method_service.rbi | 156 ++--- rbi/stripe/services/payout_service.rbi | 4 +- rbi/stripe/services/plan_service.rbi | 6 +- rbi/stripe/services/price_service.rbi | 4 +- .../services/product_feature_service.rbi | 4 +- rbi/stripe/services/product_service.rbi | 6 +- .../services/promotion_code_service.rbi | 2 +- .../radar/early_fraud_warning_service.rbi | 2 +- .../radar/value_list_item_service.rbi | 4 +- .../services/radar/value_list_service.rbi | 4 +- rbi/stripe/services/setup_intent_service.rbi | 434 ++++---------- rbi/stripe/services/source_service.rbi | 2 +- .../services/subscription_item_service.rbi | 30 +- .../subscription_schedule_service.rbi | 116 +++- rbi/stripe/services/subscription_service.rbi | 118 ++-- .../services/tax/calculation_service.rbi | 6 +- .../services/tax/registration_service.rbi | 2 +- rbi/stripe/services/tax_id_service.rbi | 4 +- .../terminal/configuration_service.rbi | 4 +- .../services/terminal/location_service.rbi | 6 +- .../services/terminal/reader_service.rbi | 119 +++- .../confirmation_token_service.rbi | 132 ++--- .../test_helpers/terminal/reader_service.rbi | 31 + .../test_helpers/test_clock_service.rbi | 4 +- rbi/stripe/services/token_service.rbi | 2 +- rbi/stripe/services/transfer_service.rbi | 2 +- .../billing/meter_event_session_service.rbi | 4 +- .../v2/core/event_destination_service.rbi | 16 +- rbi/stripe/services/v2/core/event_service.rbi | 4 +- .../services/webhook_endpoint_service.rbi | 4 +- 236 files changed, 5926 insertions(+), 4164 deletions(-) diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 3fdaa4ab0..3108db19f 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -v1719 \ No newline at end of file +v1773 \ No newline at end of file diff --git a/lib/stripe/api_version.rb b/lib/stripe/api_version.rb index e37f6590f..2ce2b878d 100644 --- a/lib/stripe/api_version.rb +++ b/lib/stripe/api_version.rb @@ -3,6 +3,6 @@ module Stripe module ApiVersion - CURRENT = "2025-04-30.basil" + CURRENT = "2025-05-28.basil" end end diff --git a/lib/stripe/resources/account.rb b/lib/stripe/resources/account.rb index 970f1ab7f..f7217cfec 100644 --- a/lib/stripe/resources/account.rb +++ b/lib/stripe/resources/account.rb @@ -6,14 +6,14 @@ module Stripe # properties on the account like its current requirements or if the account is # enabled to make live charges or receive payouts. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is `application`, which includes Custom accounts, the properties below are always # returned. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is `stripe`, which includes Standard and Express accounts, some properties are only returned - # until you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions) - # to start Connect Onboarding. Learn about the [differences between accounts](https://stripe.com/connect/accounts). + # until you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions) + # to start Connect Onboarding. Learn about the [differences between accounts](https://docs.stripe.com/connect/accounts). class Account < APIResource extend Stripe::APIOperations::Create include Stripe::APIOperations::Delete @@ -174,6 +174,8 @@ class Capabilities < Stripe::StripeObject attr_reader :payco_payments # The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. attr_reader :paynow_payments + # The status of the pix payments capability of the account, or whether the account can directly process pix charges. + attr_reader :pix_payments # The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. attr_reader :promptpay_payments # The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. @@ -590,8 +592,7 @@ class TosAcceptance < Stripe::StripeObject attr_reader :user_agent end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class BankAccount < Stripe::RequestParams @@ -1111,6 +1112,15 @@ def initialize(requested: nil) end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + attr_accessor :requested + + def initialize(requested: nil) + @requested = requested + end + end + class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. attr_accessor :requested @@ -1336,6 +1346,8 @@ def initialize(requested: nil) attr_accessor :payco_payments # The paynow_payments capability. attr_accessor :paynow_payments + # The pix_payments capability. + attr_accessor :pix_payments # The promptpay_payments capability. attr_accessor :promptpay_payments # The revolut_pay_payments capability. @@ -1411,6 +1423,7 @@ def initialize( pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -1469,6 +1482,7 @@ def initialize( @pay_by_bank_payments = pay_by_bank_payments @payco_payments = payco_payments @paynow_payments = paynow_payments + @pix_payments = pix_payments @promptpay_payments = promptpay_payments @revolut_pay_payments = revolut_pay_payments @samsung_pay_payments = samsung_pay_payments @@ -3110,6 +3124,15 @@ def initialize(requested: nil) end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + attr_accessor :requested + + def initialize(requested: nil) + @requested = requested + end + end + class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. attr_accessor :requested @@ -3335,6 +3358,8 @@ def initialize(requested: nil) attr_accessor :payco_payments # The paynow_payments capability. attr_accessor :paynow_payments + # The pix_payments capability. + attr_accessor :pix_payments # The promptpay_payments capability. attr_accessor :promptpay_payments # The revolut_pay_payments capability. @@ -3410,6 +3435,7 @@ def initialize( pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -3468,6 +3494,7 @@ def initialize( @pay_by_bank_payments = pay_by_bank_payments @payco_payments = payco_payments @paynow_payments = paynow_payments + @pix_payments = pix_payments @promptpay_payments = promptpay_payments @revolut_pay_payments = revolut_pay_payments @samsung_pay_payments = samsung_pay_payments @@ -4727,21 +4754,21 @@ def initialize(expand: nil, reason: nil) # Always true for a deleted object attr_reader :deleted - # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users. + # With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users. # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings). # - # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when + # If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding. # You can prefill any information on the account. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/accounts", params: params, opts: opts) end - # With [Connect](https://stripe.com/connect), you can delete accounts you manage. + # With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage. # # Test-mode accounts can be deleted at any time. # - # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero. + # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero. # # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. def self.delete(account, params = {}, opts = {}) @@ -4753,11 +4780,11 @@ def self.delete(account, params = {}, opts = {}) ) end - # With [Connect](https://stripe.com/connect), you can delete accounts you manage. + # With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage. # # Test-mode accounts can be deleted at any time. # - # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero. + # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero. # # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. def delete(params = {}, opts = {}) @@ -4769,7 +4796,7 @@ def delete(params = {}, opts = {}) ) end - # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty. + # Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty. def self.list(params = {}, opts = {}) request_stripe_object(method: :get, path: "/v1/accounts", params: params, opts: opts) end @@ -4794,7 +4821,7 @@ def self.persons(account, params = {}, opts = {}) ) end - # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. + # With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious. # # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. def reject(params = {}, opts = {}) @@ -4806,7 +4833,7 @@ def reject(params = {}, opts = {}) ) end - # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. + # With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious. # # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. def self.reject(account, params = {}, opts = {}) @@ -4818,19 +4845,19 @@ def self.reject(account, params = {}, opts = {}) ) end - # Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are + # Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are # left unchanged. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is application, which includes Custom accounts, you can update any information on the account. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is stripe, which includes Standard and Express accounts, you can update all information until you create - # an [Account Link or Account Session](https://stripe.com/api/account_links) to start Connect onboarding, + # an [Account Link or Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding, # after which some properties can no longer be updated. # # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our - # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. + # [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. def self.update(account, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/account_session.rb b/lib/stripe/resources/account_session.rb index 6a62b4316..5c996d42a 100644 --- a/lib/stripe/resources/account_session.rb +++ b/lib/stripe/resources/account_session.rb @@ -63,6 +63,23 @@ class Features < Stripe::StripeObject attr_reader :features end + class DisputesList < Stripe::StripeObject + class Features < Stripe::StripeObject + # Whether to allow capturing and cancelling payment intents. This is `true` by default. + attr_reader :capture_payments + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + attr_reader :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + attr_reader :dispute_management + # Whether to allow sending refunds. This is `true` by default. + attr_reader :refund_management + end + # Whether the embedded component is enabled. + attr_reader :enabled + # Attribute for field features + attr_reader :features + end + class Documents < Stripe::StripeObject class Features < Stripe::StripeObject; end # Whether the embedded component is enabled. @@ -165,6 +182,21 @@ class Features < Stripe::StripeObject attr_reader :features end + class PaymentDisputes < Stripe::StripeObject + class Features < Stripe::StripeObject + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + attr_reader :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + attr_reader :dispute_management + # Whether to allow sending refunds. This is `true` by default. + attr_reader :refund_management + end + # Whether the embedded component is enabled. + attr_reader :enabled + # Attribute for field features + attr_reader :features + end + class Payments < Stripe::StripeObject class Features < Stripe::StripeObject # Whether to allow capturing and cancelling payment intents. This is `true` by default. @@ -230,6 +262,8 @@ class Features < Stripe::StripeObject; end attr_reader :account_onboarding # Attribute for field balances attr_reader :balances + # Attribute for field disputes_list + attr_reader :disputes_list # Attribute for field documents attr_reader :documents # Attribute for field financial_account @@ -244,6 +278,8 @@ class Features < Stripe::StripeObject; end attr_reader :notification_banner # Attribute for field payment_details attr_reader :payment_details + # Attribute for field payment_disputes + attr_reader :payment_disputes # Attribute for field payments attr_reader :payments # Attribute for field payouts @@ -348,8 +384,28 @@ def initialize(enabled: nil, features: nil) end end - class Documents < Stripe::RequestParams + class DisputesList < Stripe::RequestParams class Features < Stripe::RequestParams + # Whether to allow capturing and cancelling payment intents. This is `true` by default. + attr_accessor :capture_payments + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + attr_accessor :refund_management + + def initialize( + capture_payments: nil, + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ) + @capture_payments = capture_payments + @destination_on_behalf_of_charge_management = destination_on_behalf_of_charge_management + @dispute_management = dispute_management + @refund_management = refund_management + end end # Whether the embedded component is enabled. attr_accessor :enabled @@ -362,6 +418,19 @@ def initialize(enabled: nil, features: nil) end end + class Documents < Stripe::RequestParams + class Features < Stripe::RequestParams; end + # Whether the embedded component is enabled. + attr_accessor :enabled + # The list of features enabled in the embedded component. + attr_accessor :features + + def initialize(enabled: nil, features: nil) + @enabled = enabled + @features = features + end + end + class FinancialAccount < Stripe::RequestParams class Features < Stripe::RequestParams # Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. @@ -548,6 +617,36 @@ def initialize(enabled: nil, features: nil) end end + class PaymentDisputes < Stripe::RequestParams + class Features < Stripe::RequestParams + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + attr_accessor :refund_management + + def initialize( + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ) + @destination_on_behalf_of_charge_management = destination_on_behalf_of_charge_management + @dispute_management = dispute_management + @refund_management = refund_management + end + end + # Whether the embedded component is enabled. + attr_accessor :enabled + # The list of features enabled in the embedded component. + attr_accessor :features + + def initialize(enabled: nil, features: nil) + @enabled = enabled + @features = features + end + end + class Payments < Stripe::RequestParams class Features < Stripe::RequestParams # Whether to allow capturing and cancelling payment intents. This is `true` by default. @@ -621,8 +720,7 @@ def initialize(enabled: nil, features: nil) end class PayoutsList < Stripe::RequestParams - class Features < Stripe::RequestParams - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. attr_accessor :enabled # The list of features enabled in the embedded component. @@ -635,8 +733,7 @@ def initialize(enabled: nil, features: nil) end class TaxRegistrations < Stripe::RequestParams - class Features < Stripe::RequestParams - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. attr_accessor :enabled # The list of features enabled in the embedded component. @@ -649,8 +746,7 @@ def initialize(enabled: nil, features: nil) end class TaxSettings < Stripe::RequestParams - class Features < Stripe::RequestParams - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. attr_accessor :enabled # The list of features enabled in the embedded component. @@ -667,6 +763,8 @@ def initialize(enabled: nil, features: nil) attr_accessor :account_onboarding # Configuration for the balances embedded component. attr_accessor :balances + # Configuration for the disputes list embedded component. + attr_accessor :disputes_list # Configuration for the documents embedded component. attr_accessor :documents # Configuration for the financial account embedded component. @@ -681,6 +779,8 @@ def initialize(enabled: nil, features: nil) attr_accessor :notification_banner # Configuration for the payment details embedded component. attr_accessor :payment_details + # Configuration for the payment disputes embedded component. + attr_accessor :payment_disputes # Configuration for the payments embedded component. attr_accessor :payments # Configuration for the payouts embedded component. @@ -696,6 +796,7 @@ def initialize( account_management: nil, account_onboarding: nil, balances: nil, + disputes_list: nil, documents: nil, financial_account: nil, financial_account_transactions: nil, @@ -703,6 +804,7 @@ def initialize( issuing_cards_list: nil, notification_banner: nil, payment_details: nil, + payment_disputes: nil, payments: nil, payouts: nil, payouts_list: nil, @@ -712,6 +814,7 @@ def initialize( @account_management = account_management @account_onboarding = account_onboarding @balances = balances + @disputes_list = disputes_list @documents = documents @financial_account = financial_account @financial_account_transactions = financial_account_transactions @@ -719,6 +822,7 @@ def initialize( @issuing_cards_list = issuing_cards_list @notification_banner = notification_banner @payment_details = payment_details + @payment_disputes = payment_disputes @payments = payments @payouts = payouts @payouts_list = payouts_list diff --git a/lib/stripe/resources/apple_pay_domain.rb b/lib/stripe/resources/apple_pay_domain.rb index 712f29bcd..ab603a19c 100644 --- a/lib/stripe/resources/apple_pay_domain.rb +++ b/lib/stripe/resources/apple_pay_domain.rb @@ -13,8 +13,7 @@ def self.object_name "apple_pay_domain" end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams # Attribute for param field domain_name diff --git a/lib/stripe/resources/balance.rb b/lib/stripe/resources/balance.rb index ab384cfd5..d73cced9c 100644 --- a/lib/stripe/resources/balance.rb +++ b/lib/stripe/resources/balance.rb @@ -126,6 +126,46 @@ class SourceTypes < Stripe::StripeObject # Attribute for field source_types attr_reader :source_types end + + class RefundAndDisputePrefunding < Stripe::StripeObject + class Available < Stripe::StripeObject + class SourceTypes < Stripe::StripeObject + # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated). + attr_reader :bank_account + # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits). + attr_reader :card + # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method. + attr_reader :fpx + end + # Balance amount. + attr_reader :amount + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + attr_reader :currency + # Attribute for field source_types + attr_reader :source_types + end + + class Pending < Stripe::StripeObject + class SourceTypes < Stripe::StripeObject + # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated). + attr_reader :bank_account + # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits). + attr_reader :card + # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method. + attr_reader :fpx + end + # Balance amount. + attr_reader :amount + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + attr_reader :currency + # Attribute for field source_types + attr_reader :source_types + end + # Funds that are available for use. + attr_reader :available + # Funds that are pending + attr_reader :pending + end # Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. attr_reader :available # Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. @@ -140,5 +180,7 @@ class SourceTypes < Stripe::StripeObject attr_reader :object # Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. attr_reader :pending + # Attribute for field refund_and_dispute_prefunding + attr_reader :refund_and_dispute_prefunding end end diff --git a/lib/stripe/resources/balance_transaction.rb b/lib/stripe/resources/balance_transaction.rb index a0685d3b4..2b52758fb 100644 --- a/lib/stripe/resources/balance_transaction.rb +++ b/lib/stripe/resources/balance_transaction.rb @@ -90,6 +90,8 @@ def initialize( attr_reader :amount # The date that the transaction's net funds become available in the Stripe balance. attr_reader :available_on + # The balance that this transaction impacts. + attr_reader :balance_type # Time at which the object was created. Measured in seconds since the Unix epoch. attr_reader :created # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). diff --git a/lib/stripe/resources/bank_account.rb b/lib/stripe/resources/bank_account.rb index 493385e46..276550fb6 100644 --- a/lib/stripe/resources/bank_account.rb +++ b/lib/stripe/resources/bank_account.rb @@ -4,11 +4,11 @@ module Stripe # These bank accounts are payment methods on `Customer` objects. # - # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer + # On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer # destinations on `Account` objects for connected accounts. # They can be bank accounts or debit cards as well, and are documented in the links above. # - # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers) + # Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers) class BankAccount < APIResource include Stripe::APIOperations::Delete extend Stripe::APIOperations::List diff --git a/lib/stripe/resources/billing_portal/session.rb b/lib/stripe/resources/billing_portal/session.rb index a2b5d276b..f00cef962 100644 --- a/lib/stripe/resources/billing_portal/session.rb +++ b/lib/stripe/resources/billing_portal/session.rb @@ -16,7 +16,7 @@ module BillingPortal # Create sessions on-demand when customers intend to manage their subscriptions # and billing details. # - # Related guide: [Customer management](https://stripe.com/customer-management) + # Related guide: [Customer management](https://docs.stripe.com/customer-management) class Session < APIResource extend Stripe::APIOperations::Create diff --git a/lib/stripe/resources/capability.rb b/lib/stripe/resources/capability.rb index eac13ca0e..18fe5b6f8 100644 --- a/lib/stripe/resources/capability.rb +++ b/lib/stripe/resources/capability.rb @@ -65,7 +65,7 @@ class Error < Stripe::StripeObject end # Fields that are due and can be satisfied by providing the corresponding alternative fields instead. attr_reader :alternatives - # Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. + # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested. attr_reader :current_deadline # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. attr_reader :currently_due diff --git a/lib/stripe/resources/charge.rb b/lib/stripe/resources/charge.rb index 705037572..b5b8c4e4c 100644 --- a/lib/stripe/resources/charge.rb +++ b/lib/stripe/resources/charge.rb @@ -157,6 +157,10 @@ class AcssDebit < Stripe::StripeObject end class Affirm < Stripe::StripeObject + # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location + # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + attr_reader :reader # The Affirm transaction ID associated with this payment. attr_reader :transaction_id end @@ -978,6 +982,10 @@ class Wechat < Stripe::StripeObject; end class WechatPay < Stripe::StripeObject # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. attr_reader :fingerprint + # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + attr_reader :location + # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + attr_reader :reader # Transaction ID of this particular WeChat Pay transaction. attr_reader :transaction_id end @@ -1636,9 +1644,9 @@ def initialize( # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false. # - # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. + # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. # - # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture). + # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture). def capture(params = {}, opts = {}) request_stripe_object( method: :post, @@ -1650,9 +1658,9 @@ def capture(params = {}, opts = {}) # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false. # - # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. + # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. # - # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture). + # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture). def self.capture(charge, params = {}, opts = {}) request_stripe_object( method: :post, @@ -1662,7 +1670,7 @@ def self.capture(charge, params = {}, opts = {}) ) end - # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents) + # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents) # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge # object used to request payment. def self.create(params = {}, opts = {}) diff --git a/lib/stripe/resources/checkout/session.rb b/lib/stripe/resources/checkout/session.rb index efd1fba19..16fb86f32 100644 --- a/lib/stripe/resources/checkout/session.rb +++ b/lib/stripe/resources/checkout/session.rb @@ -677,6 +677,14 @@ class Multibanco < Stripe::StripeObject class NaverPay < Stripe::StripeObject # Controls when the funds will be captured from the customer's account. attr_reader :capture_method + # Indicates that you intend to make future payments with this PaymentIntent's payment method. + # + # 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. + # + # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + # + # 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). + attr_reader :setup_future_usage end class Oxxo < Stripe::StripeObject @@ -2320,8 +2328,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds will be captured from the customer's account. @@ -2717,11 +2724,18 @@ def initialize(enabled: nil) class SavedPaymentMethodOptions < Stripe::RequestParams # 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. attr_accessor :allow_redisplay_filters + # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. + attr_accessor :payment_method_remove # Enable customers to choose if they wish to save their payment method for future use. Disabled by default. attr_accessor :payment_method_save - def initialize(allow_redisplay_filters: nil, payment_method_save: nil) + def initialize( + allow_redisplay_filters: nil, + payment_method_remove: nil, + payment_method_save: nil + ) @allow_redisplay_filters = allow_redisplay_filters + @payment_method_remove = payment_method_remove @payment_method_save = payment_method_save end end @@ -3569,7 +3583,7 @@ def initialize(expand: nil) # relevant text on the page, such as the submit button. `submit_type` can only be # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. attr_reader :submit_type - # The ID of the subscription for Checkout Sessions in `subscription` mode. + # The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode. attr_reader :subscription # The URL the customer will be directed to after the payment or # subscription creation is successful. @@ -3651,6 +3665,8 @@ def self.list_line_items(session, params = {}, opts = {}) end # Updates a Checkout Session object. + # + # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates) def self.update(session, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/confirmation_token.rb b/lib/stripe/resources/confirmation_token.rb index 80108e509..8123fc1aa 100644 --- a/lib/stripe/resources/confirmation_token.rb +++ b/lib/stripe/resources/confirmation_token.rb @@ -825,20 +825,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -864,11 +855,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -921,8 +909,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -933,11 +920,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -960,11 +944,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -975,11 +956,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -1004,20 +982,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -1059,8 +1028,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -1071,23 +1039,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -1098,14 +1055,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -1125,11 +1077,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -1158,11 +1107,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. diff --git a/lib/stripe/resources/country_spec.rb b/lib/stripe/resources/country_spec.rb index d448586e9..e2fb0c712 100644 --- a/lib/stripe/resources/country_spec.rb +++ b/lib/stripe/resources/country_spec.rb @@ -7,7 +7,7 @@ module Stripe # Country Specs API makes these rules available to your integration. # # You can also view the information from this API call as [an online - # guide](https://stripe.com/docs/connect/required-verification-information). + # guide](https://docs.stripe.com/docs/connect/required-verification-information). class CountrySpec < APIResource extend Stripe::APIOperations::List diff --git a/lib/stripe/resources/coupon.rb b/lib/stripe/resources/coupon.rb index c50d63a52..fca682025 100644 --- a/lib/stripe/resources/coupon.rb +++ b/lib/stripe/resources/coupon.rb @@ -26,8 +26,7 @@ class CurrencyOptions < Stripe::StripeObject attr_reader :amount_off end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class CurrencyOptions < Stripe::RequestParams diff --git a/lib/stripe/resources/credit_note.rb b/lib/stripe/resources/credit_note.rb index 14d80484e..ef466e13e 100644 --- a/lib/stripe/resources/credit_note.rb +++ b/lib/stripe/resources/credit_note.rb @@ -629,6 +629,10 @@ def initialize(expand: nil) attr_reader :out_of_band_amount # The link to download the PDF of the credit note. attr_reader :pdf + # The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof. + attr_reader :post_payment_amount + # The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced. + attr_reader :pre_payment_amount # The pretax credit amounts (ex: discount, credit grants, etc) for all line items. attr_reader :pretax_credit_amounts # Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` @@ -654,20 +658,19 @@ def initialize(expand: nil) # The time that the credit note was voided. attr_reader :voided_at - # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces - # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result - # in any combination of the following: + # 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. + # 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: # # - # Refund: create a new refund (using refund_amount) or link an existing refund (using refund). + # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds). # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized. # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount). # # - # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total. + # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount. # - # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount - # or post_payment_credit_notes_amount depending on its status at the time of credit note creation. + # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount, + # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/credit_notes", params: params, opts: opts) end @@ -707,7 +710,7 @@ def self.update(id, params = {}, opts = {}) ) end - # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). def void_credit_note(params = {}, opts = {}) request_stripe_object( method: :post, @@ -717,7 +720,7 @@ def void_credit_note(params = {}, opts = {}) ) end - # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). def self.void_credit_note(id, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/customer.rb b/lib/stripe/resources/customer.rb index f71c54926..d451c923f 100644 --- a/lib/stripe/resources/customer.rb +++ b/lib/stripe/resources/customer.rb @@ -105,8 +105,7 @@ class Location < Stripe::StripeObject attr_reader :location end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class Address < Stripe::RequestParams @@ -346,8 +345,7 @@ def initialize( end end - class DeleteDiscountParams < Stripe::RequestParams - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Created < Stripe::RequestParams diff --git a/lib/stripe/resources/customer_session.rb b/lib/stripe/resources/customer_session.rb index e0d77972b..be8dd3c90 100644 --- a/lib/stripe/resources/customer_session.rb +++ b/lib/stripe/resources/customer_session.rb @@ -5,9 +5,9 @@ module Stripe # A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access # control over a Customer. # - # Related guides: [Customer Session with the Payment Element](https://stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), - # [Customer Session with the Pricing Table](https://stripe.com/payments/checkout/pricing-table#customer-session), - # [Customer Session with the Buy Button](https://stripe.com/payment-links/buy-button#pass-an-existing-customer). + # Related guides: [Customer Session with the Payment Element](https://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), + # [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session), + # [Customer Session with the Buy Button](https://docs.stripe.com/payment-links/buy-button#pass-an-existing-customer). class CustomerSession < APIResource extend Stripe::APIOperations::Create diff --git a/lib/stripe/resources/dispute.rb b/lib/stripe/resources/dispute.rb index cd536a6af..4c7f6f4a5 100644 --- a/lib/stripe/resources/dispute.rb +++ b/lib/stripe/resources/dispute.rb @@ -621,7 +621,7 @@ def initialize(expand: nil) attr_reader :payment_intent # Attribute for field payment_method_details attr_reader :payment_method_details - # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). + # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). attr_reader :reason # Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. attr_reader :status @@ -657,7 +657,7 @@ def self.list(params = {}, opts = {}) # 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. # - # 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). + # 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). def self.update(dispute, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/event.rb b/lib/stripe/resources/event.rb index 7d90081d6..99f4571fc 100644 --- a/lib/stripe/resources/event.rb +++ b/lib/stripe/resources/event.rb @@ -113,7 +113,7 @@ def initialize( attr_reader :account # The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. attr_reader :api_version - # Attribute for field context + # Authentication context needed to fetch the event or related object. attr_reader :context # Time at which the object was created. Measured in seconds since the Unix epoch. attr_reader :created diff --git a/lib/stripe/resources/file.rb b/lib/stripe/resources/file.rb index 665385e2b..f17612a83 100644 --- a/lib/stripe/resources/file.rb +++ b/lib/stripe/resources/file.rb @@ -6,7 +6,7 @@ module Stripe # files with the [create file](https://stripe.com/docs/api#create_file) request # (for example, when uploading dispute evidence). Stripe also # creates files independently (for example, the results of a [Sigma scheduled - # query](https://stripe.com/docs/api#scheduled_queries)). + # query](https://docs.stripe.com/api#scheduled_queries)). # # Related guide: [File upload guide](https://stripe.com/docs/file-upload) class File < APIResource diff --git a/lib/stripe/resources/identity/verification_report.rb b/lib/stripe/resources/identity/verification_report.rb index 96081919f..48e4454ac 100644 --- a/lib/stripe/resources/identity/verification_report.rb +++ b/lib/stripe/resources/identity/verification_report.rb @@ -91,10 +91,16 @@ class IssuedDate < Stripe::StripeObject attr_reader :last_name # Document ID number. attr_reader :number + # Sex of the person in the document. + attr_reader :sex # Status of this `document` check. attr_reader :status # Type of the document. attr_reader :type + # Place of birth as it appears in the document. + attr_reader :unparsed_place_of_birth + # Sex as it appears in the document. + attr_reader :unparsed_sex end class Email < Stripe::StripeObject diff --git a/lib/stripe/resources/identity/verification_session.rb b/lib/stripe/resources/identity/verification_session.rb index 7941fdd44..013eafac6 100644 --- a/lib/stripe/resources/identity/verification_session.rb +++ b/lib/stripe/resources/identity/verification_session.rb @@ -5,11 +5,11 @@ module Stripe module Identity # A VerificationSession guides you through the process of collecting and verifying the identities # of your users. It contains details about the type of verification, such as what [verification - # check](https://stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for + # check](https://docs.stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for # each verification in your system. # # A VerificationSession transitions through [multiple - # statuses](https://stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through + # statuses](https://docs.stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through # the verification flow. The VerificationSession contains the user's verified data after # verification checks are complete. # @@ -116,6 +116,12 @@ class Dob < Stripe::StripeObject attr_reader :last_name # The user's verified phone number attr_reader :phone + # The user's verified sex. + attr_reader :sex + # The user's verified place of birth as it appears in the document. + attr_reader :unparsed_place_of_birth + # The user's verified sex as it appears in the document. + attr_reader :unparsed_sex end class ListParams < Stripe::RequestParams @@ -376,9 +382,9 @@ def initialize(expand: nil) # The user’s verified data. attr_reader :verified_outputs - # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work). + # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work). # - # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel). + # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel). def cancel(params = {}, opts = {}) request_stripe_object( method: :post, @@ -388,9 +394,9 @@ def cancel(params = {}, opts = {}) ) end - # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work). + # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work). # - # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel). + # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel). def self.cancel(session, params = {}, opts = {}) request_stripe_object( method: :post, @@ -406,7 +412,7 @@ def self.cancel(session, params = {}, opts = {}) # # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode. # - # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents) + # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents) def self.create(params = {}, opts = {}) request_stripe_object( method: :post, @@ -431,7 +437,7 @@ def self.list(params = {}, opts = {}) # request logs, etc. # # A VerificationSession object can be redacted when it is in requires_input or verified - # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action + # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action # state will automatically cancel it. # # The redaction process may take up to four days. When the redaction process is in progress, the @@ -444,7 +450,7 @@ def self.list(params = {}, opts = {}) # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or # used for any purpose. # - # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact). + # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact). def redact(params = {}, opts = {}) request_stripe_object( method: :post, @@ -459,7 +465,7 @@ def redact(params = {}, opts = {}) # request logs, etc. # # A VerificationSession object can be redacted when it is in requires_input or verified - # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action + # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action # state will automatically cancel it. # # The redaction process may take up to four days. When the redaction process is in progress, the @@ -472,7 +478,7 @@ def redact(params = {}, opts = {}) # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or # used for any purpose. # - # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact). + # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact). def self.redact(session, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/invoice.rb b/lib/stripe/resources/invoice.rb index a39461e5d..c0039c71e 100644 --- a/lib/stripe/resources/invoice.rb +++ b/lib/stripe/resources/invoice.rb @@ -26,7 +26,7 @@ module Stripe # Stripe applies any customer credit on the account before determining the # amount due for the invoice (i.e., the amount that will be actually # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge - # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the + # per currency](https://docs.stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the # invoice is automatically marked paid, and we add the amount due to the # customer's credit balance which is applied to the next invoice. # @@ -455,8 +455,7 @@ class TaxRateDetails < Stripe::StripeObject attr_reader :type end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class AutomaticTax < Stripe::RequestParams @@ -624,11 +623,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -1274,11 +1270,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -1924,6 +1917,18 @@ def initialize(expand: nil, invoice_metadata: nil, lines: nil) end end + class AttachPaymentParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + attr_accessor :expand + # The ID of the PaymentIntent to attach to the invoice. + attr_accessor :payment_intent + + def initialize(expand: nil, payment_intent: nil) + @expand = expand + @payment_intent = payment_intent + end + end + class FinalizeInvoiceParams < Stripe::RequestParams # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. attr_accessor :auto_advance @@ -2633,6 +2638,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -2675,6 +2692,15 @@ def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -2731,6 +2757,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. @@ -2747,6 +2775,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -2755,6 +2784,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -2784,6 +2814,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -2808,7 +2840,7 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :metadata # The account on behalf of which to charge, for each of the associated subscription's invoices. attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. attr_accessor :start_date @@ -2824,6 +2856,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -2846,6 +2879,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @currency = currency @default_payment_method = default_payment_method @@ -2881,6 +2915,15 @@ def initialize(end_behavior: nil, phases: nil, proration_behavior: nil) class SubscriptionDetails < Stripe::RequestParams class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -2937,6 +2980,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. attr_accessor :clear_usage # A flag that, if set to `true`, will delete the specified item. @@ -2959,6 +3004,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -2970,6 +3016,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @clear_usage = clear_usage @deleted = deleted @discounts = discounts @@ -2986,7 +3033,7 @@ def initialize( attr_accessor :billing_cycle_anchor # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. attr_accessor :cancel_now @@ -3178,7 +3225,7 @@ def initialize( attr_reader :from_invoice # The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. attr_reader :hosted_invoice_url - # Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. + # Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`. attr_reader :id # The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. attr_reader :invoice_pdf @@ -3275,16 +3322,56 @@ def self.add_lines(invoice, params = {}, opts = {}) ) end - # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. + # + # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited + # to the invoice, increasing its amount_paid. When the invoice is fully paid, the + # invoice's status becomes paid. + # + # If the PaymentIntent's status is already succeeded when it's attached, it's + # credited to the invoice immediately. + # + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. + def attach_payment(params = {}, opts = {}) + request_stripe_object( + method: :post, + path: format("/v1/invoices/%s/attach_payment", { invoice: CGI.escape(self["id"]) }), + params: params, + opts: opts + ) + end + + # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. + # + # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited + # to the invoice, increasing its amount_paid. When the invoice is fully paid, the + # invoice's status becomes paid. + # + # If the PaymentIntent's status is already succeeded when it's attached, it's + # credited to the invoice immediately. + # + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. + def self.attach_payment(invoice, params = {}, opts = {}) + request_stripe_object( + method: :post, + path: format("/v1/invoices/%s/attach_payment", { invoice: CGI.escape(invoice) }), + params: params, + opts: opts + ) + end + + # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/invoices", params: params, opts: opts) end # At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. # - # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. + # You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. + # + # The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true. # - # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request. + # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. # # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions) def self.create_preview(params = {}, opts = {}) @@ -3296,7 +3383,7 @@ def self.create_preview(params = {}, opts = {}) ) end - # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice). + # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice). def self.delete(invoice, params = {}, opts = {}) request_stripe_object( method: :delete, @@ -3306,7 +3393,7 @@ def self.delete(invoice, params = {}, opts = {}) ) end - # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice). + # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice). def delete(params = {}, opts = {}) request_stripe_object( method: :delete, @@ -3433,11 +3520,11 @@ def self.send_invoice(invoice, params = {}, opts = {}) ) end - # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized), + # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized), # monetary values, as well as collection_method, become uneditable. # # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, - # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass + # sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass # auto_advance=false. def self.update(invoice, params = {}, opts = {}) request_stripe_object( @@ -3468,9 +3555,9 @@ def self.update_lines(invoice, params = {}, opts = {}) ) end - # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. + # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. # - # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. + # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. def void_invoice(params = {}, opts = {}) request_stripe_object( method: :post, @@ -3480,9 +3567,9 @@ def void_invoice(params = {}, opts = {}) ) end - # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. + # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. # - # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. + # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. def self.void_invoice(invoice, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/invoice_item.rb b/lib/stripe/resources/invoice_item.rb index 82b2745a9..daa9a10e6 100644 --- a/lib/stripe/resources/invoice_item.rb +++ b/lib/stripe/resources/invoice_item.rb @@ -59,8 +59,7 @@ class PriceDetails < Stripe::StripeObject attr_reader :unit_amount_decimal end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class Discount < Stripe::RequestParams @@ -407,7 +406,7 @@ def initialize( attr_reader :metadata # String representing the object's type. Objects of the same type share the same value. attr_reader :object - # The parent that generated this invoice + # The parent that generated this invoice item. attr_reader :parent # Attribute for field period attr_reader :period diff --git a/lib/stripe/resources/invoice_line_item.rb b/lib/stripe/resources/invoice_line_item.rb index 88424a339..d423f0221 100644 --- a/lib/stripe/resources/invoice_line_item.rb +++ b/lib/stripe/resources/invoice_line_item.rb @@ -348,7 +348,7 @@ def initialize( attr_reader :metadata # String representing the object's type. Objects of the same type share the same value. attr_reader :object - # The parent that generated this invoice + # The parent that generated this line item. attr_reader :parent # Attribute for field period attr_reader :period diff --git a/lib/stripe/resources/invoice_payment.rb b/lib/stripe/resources/invoice_payment.rb index 809a6b113..e3df4c977 100644 --- a/lib/stripe/resources/invoice_payment.rb +++ b/lib/stripe/resources/invoice_payment.rb @@ -2,7 +2,14 @@ # frozen_string_literal: true module Stripe - # The invoice payment object + # Invoice Payments represent payments made against invoices. Invoice Payments can + # be accessed in two ways: + # 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource. + # 2. By using the Invoice Payment retrieve and list endpoints. + # + # Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. + # This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and + # monitor the allocation details of the payments. class InvoicePayment < APIResource extend Stripe::APIOperations::List @@ -12,7 +19,7 @@ def self.object_name end class Payment < Stripe::StripeObject - # ID of the successful charge for this payment when `type` is `charge`. + # ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead. attr_reader :charge # ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019. attr_reader :payment_intent diff --git a/lib/stripe/resources/issuing/authorization.rb b/lib/stripe/resources/issuing/authorization.rb index dd3cce9e5..68c7746b4 100644 --- a/lib/stripe/resources/issuing/authorization.rb +++ b/lib/stripe/resources/issuing/authorization.rb @@ -1122,8 +1122,8 @@ def initialize(expand: nil, reverse_amount: nil) # The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized. attr_reader :wallet - # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). def approve(params = {}, opts = {}) request_stripe_object( method: :post, @@ -1134,8 +1134,8 @@ def approve(params = {}, opts = {}) end deprecate :approve, :none, 2024, 3 - # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). def self.approve(authorization, params = {}, opts = {}) request_stripe_object( method: :post, @@ -1150,8 +1150,8 @@ class << self deprecate :approve, :none, 2024, 3 end - # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). def decline(params = {}, opts = {}) request_stripe_object( method: :post, @@ -1162,8 +1162,8 @@ def decline(params = {}, opts = {}) end deprecate :decline, :none, 2024, 3 - # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). def self.decline(authorization, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/issuing/card.rb b/lib/stripe/resources/issuing/card.rb index a5f9a1a03..a5aff4554 100644 --- a/lib/stripe/resources/issuing/card.rb +++ b/lib/stripe/resources/issuing/card.rb @@ -345,7 +345,7 @@ def initialize( attr_accessor :currency # Specifies which fields in the response should be expanded. attr_accessor :expand - # Attribute for param field financial_account + # The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account. attr_accessor :financial_account # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. attr_accessor :metadata diff --git a/lib/stripe/resources/issuing/dispute.rb b/lib/stripe/resources/issuing/dispute.rb index 62aae4999..abf1a0b2b 100644 --- a/lib/stripe/resources/issuing/dispute.rb +++ b/lib/stripe/resources/issuing/dispute.rb @@ -797,7 +797,7 @@ def initialize(expand: nil, metadata: nil) # [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts attr_reader :treasury - # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. + # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. def self.create(params = {}, opts = {}) request_stripe_object( method: :post, @@ -817,7 +817,7 @@ def self.list(params = {}, opts = {}) ) end - # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). + # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). def submit(params = {}, opts = {}) request_stripe_object( method: :post, @@ -827,7 +827,7 @@ def submit(params = {}, opts = {}) ) end - # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). + # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). def self.submit(dispute, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/payment_intent.rb b/lib/stripe/resources/payment_intent.rb index 70ae4ab82..79b210961 100644 --- a/lib/stripe/resources/payment_intent.rb +++ b/lib/stripe/resources/payment_intent.rb @@ -656,7 +656,7 @@ class WechatPayRedirectToIosApp < Stripe::StripeObject attr_reader :redirect_to_url # Attribute for field swish_handle_redirect_or_display_qr_code attr_reader :swish_handle_redirect_or_display_qr_code - # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. + # Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. attr_reader :type # When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. attr_reader :use_stripe_sdk @@ -810,7 +810,10 @@ class Bancontact < Stripe::StripeObject attr_reader :setup_future_usage end - class Billie < Stripe::StripeObject; end + class Billie < Stripe::StripeObject + # Controls when the funds will be captured from the customer's account. + attr_reader :capture_method + end class Blik < Stripe::StripeObject # Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -1261,6 +1264,11 @@ class SamsungPay < Stripe::StripeObject attr_reader :capture_method end + class Satispay < Stripe::StripeObject + # Controls when the funds will be captured from the customer's account. + attr_reader :capture_method + end + class SepaDebit < Stripe::StripeObject class MandateOptions < Stripe::StripeObject # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -1464,6 +1472,8 @@ class Zip < Stripe::StripeObject attr_reader :revolut_pay # Attribute for field samsung_pay attr_reader :samsung_pay + # Attribute for field satispay + attr_reader :satispay # Attribute for field sepa_debit attr_reader :sepa_debit # Attribute for field sofort @@ -1605,8 +1615,7 @@ def initialize(allow_redirects: nil, enabled: nil) class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -1659,20 +1668,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -1698,11 +1698,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -1755,8 +1752,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -1767,11 +1763,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -1794,11 +1787,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -1809,11 +1799,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -1838,20 +1825,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -1893,8 +1871,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -1905,23 +1882,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -1932,14 +1898,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -1959,11 +1920,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -1992,11 +1950,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -2916,8 +2871,7 @@ def initialize(setup_future_usage: nil) end end - class InteracPresent < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -3175,8 +3129,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -3318,6 +3271,19 @@ def initialize(capture_method: nil) end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + attr_accessor :capture_method + + def initialize(capture_method: nil) + @capture_method = capture_method + end + end + class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -3613,6 +3579,8 @@ def initialize(setup_future_usage: nil) attr_accessor :revolut_pay # If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. attr_accessor :sepa_debit # If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options. @@ -3670,6 +3638,7 @@ def initialize( promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -3719,6 +3688,7 @@ def initialize( @promptpay = promptpay @revolut_pay = revolut_pay @samsung_pay = samsung_pay + @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @swish = swish @@ -3852,6 +3822,8 @@ def initialize(amount: nil, destination: nil) # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. # # If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. + # If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent. + # end attr_accessor :payment_method # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. attr_accessor :payment_method_configuration @@ -3979,20 +3951,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -4018,11 +3981,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -4075,8 +4035,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -4087,11 +4046,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -4114,11 +4070,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -4129,11 +4082,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -4158,20 +4108,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -4213,8 +4154,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -4225,23 +4165,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -4252,14 +4181,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -4279,11 +4203,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -4312,11 +4233,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -5236,8 +5154,7 @@ def initialize(setup_future_usage: nil) end end - class InteracPresent < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -5495,8 +5412,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -5638,6 +5554,19 @@ def initialize(capture_method: nil) end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + attr_accessor :capture_method + + def initialize(capture_method: nil) + @capture_method = capture_method + end + end + class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -5933,6 +5862,8 @@ def initialize(setup_future_usage: nil) attr_accessor :revolut_pay # If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. attr_accessor :sepa_debit # If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options. @@ -5990,6 +5921,7 @@ def initialize( promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -6039,6 +5971,7 @@ def initialize( @promptpay = promptpay @revolut_pay = revolut_pay @samsung_pay = samsung_pay + @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @swish = swish @@ -6312,8 +6245,7 @@ def initialize( class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -6366,20 +6298,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -6405,11 +6328,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -6462,8 +6382,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -6474,11 +6393,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -6501,11 +6417,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -6516,11 +6429,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -6545,20 +6455,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -6600,8 +6501,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -6612,23 +6512,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -6639,14 +6528,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -6666,11 +6550,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -6699,11 +6580,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -7623,8 +7501,7 @@ def initialize(setup_future_usage: nil) end end - class InteracPresent < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -7882,8 +7759,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -8025,6 +7901,19 @@ def initialize(capture_method: nil) end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + attr_accessor :capture_method + + def initialize(capture_method: nil) + @capture_method = capture_method + end + end + class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -8320,6 +8209,8 @@ def initialize(setup_future_usage: nil) attr_accessor :revolut_pay # If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. attr_accessor :sepa_debit # If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options. @@ -8377,6 +8268,7 @@ def initialize( promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -8426,6 +8318,7 @@ def initialize( @promptpay = promptpay @revolut_pay = revolut_pay @samsung_pay = samsung_pay + @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @swish = swish @@ -8512,6 +8405,7 @@ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_numbe # Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). attr_accessor :off_session # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + # If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent. attr_accessor :payment_method # If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear # in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) @@ -8758,11 +8652,11 @@ def self.apply_customer_balance(intent, params = {}, opts = {}) ) end - # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://stripe.com/docs/payments/intents), processing. + # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing. # # After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. # - # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. def cancel(params = {}, opts = {}) request_stripe_object( method: :post, @@ -8772,11 +8666,11 @@ def cancel(params = {}, opts = {}) ) end - # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://stripe.com/docs/payments/intents), processing. + # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing. # # After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. # - # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. def self.cancel(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -8790,7 +8684,7 @@ def self.cancel(intent, params = {}, opts = {}) # # Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. # - # Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later). + # Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later). def capture(params = {}, opts = {}) request_stripe_object( method: :post, @@ -8804,7 +8698,7 @@ def capture(params = {}, opts = {}) # # Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. # - # Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later). + # Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later). def self.capture(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -8825,8 +8719,8 @@ def self.capture(intent, params = {}, opts = {}) # payment succeeds, the PaymentIntent will transition to the succeeded # status (or requires_capture, if capture_method is set to manual). # If the confirmation_method is automatic, payment may be attempted - # using our [client SDKs](https://stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) - # and the PaymentIntent's [client_secret](https://stripe.com/docs/api#payment_intent_object-client_secret). + # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) + # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret). # After next_actions are handled by the client, no additional # confirmation is required to complete the payment. # If the confirmation_method is manual, all payment attempts must be @@ -8859,8 +8753,8 @@ def confirm(params = {}, opts = {}) # payment succeeds, the PaymentIntent will transition to the succeeded # status (or requires_capture, if capture_method is set to manual). # If the confirmation_method is automatic, payment may be attempted - # using our [client SDKs](https://stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) - # and the PaymentIntent's [client_secret](https://stripe.com/docs/api#payment_intent_object-client_secret). + # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) + # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret). # After next_actions are handled by the client, no additional # confirmation is required to complete the payment. # If the confirmation_method is manual, all payment attempts must be @@ -8884,22 +8778,22 @@ def self.confirm(intent, params = {}, opts = {}) # Creates a PaymentIntent object. # - # After the PaymentIntent is created, attach a payment method and [confirm](https://stripe.com/docs/api/payment_intents/confirm) + # After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm) # to continue the payment. Learn more about the available payment flows # with the Payment Intents API. # # When you use confirm=true during creation, it's equivalent to creating # and confirming the PaymentIntent in the same call. You can use any parameters - # available in the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) when you supply + # available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply # confirm=true. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/payment_intents", params: params, opts: opts) end # Perform an incremental authorization on an eligible - # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the + # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the # PaymentIntent's status must be requires_capture and - # [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + # [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) # must be true. # # Incremental authorizations attempt to increase the authorized amount on @@ -8910,16 +8804,16 @@ def self.create(params = {}, opts = {}) # # If the incremental authorization succeeds, the PaymentIntent object # returns with the updated - # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). + # [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). # If the incremental authorization fails, a - # [card_declined](https://stripe.com/docs/error-codes#card-declined) error returns, and no other + # [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other # fields on the PaymentIntent or Charge update. The PaymentIntent # object remains capturable for the previously authorized amount. # # Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. # After it's captured, a PaymentIntent can no longer be incremented. # - # Learn more about [incremental authorizations](https://stripe.com/docs/terminal/features/incremental-authorizations). + # Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations). def increment_authorization(params = {}, opts = {}) request_stripe_object( method: :post, @@ -8930,9 +8824,9 @@ def increment_authorization(params = {}, opts = {}) end # Perform an incremental authorization on an eligible - # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the + # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the # PaymentIntent's status must be requires_capture and - # [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + # [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) # must be true. # # Incremental authorizations attempt to increase the authorized amount on @@ -8943,16 +8837,16 @@ def increment_authorization(params = {}, opts = {}) # # If the incremental authorization succeeds, the PaymentIntent object # returns with the updated - # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). + # [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). # If the incremental authorization fails, a - # [card_declined](https://stripe.com/docs/error-codes#card-declined) error returns, and no other + # [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other # fields on the PaymentIntent or Charge update. The PaymentIntent # object remains capturable for the previously authorized amount. # # Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. # After it's captured, a PaymentIntent can no longer be incremented. # - # Learn more about [incremental authorizations](https://stripe.com/docs/terminal/features/incremental-authorizations). + # Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations). def self.increment_authorization(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -8986,7 +8880,7 @@ def self.search_auto_paging_each(params = {}, opts = {}, &blk) # PaymentIntent again. For example, updating the payment_method # always requires you to confirm the PaymentIntent again. If you prefer to # update and confirm at the same time, we recommend updating properties through - # the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) instead. + # the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead. def self.update(intent, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/payment_method.rb b/lib/stripe/resources/payment_method.rb index feb3690c1..6ee730185 100644 --- a/lib/stripe/resources/payment_method.rb +++ b/lib/stripe/resources/payment_method.rb @@ -691,20 +691,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -730,11 +721,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -787,8 +775,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -838,11 +825,8 @@ def initialize( end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -865,11 +849,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -880,11 +861,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -909,20 +887,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -964,8 +933,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -976,23 +944,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -1003,14 +960,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -1030,11 +982,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -1063,11 +1012,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -1373,11 +1319,8 @@ def initialize(exp_month: nil, exp_year: nil, networks: nil) end end - class Link < Stripe::RequestParams - end - - class PayByBank < Stripe::RequestParams - end + class Link < Stripe::RequestParams; end + class PayByBank < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Bank account holder type. @@ -1569,16 +1512,16 @@ def initialize(expand: nil) # Attaches a PaymentMethod object to a Customer. # - # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) - # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). + # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents) + # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for # future use, which makes later declines and payment friction more likely. - # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up + # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up # future payments. # # To use this PaymentMethod as the default for invoice or subscription payments, - # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), + # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), # on the Customer to the PaymentMethod's ID. def attach(params = {}, opts = {}) request_stripe_object( @@ -1591,16 +1534,16 @@ def attach(params = {}, opts = {}) # Attaches a PaymentMethod object to a Customer. # - # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) - # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). + # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents) + # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for # future use, which makes later declines and payment friction more likely. - # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up + # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up # future payments. # # To use this PaymentMethod as the default for invoice or subscription payments, - # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), + # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), # on the Customer to the PaymentMethod's ID. def self.attach(payment_method, params = {}, opts = {}) request_stripe_object( @@ -1611,9 +1554,9 @@ def self.attach(payment_method, params = {}, opts = {}) ) end - # Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. + # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. # - # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. + # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/payment_methods", params: params, opts: opts) end @@ -1638,7 +1581,7 @@ def self.detach(payment_method, params = {}, opts = {}) ) end - # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead. + # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. def self.list(params = {}, opts = {}) request_stripe_object(method: :get, path: "/v1/payment_methods", params: params, opts: opts) end diff --git a/lib/stripe/resources/payment_method_configuration.rb b/lib/stripe/resources/payment_method_configuration.rb index c6d77074a..5fc603ba5 100644 --- a/lib/stripe/resources/payment_method_configuration.rb +++ b/lib/stripe/resources/payment_method_configuration.rb @@ -386,6 +386,21 @@ class DisplayPreference < Stripe::StripeObject attr_reader :display_preference end + class KakaoPay < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + attr_reader :overridable + # The account's display preference. + attr_reader :preference + # The effective display preference value. + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + attr_reader :available + # Attribute for field display_preference + attr_reader :display_preference + end + class Klarna < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -416,6 +431,21 @@ class DisplayPreference < Stripe::StripeObject attr_reader :display_preference end + class KrCard < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + attr_reader :overridable + # The account's display preference. + attr_reader :preference + # The effective display preference value. + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + attr_reader :available + # Attribute for field display_preference + attr_reader :display_preference + end + class Link < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -461,6 +491,21 @@ class DisplayPreference < Stripe::StripeObject attr_reader :display_preference end + class NaverPay < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + attr_reader :overridable + # The account's display preference. + attr_reader :preference + # The effective display preference value. + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + attr_reader :available + # Attribute for field display_preference + attr_reader :display_preference + end + class NzBankAccount < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -521,6 +566,21 @@ class DisplayPreference < Stripe::StripeObject attr_reader :display_preference end + class Payco < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + attr_reader :overridable + # The account's display preference. + attr_reader :preference + # The effective display preference value. + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + attr_reader :available + # Attribute for field display_preference + attr_reader :display_preference + end + class Paynow < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -596,6 +656,21 @@ class DisplayPreference < Stripe::StripeObject attr_reader :display_preference end + class SamsungPay < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + attr_reader :overridable + # The account's display preference. + attr_reader :preference + # The effective display preference value. + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + attr_reader :available + # Attribute for field display_preference + attr_reader :display_preference + end + class Satispay < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -1169,6 +1244,23 @@ def initialize(display_preference: nil) end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1203,6 +1295,23 @@ def initialize(display_preference: nil) end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1254,6 +1363,23 @@ def initialize(display_preference: nil) end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1322,6 +1448,23 @@ def initialize(display_preference: nil) end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1407,6 +1550,23 @@ def initialize(display_preference: nil) end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1554,7 +1714,7 @@ def initialize(display_preference: nil) attr_accessor :alma # Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. attr_accessor :apple_pay # Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. attr_accessor :apple_pay_later @@ -1594,10 +1754,14 @@ def initialize(display_preference: nil) attr_accessor :ideal # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. attr_accessor :link # MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. @@ -1606,6 +1770,8 @@ def initialize(display_preference: nil) attr_accessor :multibanco # Configuration name. attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. attr_accessor :nz_bank_account # OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. @@ -1616,6 +1782,8 @@ def initialize(display_preference: nil) attr_accessor :parent # Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. attr_accessor :paynow # PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. @@ -1626,6 +1794,8 @@ def initialize(display_preference: nil) attr_accessor :promptpay # Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. attr_accessor :satispay # The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. @@ -1670,22 +1840,27 @@ def initialize( grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, parent: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, @@ -1721,22 +1896,27 @@ def initialize( @grabpay = grabpay @ideal = ideal @jcb = jcb + @kakao_pay = kakao_pay @klarna = klarna @konbini = konbini + @kr_card = kr_card @link = link @mobilepay = mobilepay @multibanco = multibanco @name = name + @naver_pay = naver_pay @nz_bank_account = nz_bank_account @oxxo = oxxo @p24 = p24 @parent = parent @pay_by_bank = pay_by_bank + @payco = payco @paynow = paynow @paypal = paypal @pix = pix @promptpay = promptpay @revolut_pay = revolut_pay + @samsung_pay = samsung_pay @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @@ -2174,6 +2354,23 @@ def initialize(display_preference: nil) end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2208,6 +2405,23 @@ def initialize(display_preference: nil) end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2259,6 +2473,23 @@ def initialize(display_preference: nil) end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2327,6 +2558,23 @@ def initialize(display_preference: nil) end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2412,6 +2660,23 @@ def initialize(display_preference: nil) end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2561,7 +2826,7 @@ def initialize(display_preference: nil) attr_accessor :alma # Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. attr_accessor :apple_pay # Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. attr_accessor :apple_pay_later @@ -2601,10 +2866,14 @@ def initialize(display_preference: nil) attr_accessor :ideal # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. attr_accessor :link # MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. @@ -2613,6 +2882,8 @@ def initialize(display_preference: nil) attr_accessor :multibanco # Configuration name. attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. attr_accessor :nz_bank_account # OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. @@ -2621,6 +2892,8 @@ def initialize(display_preference: nil) attr_accessor :p24 # Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. attr_accessor :paynow # PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. @@ -2631,6 +2904,8 @@ def initialize(display_preference: nil) attr_accessor :promptpay # Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. attr_accessor :satispay # The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. @@ -2676,21 +2951,26 @@ def initialize( grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, @@ -2727,21 +3007,26 @@ def initialize( @grabpay = grabpay @ideal = ideal @jcb = jcb + @kakao_pay = kakao_pay @klarna = klarna @konbini = konbini + @kr_card = kr_card @link = link @mobilepay = mobilepay @multibanco = multibanco @name = name + @naver_pay = naver_pay @nz_bank_account = nz_bank_account @oxxo = oxxo @p24 = p24 @pay_by_bank = pay_by_bank + @payco = payco @paynow = paynow @paypal = paypal @pix = pix @promptpay = promptpay @revolut_pay = revolut_pay + @samsung_pay = samsung_pay @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @@ -2808,10 +3093,14 @@ def initialize( attr_reader :is_default # Attribute for field jcb attr_reader :jcb + # Attribute for field kakao_pay + attr_reader :kakao_pay # Attribute for field klarna attr_reader :klarna # Attribute for field konbini attr_reader :konbini + # Attribute for field kr_card + attr_reader :kr_card # Attribute for field link attr_reader :link # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. @@ -2822,6 +3111,8 @@ def initialize( attr_reader :multibanco # The configuration's name. attr_reader :name + # Attribute for field naver_pay + attr_reader :naver_pay # Attribute for field nz_bank_account attr_reader :nz_bank_account # String representing the object's type. Objects of the same type share the same value. @@ -2834,6 +3125,8 @@ def initialize( attr_reader :parent # Attribute for field pay_by_bank attr_reader :pay_by_bank + # Attribute for field payco + attr_reader :payco # Attribute for field paynow attr_reader :paynow # Attribute for field paypal @@ -2844,6 +3137,8 @@ def initialize( attr_reader :promptpay # Attribute for field revolut_pay attr_reader :revolut_pay + # Attribute for field samsung_pay + attr_reader :samsung_pay # Attribute for field satispay attr_reader :satispay # Attribute for field sepa_debit diff --git a/lib/stripe/resources/payment_method_domain.rb b/lib/stripe/resources/payment_method_domain.rb index efee2edb7..ce64acf59 100644 --- a/lib/stripe/resources/payment_method_domain.rb +++ b/lib/stripe/resources/payment_method_domain.rb @@ -208,7 +208,7 @@ def self.update(payment_method_domain, params = {}, opts = {}) # # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. # - # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + # Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration). def validate(params = {}, opts = {}) request_stripe_object( method: :post, @@ -223,7 +223,7 @@ def validate(params = {}, opts = {}) # # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. # - # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + # Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration). def self.validate(payment_method_domain, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/payout.rb b/lib/stripe/resources/payout.rb index af995cf4f..96faee3a5 100644 --- a/lib/stripe/resources/payout.rb +++ b/lib/stripe/resources/payout.rb @@ -4,9 +4,9 @@ module Stripe # A `Payout` object is created when you receive funds from Stripe, or when you # initiate a payout to either a bank account or debit card of a [connected - # Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, + # Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, # and list all payouts. Payouts are made on [varying - # schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and + # schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and # industry. # # Related guide: [Receiving payouts](https://stripe.com/docs/payouts) @@ -249,11 +249,11 @@ def self.cancel(payout, params = {}, opts = {}) ) end - # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. + # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. # # If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode. # - # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type. + # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/payouts", params: params, opts: opts) end diff --git a/lib/stripe/resources/person.rb b/lib/stripe/resources/person.rb index c104a11f7..660184b72 100644 --- a/lib/stripe/resources/person.rb +++ b/lib/stripe/resources/person.rb @@ -4,9 +4,9 @@ module Stripe # This is an object representing a person associated with a Stripe account. # - # A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. + # A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. # - # See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information). + # See the [Standard onboarding](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information). class Person < APIResource include Stripe::APIOperations::Save diff --git a/lib/stripe/resources/plan.rb b/lib/stripe/resources/plan.rb index 2d3d87bd3..e94b9a993 100644 --- a/lib/stripe/resources/plan.rb +++ b/lib/stripe/resources/plan.rb @@ -41,8 +41,7 @@ class TransformUsage < Stripe::StripeObject attr_reader :round end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # Whether the plan is currently available for new subscriptions. @@ -323,7 +322,7 @@ def initialize( # Always true for a deleted object attr_reader :deleted - # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + # You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/plans", params: params, opts: opts) end diff --git a/lib/stripe/resources/price.rb b/lib/stripe/resources/price.rb index 3ced5100c..81a09c22d 100644 --- a/lib/stripe/resources/price.rb +++ b/lib/stripe/resources/price.rb @@ -628,7 +628,7 @@ def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/prices", params: params, opts: opts) end - # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. + # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. def self.list(params = {}, opts = {}) request_stripe_object(method: :get, path: "/v1/prices", params: params, opts: opts) end diff --git a/lib/stripe/resources/product.rb b/lib/stripe/resources/product.rb index 1e636fb81..0f360b41e 100644 --- a/lib/stripe/resources/product.rb +++ b/lib/stripe/resources/product.rb @@ -41,8 +41,7 @@ class PackageDimensions < Stripe::StripeObject attr_reader :width end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class MarketingFeature < Stripe::RequestParams diff --git a/lib/stripe/resources/radar/value_list.rb b/lib/stripe/resources/radar/value_list.rb index e54f313d5..4ca47746f 100644 --- a/lib/stripe/resources/radar/value_list.rb +++ b/lib/stripe/resources/radar/value_list.rb @@ -17,8 +17,7 @@ def self.object_name "radar.value_list" end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # The name of the value list for use in rules. diff --git a/lib/stripe/resources/radar/value_list_item.rb b/lib/stripe/resources/radar/value_list_item.rb index 510eea88c..a80cf3786 100644 --- a/lib/stripe/resources/radar/value_list_item.rb +++ b/lib/stripe/resources/radar/value_list_item.rb @@ -16,8 +16,7 @@ def self.object_name "radar.value_list_item" end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Created < Stripe::RequestParams diff --git a/lib/stripe/resources/refund.rb b/lib/stripe/resources/refund.rb index 6c6de2e92..dbad69a6c 100644 --- a/lib/stripe/resources/refund.rb +++ b/lib/stripe/resources/refund.rb @@ -106,7 +106,12 @@ class P24 < Stripe::StripeObject end class Paynow < Stripe::StripeObject; end - class Paypal < Stripe::StripeObject; end + + class Paypal < Stripe::StripeObject + # For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. + attr_reader :network_decline_code + end + class Pix < Stripe::StripeObject; end class Revolut < Stripe::StripeObject; end class Sofort < Stripe::StripeObject; end diff --git a/lib/stripe/resources/reversal.rb b/lib/stripe/resources/reversal.rb index 9ae781796..2f067d996 100644 --- a/lib/stripe/resources/reversal.rb +++ b/lib/stripe/resources/reversal.rb @@ -8,7 +8,7 @@ module Stripe # platform's balance and subtract from the destination account's balance. # # Reversing a transfer that was made for a [destination - # charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of + # charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of # the charge. It is possible to reverse a # [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) # transfer only if the destination account has enough balance to cover the diff --git a/lib/stripe/resources/review.rb b/lib/stripe/resources/review.rb index c25c2c036..11a3fe657 100644 --- a/lib/stripe/resources/review.rb +++ b/lib/stripe/resources/review.rb @@ -4,7 +4,7 @@ module Stripe # Reviews can be used to supplement automated fraud detection with human expertise. # - # Learn more about [Radar](https://stripe.com/radar) and reviewing payments + # Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments # [here](https://stripe.com/docs/radar/reviews). class Review < APIResource extend Stripe::APIOperations::List diff --git a/lib/stripe/resources/setup_intent.rb b/lib/stripe/resources/setup_intent.rb index b229710ef..06f6a26ec 100644 --- a/lib/stripe/resources/setup_intent.rb +++ b/lib/stripe/resources/setup_intent.rb @@ -148,7 +148,7 @@ class VerifyWithMicrodeposits < Stripe::StripeObject attr_reader :cashapp_handle_redirect_or_display_qr_code # Attribute for field redirect_to_url attr_reader :redirect_to_url - # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. + # Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. attr_reader :type # When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. attr_reader :use_stripe_sdk @@ -370,8 +370,7 @@ def initialize(allow_redirects: nil, enabled: nil) class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -424,20 +423,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -463,11 +453,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -520,8 +507,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -532,11 +518,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -559,11 +542,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -574,11 +554,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -603,20 +580,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -658,8 +626,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -670,23 +637,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -697,14 +653,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -724,11 +675,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -757,11 +705,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -1020,8 +965,7 @@ def initialize(currency: nil, mandate_options: nil, verification_method: nil) end end - class AmazonPay < Stripe::RequestParams - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams @@ -1187,8 +1131,7 @@ def initialize( end end - class CardPresent < Stripe::RequestParams - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. @@ -1457,20 +1400,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -1496,11 +1430,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -1553,8 +1484,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -1565,11 +1495,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -1592,11 +1519,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -1607,11 +1531,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -1636,20 +1557,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -1691,8 +1603,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -1703,23 +1614,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -1730,14 +1630,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -1757,11 +1652,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -1790,11 +1682,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -2053,8 +1942,7 @@ def initialize(currency: nil, mandate_options: nil, verification_method: nil) end end - class AmazonPay < Stripe::RequestParams - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams @@ -2220,8 +2108,7 @@ def initialize( end end - class CardPresent < Stripe::RequestParams - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. @@ -2436,8 +2323,7 @@ def initialize(cancellation_reason: nil, expand: nil) class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -2490,20 +2376,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -2529,11 +2406,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -2586,8 +2460,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -2598,11 +2471,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -2625,11 +2495,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -2640,11 +2507,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -2669,20 +2533,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -2724,8 +2579,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -2736,23 +2590,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -2763,14 +2606,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -2790,11 +2628,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -2823,11 +2658,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -3086,8 +2918,7 @@ def initialize(currency: nil, mandate_options: nil, verification_method: nil) end end - class AmazonPay < Stripe::RequestParams - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams @@ -3253,8 +3084,7 @@ def initialize( end end - class CardPresent < Stripe::RequestParams - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. @@ -3517,7 +3347,7 @@ def initialize(amounts: nil, descriptor_code: nil, expand: nil) # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. # - # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. def cancel(params = {}, opts = {}) request_stripe_object( method: :post, @@ -3529,7 +3359,7 @@ def cancel(params = {}, opts = {}) # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. # - # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. def self.cancel(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -3587,7 +3417,7 @@ def self.confirm(intent, params = {}, opts = {}) # Creates a SetupIntent object. # - # After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm) + # After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm) # it to collect any required permissions to charge the payment method later. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/setup_intents", params: params, opts: opts) diff --git a/lib/stripe/resources/source.rb b/lib/stripe/resources/source.rb index afc618ddd..1f4774e85 100644 --- a/lib/stripe/resources/source.rb +++ b/lib/stripe/resources/source.rb @@ -1229,7 +1229,7 @@ def self.create(params = {}, opts = {}) # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged. # - # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail. + # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail. def self.update(source, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/subscription.rb b/lib/stripe/resources/subscription.rb index 14cc2707c..0766a69b1 100644 --- a/lib/stripe/resources/subscription.rb +++ b/lib/stripe/resources/subscription.rb @@ -44,6 +44,13 @@ class BillingCycleAnchorConfig < Stripe::StripeObject attr_reader :second end + class BillingThresholds < Stripe::StripeObject + # Monetary threshold that triggers the subscription to create an invoice + attr_reader :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + attr_reader :reset_billing_cycle_anchor + end + class CancellationDetails < Stripe::StripeObject # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. attr_reader :comment @@ -320,6 +327,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class CancellationDetails < Stripe::RequestParams # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. attr_accessor :comment @@ -371,6 +390,15 @@ def initialize(account_tax_ids: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -427,6 +455,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. attr_accessor :clear_usage # A flag that, if set to `true`, will delete the specified item. @@ -449,6 +479,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -460,6 +491,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @clear_usage = clear_usage @deleted = deleted @discounts = discounts @@ -576,11 +608,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -714,9 +743,11 @@ def initialize(end_behavior: nil) attr_accessor :automatic_tax # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled attr_accessor :cancellation_details @@ -762,11 +793,11 @@ def initialize(end_behavior: nil) attr_accessor :pending_invoice_item_interval # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + # If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. attr_accessor :proration_date # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. attr_accessor :transfer_data - # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. attr_accessor :trial_end # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. attr_accessor :trial_from_plan @@ -778,6 +809,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, cancellation_details: nil, @@ -809,6 +841,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @cancel_at = cancel_at @cancel_at_period_end = cancel_at_period_end @cancellation_details = cancellation_details @@ -838,8 +871,7 @@ def initialize( end end - class DeleteDiscountParams < Stripe::RequestParams - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class AutomaticTax < Stripe::RequestParams @@ -1073,6 +1105,18 @@ def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: ni end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -1112,6 +1156,15 @@ def initialize(account_tax_ids: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -1168,6 +1221,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. @@ -1184,6 +1239,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -1192,6 +1248,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -1293,11 +1350,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -1435,9 +1489,11 @@ def initialize(end_behavior: nil) attr_accessor :billing_cycle_anchor # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC. attr_accessor :billing_cycle_anchor_config + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. attr_accessor :collection_method @@ -1505,6 +1561,7 @@ def initialize( backdate_start_date: nil, billing_cycle_anchor: nil, billing_cycle_anchor_config: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, collection_method: nil, @@ -1538,6 +1595,7 @@ def initialize( @backdate_start_date = backdate_start_date @billing_cycle_anchor = billing_cycle_anchor @billing_cycle_anchor_config = billing_cycle_anchor_config + @billing_thresholds = billing_thresholds @cancel_at = cancel_at @cancel_at_period_end = cancel_at_period_end @collection_method = collection_method @@ -1590,9 +1648,9 @@ class ResumeParams < Stripe::RequestParams attr_accessor :billing_cycle_anchor # Specifies which fields in the response should be expanded. attr_accessor :expand - # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. attr_accessor :proration_date def initialize( @@ -1617,9 +1675,11 @@ def initialize( attr_reader :billing_cycle_anchor # The fixed values used to calculate the `billing_cycle_anchor`. attr_reader :billing_cycle_anchor_config + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + attr_reader :billing_thresholds # A date in the future at which the subscription will automatically get canceled attr_reader :cancel_at - # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. + # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead. attr_reader :cancel_at_period_end # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. attr_reader :canceled_at @@ -1699,12 +1759,12 @@ def initialize( attr_reader :trial_end # Settings related to subscription trials. attr_reader :trial_settings - # If the subscription has a trial, the beginning of that trial. + # If the subscription has a trial, the beginning of that trial. For subsequent trials, this date remains as the start of the first ever trial on the subscription. attr_reader :trial_start - # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata). + # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata). # - # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. + # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. # # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. def cancel(params = {}, opts = {}) @@ -1716,9 +1776,9 @@ def cancel(params = {}, opts = {}) ) end - # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata). + # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata). # - # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. + # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. # # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. def self.cancel(subscription_exposed_id, params = {}, opts = {}) @@ -1735,7 +1795,7 @@ def self.cancel(subscription_exposed_id, params = {}, opts = {}) # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. # The payment_behavior parameter determines the exact behavior of the initial payment. # - # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. + # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. # Schedules provide the flexibility to model more complex billing configurations that change over time. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/subscriptions", params: params, opts: opts) @@ -1801,7 +1861,7 @@ def self.search_auto_paging_each(params = {}, opts = {}, &blk) # Updates an existing subscription to match the specified parameters. # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. - # To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. + # To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint. # # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. # @@ -1813,13 +1873,13 @@ def self.search_auto_paging_each(params = {}, opts = {}, &blk) # A trial starts or ends. # # - # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). + # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). # - # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create). + # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create). # # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription. # - # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://stripe.com/docs/rate-limits) instead. + # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead. def self.update(subscription_exposed_id, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/subscription_item.rb b/lib/stripe/resources/subscription_item.rb index 829e736f5..31778aa14 100644 --- a/lib/stripe/resources/subscription_item.rb +++ b/lib/stripe/resources/subscription_item.rb @@ -15,6 +15,11 @@ def self.object_name "subscription_item" end + class BillingThresholds < Stripe::StripeObject + # Usage threshold that triggers the subscription to create an invoice + attr_reader :usage_gte + end + class DeleteParams < Stripe::RequestParams # Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. attr_accessor :clear_usage @@ -31,6 +36,15 @@ def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil) end class UpdateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -87,6 +101,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Specifies which fields in the response should be expanded. @@ -119,6 +135,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, @@ -132,6 +149,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @expand = expand @metadata = metadata @@ -175,6 +193,15 @@ def initialize( end class CreateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -231,6 +258,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Specifies which fields in the response should be expanded. @@ -263,6 +292,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, @@ -276,6 +306,7 @@ def initialize( subscription: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @expand = expand @metadata = metadata @@ -290,6 +321,8 @@ def initialize( @tax_rates = tax_rates end end + # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + attr_reader :billing_thresholds # Time at which the object was created. Measured in seconds since the Unix epoch. attr_reader :created # The end time of this subscription item's current billing period. diff --git a/lib/stripe/resources/subscription_schedule.rb b/lib/stripe/resources/subscription_schedule.rb index d962fb9a1..25467dd3c 100644 --- a/lib/stripe/resources/subscription_schedule.rb +++ b/lib/stripe/resources/subscription_schedule.rb @@ -38,6 +38,13 @@ class Liability < Stripe::StripeObject attr_reader :liability end + class BillingThresholds < Stripe::StripeObject + # Monetary threshold that triggers the subscription to create an invoice + attr_reader :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + attr_reader :reset_billing_cycle_anchor + end + class InvoiceSettings < Stripe::StripeObject class Issuer < Stripe::StripeObject # The connected account being referenced when `type` is `account`. @@ -65,6 +72,8 @@ class TransferData < Stripe::StripeObject attr_reader :automatic_tax # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_reader :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + attr_reader :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. attr_reader :collection_method # ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. @@ -114,6 +123,13 @@ class Liability < Stripe::StripeObject attr_reader :liability end + class BillingThresholds < Stripe::StripeObject + # Monetary threshold that triggers the subscription to create an invoice + attr_reader :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + attr_reader :reset_billing_cycle_anchor + end + class Discount < Stripe::StripeObject # ID of the coupon to create a new discount for. attr_reader :coupon @@ -139,6 +155,11 @@ class Issuer < Stripe::StripeObject end class Item < Stripe::StripeObject + class BillingThresholds < Stripe::StripeObject + # Usage threshold that triggers the subscription to create an invoice + attr_reader :usage_gte + end + class Discount < Stripe::StripeObject # ID of the coupon to create a new discount for. attr_reader :coupon @@ -147,6 +168,8 @@ class Discount < Stripe::StripeObject # ID of the promotion code to create a new discount for. attr_reader :promotion_code end + # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + attr_reader :billing_thresholds # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. attr_reader :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. @@ -175,6 +198,8 @@ class TransferData < Stripe::StripeObject attr_reader :automatic_tax # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_reader :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + attr_reader :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. attr_reader :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -197,7 +222,7 @@ class TransferData < Stripe::StripeObject attr_reader :metadata # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. attr_reader :on_behalf_of - # If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. + # When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`. attr_reader :proration_behavior # The start of this phase of the subscription schedule. attr_reader :start_date @@ -350,6 +375,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -393,6 +430,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. @@ -410,6 +449,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -420,6 +460,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @default_payment_method = default_payment_method @description = description @@ -515,6 +556,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -557,6 +610,15 @@ def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -613,6 +675,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. @@ -629,6 +693,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -637,6 +702,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -666,6 +732,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -690,7 +758,7 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :metadata # The account on behalf of which to charge, for each of the associated subscription's invoices. attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. attr_accessor :proration_behavior # The data with which to automatically create a Transfer for each of the associated subscription's invoices. attr_accessor :transfer_data @@ -704,6 +772,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -725,6 +794,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @currency = currency @default_payment_method = default_payment_method @@ -806,6 +876,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -849,6 +931,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. @@ -866,6 +950,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -876,6 +961,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @default_payment_method = default_payment_method @description = description @@ -971,6 +1057,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -1013,6 +1111,15 @@ def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -1069,6 +1176,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. @@ -1085,6 +1194,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -1093,6 +1203,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -1122,6 +1233,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -1146,7 +1259,7 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :metadata # The account on behalf of which to charge, for each of the associated subscription's invoices. attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. attr_accessor :start_date @@ -1162,6 +1275,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -1184,6 +1298,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @currency = currency @default_payment_method = default_payment_method @@ -1213,7 +1328,7 @@ def initialize( attr_accessor :metadata # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. attr_accessor :phases - # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. + # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`. attr_accessor :proration_behavior def initialize( diff --git a/lib/stripe/resources/tax/calculation.rb b/lib/stripe/resources/tax/calculation.rb index 5ca145a3d..793271659 100644 --- a/lib/stripe/resources/tax/calculation.rb +++ b/lib/stripe/resources/tax/calculation.rb @@ -240,6 +240,8 @@ class LineItem < Stripe::RequestParams # A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). # If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. attr_accessor :amount + # 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. + attr_accessor :metadata # If provided, the product's `tax_code` will be used as the line item's `tax_code`. attr_accessor :product # The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25. @@ -253,6 +255,7 @@ class LineItem < Stripe::RequestParams def initialize( amount: nil, + metadata: nil, product: nil, quantity: nil, reference: nil, @@ -260,6 +263,7 @@ def initialize( tax_code: nil ) @amount = amount + @metadata = metadata @product = product @quantity = quantity @reference = reference diff --git a/lib/stripe/resources/tax/calculation_line_item.rb b/lib/stripe/resources/tax/calculation_line_item.rb index e365f6ad7..e84170274 100644 --- a/lib/stripe/resources/tax/calculation_line_item.rb +++ b/lib/stripe/resources/tax/calculation_line_item.rb @@ -50,6 +50,8 @@ class TaxRateDetails < Stripe::StripeObject attr_reader :id # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. attr_reader :livemode + # 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. + attr_reader :metadata # String representing the object's type. Objects of the same type share the same value. attr_reader :object # The ID of an existing [Product](https://stripe.com/docs/api/products/object). diff --git a/lib/stripe/resources/tax/registration.rb b/lib/stripe/resources/tax/registration.rb index 5db62105b..5b7b35505 100644 --- a/lib/stripe/resources/tax/registration.rb +++ b/lib/stripe/resources/tax/registration.rb @@ -2060,7 +2060,7 @@ def initialize(type: nil) class Us < Stripe::RequestParams class LocalAmusementTax < Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). attr_accessor :jurisdiction def initialize(jurisdiction: nil) diff --git a/lib/stripe/resources/tax_id.rb b/lib/stripe/resources/tax_id.rb index 160a5588f..f61385ea3 100644 --- a/lib/stripe/resources/tax_id.rb +++ b/lib/stripe/resources/tax_id.rb @@ -36,8 +36,7 @@ class Verification < Stripe::StripeObject attr_reader :verified_name end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Owner < Stripe::RequestParams diff --git a/lib/stripe/resources/tax_rate.rb b/lib/stripe/resources/tax_rate.rb index 917066658..df6d459a6 100644 --- a/lib/stripe/resources/tax_rate.rb +++ b/lib/stripe/resources/tax_rate.rb @@ -2,9 +2,9 @@ # frozen_string_literal: true module Stripe - # Tax rates can be applied to [invoices](https://stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://stripe.com/payments/checkout/use-manual-tax-rates) to collect tax. + # Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax. # - # Related guide: [Tax rates](https://stripe.com/billing/taxes/tax-rates) + # Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates) class TaxRate < APIResource extend Stripe::APIOperations::Create extend Stripe::APIOperations::List diff --git a/lib/stripe/resources/terminal/configuration.rb b/lib/stripe/resources/terminal/configuration.rb index 797342139..6b6fcb46b 100644 --- a/lib/stripe/resources/terminal/configuration.rb +++ b/lib/stripe/resources/terminal/configuration.rb @@ -261,8 +261,7 @@ class PersonalPsk < Stripe::StripeObject attr_reader :type end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class BbposWiseposE < Stripe::RequestParams diff --git a/lib/stripe/resources/terminal/location.rb b/lib/stripe/resources/terminal/location.rb index cddf45f22..e24aed527 100644 --- a/lib/stripe/resources/terminal/location.rb +++ b/lib/stripe/resources/terminal/location.rb @@ -32,8 +32,7 @@ class Address < Stripe::StripeObject attr_reader :state end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class Address < Stripe::RequestParams @@ -184,7 +183,7 @@ def initialize( attr_reader :deleted # Creates a new Location object. - # For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide. + # For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide. def self.create(params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/terminal/reader.rb b/lib/stripe/resources/terminal/reader.rb index 19fc10eec..658389431 100644 --- a/lib/stripe/resources/terminal/reader.rb +++ b/lib/stripe/resources/terminal/reader.rb @@ -18,6 +18,100 @@ def self.object_name end class Action < Stripe::StripeObject + class CollectInputs < Stripe::StripeObject + class Input < Stripe::StripeObject + class CustomText < Stripe::StripeObject + # Customize the default description for this input + attr_reader :description + # Customize the default label for this input's skip button + attr_reader :skip_button + # Customize the default label for this input's submit button + attr_reader :submit_button + # Customize the default title for this input + attr_reader :title + end + + class Email < Stripe::StripeObject + # The collected email address + attr_reader :value + end + + class Numeric < Stripe::StripeObject + # The collected number + attr_reader :value + end + + class Phone < Stripe::StripeObject + # The collected phone number + attr_reader :value + end + + class Selection < Stripe::StripeObject + class Choice < Stripe::StripeObject + # The id to be selected + attr_reader :id + # The button style for the choice + attr_reader :style + # The text to be selected + attr_reader :text + end + # List of possible choices to be selected + attr_reader :choices + # The id of the selected choice + attr_reader :id + # The text of the selected choice + attr_reader :text + end + + class Signature < Stripe::StripeObject + # The File ID of a collected signature image + attr_reader :value + end + + class Text < Stripe::StripeObject + # The collected text value + attr_reader :value + end + + class Toggle < Stripe::StripeObject + # The toggle's default value + attr_reader :default_value + # The toggle's description text + attr_reader :description + # The toggle's title text + attr_reader :title + # The toggle's collected value + attr_reader :value + end + # Default text of input being collected. + attr_reader :custom_text + # Information about a email being collected using a reader + attr_reader :email + # Information about a number being collected using a reader + attr_reader :numeric + # Information about a phone number being collected using a reader + attr_reader :phone + # Indicate that this input is required, disabling the skip button. + attr_reader :required + # Information about a selection being collected using a reader + attr_reader :selection + # Information about a signature being collected using a reader + attr_reader :signature + # Indicate that this input was skipped by the user. + attr_reader :skipped + # Information about text being collected using a reader + attr_reader :text + # List of toggles being collected. Values are present if collection is complete. + attr_reader :toggles + # Type of input being collected. + attr_reader :type + end + # List of inputs to be collected. + attr_reader :inputs + # 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. + attr_reader :metadata + end + class ProcessPaymentIntent < Stripe::StripeObject class ProcessConfig < Stripe::StripeObject class Tipping < Stripe::StripeObject @@ -26,6 +120,8 @@ class Tipping < Stripe::StripeObject end # Enable customer initiated cancellation when processing this payment. attr_reader :enable_customer_cancellation + # If the customer does not abandon authenticating the payment, they will be redirected to this specified URL after completion. + attr_reader :return_url # Override showing a tipping selection screen on this transaction. attr_reader :skip_tipping # Represents a per-transaction tipping configuration @@ -99,6 +195,8 @@ class LineItem < Stripe::StripeObject # Type of information to be displayed by the reader. attr_reader :type end + # Represents a reader action to collect customer inputs + attr_reader :collect_inputs # Failure code, only set if status is `failed`. attr_reader :failure_code # Detailed failure message, only set if status is `failed`. @@ -117,8 +215,7 @@ class LineItem < Stripe::StripeObject attr_reader :type end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -210,6 +307,96 @@ def initialize(expand: nil) end end + class CollectInputsParams < Stripe::RequestParams + class Input < Stripe::RequestParams + class CustomText < Stripe::RequestParams + # The description which will be displayed when collecting this input + attr_accessor :description + # The skip button text + attr_accessor :skip_button + # The submit button text + attr_accessor :submit_button + # The title which will be displayed when collecting this input + attr_accessor :title + + def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil) + @description = description + @skip_button = skip_button + @submit_button = submit_button + @title = title + end + end + + class Selection < Stripe::RequestParams + class Choice < Stripe::RequestParams + # The unique identifier for this choice + attr_accessor :id + # The style of the button which will be shown for this choice + attr_accessor :style + # The text which will be shown on the button for this choice + attr_accessor :text + + def initialize(id: nil, style: nil, text: nil) + @id = id + @style = style + @text = text + end + end + # List of choices for the `selection` input + attr_accessor :choices + + def initialize(choices: nil) + @choices = choices + end + end + + class Toggle < Stripe::RequestParams + # The default value of the toggle + attr_accessor :default_value + # The description which will be displayed for the toggle + attr_accessor :description + # The title which will be displayed for the toggle + attr_accessor :title + + def initialize(default_value: nil, description: nil, title: nil) + @default_value = default_value + @description = description + @title = title + end + end + # Customize the text which will be displayed while collecting this input + attr_accessor :custom_text + # Indicate that this input is required, disabling the skip button + attr_accessor :required + # Options for the `selection` input + attr_accessor :selection + # List of toggles to be displayed and customization for the toggles + attr_accessor :toggles + # The type of input to collect + attr_accessor :type + + def initialize(custom_text: nil, required: nil, selection: nil, toggles: nil, type: nil) + @custom_text = custom_text + @required = required + @selection = selection + @toggles = toggles + @type = type + end + end + # Specifies which fields in the response should be expanded. + attr_accessor :expand + # List of inputs to be collected using the Reader + attr_accessor :inputs + # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + attr_accessor :metadata + + def initialize(expand: nil, inputs: nil, metadata: nil) + @expand = expand + @inputs = inputs + @metadata = metadata + end + end + class ProcessPaymentIntentParams < Stripe::RequestParams class ProcessConfig < Stripe::RequestParams class Tipping < Stripe::RequestParams @@ -224,6 +411,8 @@ def initialize(amount_eligible: nil) attr_accessor :allow_redisplay # Enables cancel button on transaction screens. attr_accessor :enable_customer_cancellation + # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. + attr_accessor :return_url # Override showing a tipping selection screen on this transaction. attr_accessor :skip_tipping # Tipping configuration for this transaction. @@ -232,11 +421,13 @@ def initialize(amount_eligible: nil) def initialize( allow_redisplay: nil, enable_customer_cancellation: nil, + return_url: nil, skip_tipping: nil, tipping: nil ) @allow_redisplay = allow_redisplay @enable_customer_cancellation = enable_customer_cancellation + @return_url = return_url @skip_tipping = skip_tipping @tipping = tipping end @@ -417,11 +608,32 @@ def initialize( @type = type end end + + class SucceedInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + attr_accessor :expand + # This parameter defines the skip behavior for input collection. + attr_accessor :skip_non_required_inputs + + def initialize(expand: nil, skip_non_required_inputs: nil) + @expand = expand + @skip_non_required_inputs = skip_non_required_inputs + end + end + + class TimeoutInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + attr_accessor :expand + + def initialize(expand: nil) + @expand = expand + end + end # The most recent action performed by the reader. attr_reader :action # The current software version of the reader. attr_reader :device_sw_version - # Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. + # Device type of the reader. attr_reader :device_type # Unique identifier for the object. attr_reader :id @@ -464,6 +676,26 @@ def self.cancel_action(reader, params = {}, opts = {}) ) end + # Initiates an input collection flow on a Reader. + def collect_inputs(params = {}, opts = {}) + request_stripe_object( + method: :post, + path: format("/v1/terminal/readers/%s/collect_inputs", { reader: CGI.escape(self["id"]) }), + params: params, + opts: opts + ) + end + + # Initiates an input collection flow on a Reader. + def self.collect_inputs(reader, params = {}, opts = {}) + request_stripe_object( + method: :post, + path: format("/v1/terminal/readers/%s/collect_inputs", { reader: CGI.escape(reader) }), + params: params, + opts: opts + ) + end + # Creates a new Reader object. def self.create(params = {}, opts = {}) request_stripe_object( @@ -623,6 +855,46 @@ def present_payment_method(params = {}, opts = {}) opts: opts ) end + + # Use this endpoint to trigger a successful input collection on a simulated reader. + def self.succeed_input_collection(reader, params = {}, opts = {}) + request_stripe_object( + method: :post, + path: format("/v1/test_helpers/terminal/readers/%s/succeed_input_collection", { reader: CGI.escape(reader) }), + params: params, + opts: opts + ) + end + + # Use this endpoint to trigger a successful input collection on a simulated reader. + def succeed_input_collection(params = {}, opts = {}) + @resource.request_stripe_object( + method: :post, + path: format("/v1/test_helpers/terminal/readers/%s/succeed_input_collection", { reader: CGI.escape(@resource["id"]) }), + params: params, + opts: opts + ) + end + + # Use this endpoint to complete an input collection with a timeout error on a simulated reader. + def self.timeout_input_collection(reader, params = {}, opts = {}) + request_stripe_object( + method: :post, + path: format("/v1/test_helpers/terminal/readers/%s/timeout_input_collection", { reader: CGI.escape(reader) }), + params: params, + opts: opts + ) + end + + # Use this endpoint to complete an input collection with a timeout error on a simulated reader. + def timeout_input_collection(params = {}, opts = {}) + @resource.request_stripe_object( + method: :post, + path: format("/v1/test_helpers/terminal/readers/%s/timeout_input_collection", { reader: CGI.escape(@resource["id"]) }), + params: params, + opts: opts + ) + end end end end diff --git a/lib/stripe/resources/test_helpers/test_clock.rb b/lib/stripe/resources/test_helpers/test_clock.rb index 2acf36836..b1a93d0d3 100644 --- a/lib/stripe/resources/test_helpers/test_clock.rb +++ b/lib/stripe/resources/test_helpers/test_clock.rb @@ -25,8 +25,7 @@ class Advancing < Stripe::StripeObject attr_reader :advancing end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams # 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. diff --git a/lib/stripe/resources/token.rb b/lib/stripe/resources/token.rb index 52a4752c4..065129b62 100644 --- a/lib/stripe/resources/token.rb +++ b/lib/stripe/resources/token.rb @@ -19,7 +19,7 @@ module Stripe # # You can't store or use tokens more than once. To store card or bank account # information for later use, create [Customer](https://stripe.com/docs/api#customers) - # objects or [External accounts](https://stripe.com/api#external_accounts). + # objects or [External accounts](https://docs.stripe.com/api#external_accounts). # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, # performs best with integrations that use client-side tokenization. class Token < APIResource @@ -1251,7 +1251,7 @@ def initialize( attr_reader :used # Creates a single-use token that represents a bank account's details. - # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. + # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/tokens", params: params, opts: opts) end diff --git a/lib/stripe/resources/transfer.rb b/lib/stripe/resources/transfer.rb index d88b8cab7..c468e04ae 100644 --- a/lib/stripe/resources/transfer.rb +++ b/lib/stripe/resources/transfer.rb @@ -169,7 +169,7 @@ def initialize(description: nil, expand: nil, metadata: nil) # A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. attr_reader :transfer_group - # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. + # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/transfers", params: params, opts: opts) end diff --git a/lib/stripe/resources/webhook_endpoint.rb b/lib/stripe/resources/webhook_endpoint.rb index 365cf6663..fa257f16b 100644 --- a/lib/stripe/resources/webhook_endpoint.rb +++ b/lib/stripe/resources/webhook_endpoint.rb @@ -20,8 +20,7 @@ def self.object_name "webhook_endpoint" end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # An optional description of what the webhook is used for. diff --git a/lib/stripe/services/account_external_account_service.rb b/lib/stripe/services/account_external_account_service.rb index 03a94d350..a83153697 100644 --- a/lib/stripe/services/account_external_account_service.rb +++ b/lib/stripe/services/account_external_account_service.rb @@ -3,8 +3,7 @@ module Stripe class AccountExternalAccountService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -301,7 +300,7 @@ def retrieve(account, id, params = {}, opts = {}) # a connected account and optionally sets it as the default for its currency. Other bank account # details are not editable by design. # - # You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection). + # You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection). # # You can re-enable a disabled bank account by performing an update call without providing any # arguments or changes. diff --git a/lib/stripe/services/account_login_link_service.rb b/lib/stripe/services/account_login_link_service.rb index 80b16c8b4..c21518528 100644 --- a/lib/stripe/services/account_login_link_service.rb +++ b/lib/stripe/services/account_login_link_service.rb @@ -14,7 +14,7 @@ def initialize(expand: nil) # Creates a login link for a connected account to access the Express Dashboard. # - # You can only create login links for accounts that use the [Express Dashboard](https://stripe.com/connect/express-dashboard) and are connected to your platform. + # You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform. def create(account, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/account_person_service.rb b/lib/stripe/services/account_person_service.rb index 6a3c4669b..aa8d5a57b 100644 --- a/lib/stripe/services/account_person_service.rb +++ b/lib/stripe/services/account_person_service.rb @@ -3,8 +3,7 @@ module Stripe class AccountPersonService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/account_service.rb b/lib/stripe/services/account_service.rb index d07c29e31..65ad1e9fa 100644 --- a/lib/stripe/services/account_service.rb +++ b/lib/stripe/services/account_service.rb @@ -13,8 +13,7 @@ def initialize(requestor) @persons = Stripe::AccountPersonService.new(@requestor) end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -543,6 +542,15 @@ def initialize(requested: nil) end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + attr_accessor :requested + + def initialize(requested: nil) + @requested = requested + end + end + class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. attr_accessor :requested @@ -768,6 +776,8 @@ def initialize(requested: nil) attr_accessor :payco_payments # The paynow_payments capability. attr_accessor :paynow_payments + # The pix_payments capability. + attr_accessor :pix_payments # The promptpay_payments capability. attr_accessor :promptpay_payments # The revolut_pay_payments capability. @@ -843,6 +853,7 @@ def initialize( pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -901,6 +912,7 @@ def initialize( @pay_by_bank_payments = pay_by_bank_payments @payco_payments = payco_payments @paynow_payments = paynow_payments + @pix_payments = pix_payments @promptpay_payments = promptpay_payments @revolut_pay_payments = revolut_pay_payments @samsung_pay_payments = samsung_pay_payments @@ -2551,6 +2563,15 @@ def initialize(requested: nil) end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + attr_accessor :requested + + def initialize(requested: nil) + @requested = requested + end + end + class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. attr_accessor :requested @@ -2776,6 +2797,8 @@ def initialize(requested: nil) attr_accessor :payco_payments # The paynow_payments capability. attr_accessor :paynow_payments + # The pix_payments capability. + attr_accessor :pix_payments # The promptpay_payments capability. attr_accessor :promptpay_payments # The revolut_pay_payments capability. @@ -2851,6 +2874,7 @@ def initialize( pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -2909,6 +2933,7 @@ def initialize( @pay_by_bank_payments = pay_by_bank_payments @payco_payments = payco_payments @paynow_payments = paynow_payments + @pix_payments = pix_payments @promptpay_payments = promptpay_payments @revolut_pay_payments = revolut_pay_payments @samsung_pay_payments = samsung_pay_payments @@ -4059,21 +4084,21 @@ def initialize(expand: nil, reason: nil) end end - # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users. + # With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users. # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings). # - # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when + # If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding. # You can prefill any information on the account. def create(params = {}, opts = {}) request(method: :post, path: "/v1/accounts", params: params, opts: opts, base_address: :api) end - # With [Connect](https://stripe.com/connect), you can delete accounts you manage. + # With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage. # # Test-mode accounts can be deleted at any time. # - # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero. + # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero. # # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. def delete(account, params = {}, opts = {}) @@ -4086,12 +4111,12 @@ def delete(account, params = {}, opts = {}) ) end - # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty. + # Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty. def list(params = {}, opts = {}) request(method: :get, path: "/v1/accounts", params: params, opts: opts, base_address: :api) end - # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. + # With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious. # # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. def reject(account, params = {}, opts = {}) @@ -4120,19 +4145,19 @@ def retrieve_current(params = {}, opts = {}) request(method: :get, path: "/v1/account", params: params, opts: opts, base_address: :api) end - # Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are + # Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are # left unchanged. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is application, which includes Custom accounts, you can update any information on the account. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is stripe, which includes Standard and Express accounts, you can update all information until you create - # an [Account Link or Account Session](https://stripe.com/api/account_links) to start Connect onboarding, + # an [Account Link or Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding, # after which some properties can no longer be updated. # # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our - # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. + # [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. def update(account, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/account_session_service.rb b/lib/stripe/services/account_session_service.rb index 2da904018..04af0e9ae 100644 --- a/lib/stripe/services/account_session_service.rb +++ b/lib/stripe/services/account_session_service.rb @@ -95,8 +95,28 @@ def initialize(enabled: nil, features: nil) end end - class Documents < Stripe::RequestParams + class DisputesList < Stripe::RequestParams class Features < Stripe::RequestParams + # Whether to allow capturing and cancelling payment intents. This is `true` by default. + attr_accessor :capture_payments + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + attr_accessor :refund_management + + def initialize( + capture_payments: nil, + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ) + @capture_payments = capture_payments + @destination_on_behalf_of_charge_management = destination_on_behalf_of_charge_management + @dispute_management = dispute_management + @refund_management = refund_management + end end # Whether the embedded component is enabled. attr_accessor :enabled @@ -109,6 +129,19 @@ def initialize(enabled: nil, features: nil) end end + class Documents < Stripe::RequestParams + class Features < Stripe::RequestParams; end + # Whether the embedded component is enabled. + attr_accessor :enabled + # The list of features enabled in the embedded component. + attr_accessor :features + + def initialize(enabled: nil, features: nil) + @enabled = enabled + @features = features + end + end + class FinancialAccount < Stripe::RequestParams class Features < Stripe::RequestParams # Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. @@ -295,6 +328,36 @@ def initialize(enabled: nil, features: nil) end end + class PaymentDisputes < Stripe::RequestParams + class Features < Stripe::RequestParams + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + attr_accessor :refund_management + + def initialize( + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ) + @destination_on_behalf_of_charge_management = destination_on_behalf_of_charge_management + @dispute_management = dispute_management + @refund_management = refund_management + end + end + # Whether the embedded component is enabled. + attr_accessor :enabled + # The list of features enabled in the embedded component. + attr_accessor :features + + def initialize(enabled: nil, features: nil) + @enabled = enabled + @features = features + end + end + class Payments < Stripe::RequestParams class Features < Stripe::RequestParams # Whether to allow capturing and cancelling payment intents. This is `true` by default. @@ -368,8 +431,7 @@ def initialize(enabled: nil, features: nil) end class PayoutsList < Stripe::RequestParams - class Features < Stripe::RequestParams - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. attr_accessor :enabled # The list of features enabled in the embedded component. @@ -382,8 +444,7 @@ def initialize(enabled: nil, features: nil) end class TaxRegistrations < Stripe::RequestParams - class Features < Stripe::RequestParams - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. attr_accessor :enabled # The list of features enabled in the embedded component. @@ -396,8 +457,7 @@ def initialize(enabled: nil, features: nil) end class TaxSettings < Stripe::RequestParams - class Features < Stripe::RequestParams - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. attr_accessor :enabled # The list of features enabled in the embedded component. @@ -414,6 +474,8 @@ def initialize(enabled: nil, features: nil) attr_accessor :account_onboarding # Configuration for the balances embedded component. attr_accessor :balances + # Configuration for the disputes list embedded component. + attr_accessor :disputes_list # Configuration for the documents embedded component. attr_accessor :documents # Configuration for the financial account embedded component. @@ -428,6 +490,8 @@ def initialize(enabled: nil, features: nil) attr_accessor :notification_banner # Configuration for the payment details embedded component. attr_accessor :payment_details + # Configuration for the payment disputes embedded component. + attr_accessor :payment_disputes # Configuration for the payments embedded component. attr_accessor :payments # Configuration for the payouts embedded component. @@ -443,6 +507,7 @@ def initialize( account_management: nil, account_onboarding: nil, balances: nil, + disputes_list: nil, documents: nil, financial_account: nil, financial_account_transactions: nil, @@ -450,6 +515,7 @@ def initialize( issuing_cards_list: nil, notification_banner: nil, payment_details: nil, + payment_disputes: nil, payments: nil, payouts: nil, payouts_list: nil, @@ -459,6 +525,7 @@ def initialize( @account_management = account_management @account_onboarding = account_onboarding @balances = balances + @disputes_list = disputes_list @documents = documents @financial_account = financial_account @financial_account_transactions = financial_account_transactions @@ -466,6 +533,7 @@ def initialize( @issuing_cards_list = issuing_cards_list @notification_banner = notification_banner @payment_details = payment_details + @payment_disputes = payment_disputes @payments = payments @payouts = payouts @payouts_list = payouts_list diff --git a/lib/stripe/services/apple_pay_domain_service.rb b/lib/stripe/services/apple_pay_domain_service.rb index 569e4c5b0..e89d1104e 100644 --- a/lib/stripe/services/apple_pay_domain_service.rb +++ b/lib/stripe/services/apple_pay_domain_service.rb @@ -3,8 +3,7 @@ module Stripe class ApplePayDomainService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/balance_service.rb b/lib/stripe/services/balance_service.rb index 2849e754f..8d252438c 100644 --- a/lib/stripe/services/balance_service.rb +++ b/lib/stripe/services/balance_service.rb @@ -13,7 +13,7 @@ def initialize(expand: nil) end # Retrieves the current account balance, based on the authentication that was used to make the request. - # For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances). + # For a sample request, see [Accounting for negative balances](https://docs.stripe.com/docs/connect/account-balances#accounting-for-negative-balances). def retrieve(params = {}, opts = {}) request(method: :get, path: "/v1/balance", params: params, opts: opts, base_address: :api) end diff --git a/lib/stripe/services/charge_service.rb b/lib/stripe/services/charge_service.rb index 161a0d363..5b328a0b5 100644 --- a/lib/stripe/services/charge_service.rb +++ b/lib/stripe/services/charge_service.rb @@ -407,9 +407,9 @@ def initialize( # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false. # - # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. + # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. # - # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture). + # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture). def capture(charge, params = {}, opts = {}) request( method: :post, @@ -420,7 +420,7 @@ def capture(charge, params = {}, opts = {}) ) end - # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents) + # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents) # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge # object used to request payment. def create(params = {}, opts = {}) @@ -443,7 +443,7 @@ def retrieve(charge, params = {}, opts = {}) ) end - # Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for charges you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/lib/stripe/services/checkout/session_service.rb b/lib/stripe/services/checkout/session_service.rb index 94fe645a9..e99794925 100644 --- a/lib/stripe/services/checkout/session_service.rb +++ b/lib/stripe/services/checkout/session_service.rb @@ -1310,8 +1310,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds will be captured from the customer's account. @@ -1707,11 +1706,18 @@ def initialize(enabled: nil) class SavedPaymentMethodOptions < Stripe::RequestParams # 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. attr_accessor :allow_redisplay_filters + # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. + attr_accessor :payment_method_remove # Enable customers to choose if they wish to save their payment method for future use. Disabled by default. attr_accessor :payment_method_save - def initialize(allow_redisplay_filters: nil, payment_method_save: nil) + def initialize( + allow_redisplay_filters: nil, + payment_method_remove: nil, + payment_method_save: nil + ) @allow_redisplay_filters = allow_redisplay_filters + @payment_method_remove = payment_method_remove @payment_method_save = payment_method_save end end @@ -2473,6 +2479,8 @@ def retrieve(session, params = {}, opts = {}) end # Updates a Checkout Session object. + # + # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates) def update(session, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/coupon_service.rb b/lib/stripe/services/coupon_service.rb index a340f69e4..fc1d83cb7 100644 --- a/lib/stripe/services/coupon_service.rb +++ b/lib/stripe/services/coupon_service.rb @@ -3,8 +3,7 @@ module Stripe class CouponService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/credit_note_service.rb b/lib/stripe/services/credit_note_service.rb index 8fee87065..74dddab34 100644 --- a/lib/stripe/services/credit_note_service.rb +++ b/lib/stripe/services/credit_note_service.rb @@ -376,20 +376,19 @@ def initialize(expand: nil) end end - # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces - # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result - # in any combination of the following: + # 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. + # 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: # # - # Refund: create a new refund (using refund_amount) or link an existing refund (using refund). + # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds). # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized. # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount). # # - # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total. + # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount. # - # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount - # or post_payment_credit_notes_amount depending on its status at the time of credit note creation. + # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount, + # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation. def create(params = {}, opts = {}) request( method: :post, @@ -444,7 +443,7 @@ def update(id, params = {}, opts = {}) ) end - # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). def void_credit_note(id, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/customer_balance_transaction_service.rb b/lib/stripe/services/customer_balance_transaction_service.rb index 4a7bd9c86..c82cba43d 100644 --- a/lib/stripe/services/customer_balance_transaction_service.rb +++ b/lib/stripe/services/customer_balance_transaction_service.rb @@ -66,7 +66,7 @@ def initialize(description: nil, expand: nil, metadata: nil) end end - # Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance). + # Creates an immutable transaction that updates the customer's credit [balance](https://docs.stripe.com/docs/billing/customer/balance). def create(customer, params = {}, opts = {}) request( method: :post, @@ -77,7 +77,7 @@ def create(customer, params = {}, opts = {}) ) end - # Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance). + # Returns a list of transactions that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance). def list(customer, params = {}, opts = {}) request( method: :get, @@ -88,7 +88,7 @@ def list(customer, params = {}, opts = {}) ) end - # Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance). + # Retrieves a specific customer balance transaction that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance). def retrieve(customer, transaction, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/customer_cash_balance_transaction_service.rb b/lib/stripe/services/customer_cash_balance_transaction_service.rb index fa7b07df5..f88065d8f 100644 --- a/lib/stripe/services/customer_cash_balance_transaction_service.rb +++ b/lib/stripe/services/customer_cash_balance_transaction_service.rb @@ -30,7 +30,7 @@ def initialize(expand: nil) end end - # Returns a list of transactions that modified the customer's [cash balance](https://stripe.com/docs/payments/customer-balance). + # Returns a list of transactions that modified the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance). def list(customer, params = {}, opts = {}) request( method: :get, @@ -41,7 +41,7 @@ def list(customer, params = {}, opts = {}) ) end - # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://stripe.com/docs/payments/customer-balance). + # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance). def retrieve(customer, transaction, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/customer_payment_source_service.rb b/lib/stripe/services/customer_payment_source_service.rb index 462d38043..ce17df949 100644 --- a/lib/stripe/services/customer_payment_source_service.rb +++ b/lib/stripe/services/customer_payment_source_service.rb @@ -186,7 +186,7 @@ def initialize(amounts: nil, expand: nil) # # If the card's owner has no default card, then the new card will become the default. # However, if the owner already has a default, then it will not change. - # To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source. + # To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source. def create(customer, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/customer_service.rb b/lib/stripe/services/customer_service.rb index 95ee78ce7..1d0e58029 100644 --- a/lib/stripe/services/customer_service.rb +++ b/lib/stripe/services/customer_service.rb @@ -16,8 +16,7 @@ def initialize(requestor) @funding_instructions = Stripe::CustomerFundingInstructionsService.new(@requestor) end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -266,8 +265,7 @@ def initialize( end end - class DeleteDiscountParams < Stripe::RequestParams - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Created < Stripe::RequestParams @@ -636,7 +634,7 @@ def retrieve(customer, params = {}, opts = {}) ) end - # Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for customers you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/lib/stripe/services/customer_tax_id_service.rb b/lib/stripe/services/customer_tax_id_service.rb index bcdf69335..8b0bc3a56 100644 --- a/lib/stripe/services/customer_tax_id_service.rb +++ b/lib/stripe/services/customer_tax_id_service.rb @@ -3,8 +3,7 @@ module Stripe class CustomerTaxIdService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/dispute_service.rb b/lib/stripe/services/dispute_service.rb index ce23b5ce2..cc266abd6 100644 --- a/lib/stripe/services/dispute_service.rb +++ b/lib/stripe/services/dispute_service.rb @@ -408,7 +408,7 @@ def retrieve(dispute, params = {}, opts = {}) # 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. # - # 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). + # 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). def update(dispute, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/file_service.rb b/lib/stripe/services/file_service.rb index 6304b84cd..bb2adff9e 100644 --- a/lib/stripe/services/file_service.rb +++ b/lib/stripe/services/file_service.rb @@ -110,7 +110,7 @@ def list(params = {}, opts = {}) request(method: :get, path: "/v1/files", params: params, opts: opts, base_address: :api) end - # 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). + # 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). def retrieve(file, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/identity/verification_session_service.rb b/lib/stripe/services/identity/verification_session_service.rb index b242c31f6..85668f9b6 100644 --- a/lib/stripe/services/identity/verification_session_service.rb +++ b/lib/stripe/services/identity/verification_session_service.rb @@ -235,9 +235,9 @@ def initialize(expand: nil) end end - # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work). + # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work). # - # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel). + # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel). def cancel(session, params = {}, opts = {}) request( method: :post, @@ -254,7 +254,7 @@ def cancel(session, params = {}, opts = {}) # # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode. # - # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents) + # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents) def create(params = {}, opts = {}) request( method: :post, @@ -281,7 +281,7 @@ def list(params = {}, opts = {}) # request logs, etc. # # A VerificationSession object can be redacted when it is in requires_input or verified - # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action + # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action # state will automatically cancel it. # # The redaction process may take up to four days. When the redaction process is in progress, the @@ -294,7 +294,7 @@ def list(params = {}, opts = {}) # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or # used for any purpose. # - # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact). + # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact). def redact(session, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/invoice_item_service.rb b/lib/stripe/services/invoice_item_service.rb index a3b95a830..9c145ae07 100644 --- a/lib/stripe/services/invoice_item_service.rb +++ b/lib/stripe/services/invoice_item_service.rb @@ -3,8 +3,7 @@ module Stripe class InvoiceItemService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/invoice_service.rb b/lib/stripe/services/invoice_service.rb index a130169dd..da75030e6 100644 --- a/lib/stripe/services/invoice_service.rb +++ b/lib/stripe/services/invoice_service.rb @@ -10,8 +10,7 @@ def initialize(requestor) @line_items = Stripe::InvoiceLineItemService.new(@requestor) end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -188,11 +187,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -838,11 +834,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -1488,6 +1481,18 @@ def initialize(expand: nil, invoice_metadata: nil, lines: nil) end end + class AttachPaymentParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + attr_accessor :expand + # The ID of the PaymentIntent to attach to the invoice. + attr_accessor :payment_intent + + def initialize(expand: nil, payment_intent: nil) + @expand = expand + @payment_intent = payment_intent + end + end + class FinalizeInvoiceParams < Stripe::RequestParams # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. attr_accessor :auto_advance @@ -2197,6 +2202,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -2239,6 +2256,15 @@ def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -2295,6 +2321,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. @@ -2311,6 +2339,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -2319,6 +2348,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -2348,6 +2378,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -2372,7 +2404,7 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :metadata # The account on behalf of which to charge, for each of the associated subscription's invoices. attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. attr_accessor :start_date @@ -2388,6 +2420,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -2410,6 +2443,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @currency = currency @default_payment_method = default_payment_method @@ -2445,6 +2479,15 @@ def initialize(end_behavior: nil, phases: nil, proration_behavior: nil) class SubscriptionDetails < Stripe::RequestParams class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -2501,6 +2544,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. attr_accessor :clear_usage # A flag that, if set to `true`, will delete the specified item. @@ -2523,6 +2568,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -2534,6 +2580,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @clear_usage = clear_usage @deleted = deleted @discounts = discounts @@ -2550,7 +2597,7 @@ def initialize( attr_accessor :billing_cycle_anchor # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. attr_accessor :cancel_now @@ -2668,16 +2715,38 @@ def add_lines(invoice, params = {}, opts = {}) ) end - # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. + # + # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited + # to the invoice, increasing its amount_paid. When the invoice is fully paid, the + # invoice's status becomes paid. + # + # If the PaymentIntent's status is already succeeded when it's attached, it's + # credited to the invoice immediately. + # + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. + def attach_payment(invoice, params = {}, opts = {}) + request( + method: :post, + path: format("/v1/invoices/%s/attach_payment", { invoice: CGI.escape(invoice) }), + params: params, + opts: opts, + base_address: :api + ) + end + + # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers. def create(params = {}, opts = {}) request(method: :post, path: "/v1/invoices", params: params, opts: opts, base_address: :api) end # At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. # - # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. + # You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. # - # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request. + # The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true. + # + # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. # # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions) def create_preview(params = {}, opts = {}) @@ -2690,7 +2759,7 @@ def create_preview(params = {}, opts = {}) ) end - # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice). + # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice). def delete(invoice, params = {}, opts = {}) request( method: :delete, @@ -2761,7 +2830,7 @@ def retrieve(invoice, params = {}, opts = {}) ) end - # Search for invoices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for invoices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. @@ -2788,11 +2857,11 @@ def send_invoice(invoice, params = {}, opts = {}) ) end - # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized), + # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized), # monetary values, as well as collection_method, become uneditable. # # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, - # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass + # sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass # auto_advance=false. def update(invoice, params = {}, opts = {}) request( @@ -2815,9 +2884,9 @@ def update_lines(invoice, params = {}, opts = {}) ) end - # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. + # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. # - # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. + # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. def void_invoice(invoice, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/issuing/authorization_service.rb b/lib/stripe/services/issuing/authorization_service.rb index 77c99384d..ebecd7806 100644 --- a/lib/stripe/services/issuing/authorization_service.rb +++ b/lib/stripe/services/issuing/authorization_service.rb @@ -108,8 +108,8 @@ def initialize(expand: nil, metadata: nil) end end - # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). def approve(authorization, params = {}, opts = {}) request( method: :post, @@ -120,8 +120,8 @@ def approve(authorization, params = {}, opts = {}) ) end - # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). def decline(authorization, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/issuing/card_service.rb b/lib/stripe/services/issuing/card_service.rb index dec1bf0fe..cbda739c8 100644 --- a/lib/stripe/services/issuing/card_service.rb +++ b/lib/stripe/services/issuing/card_service.rb @@ -219,7 +219,7 @@ def initialize( attr_accessor :currency # Specifies which fields in the response should be expanded. attr_accessor :expand - # Attribute for param field financial_account + # The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account. attr_accessor :financial_account # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. attr_accessor :metadata diff --git a/lib/stripe/services/issuing/dispute_service.rb b/lib/stripe/services/issuing/dispute_service.rb index d172a921a..bafb3fda6 100644 --- a/lib/stripe/services/issuing/dispute_service.rb +++ b/lib/stripe/services/issuing/dispute_service.rb @@ -637,7 +637,7 @@ def initialize(expand: nil, metadata: nil) end end - # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. + # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. def create(params = {}, opts = {}) request( method: :post, @@ -670,7 +670,7 @@ def retrieve(dispute, params = {}, opts = {}) ) end - # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). + # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). def submit(dispute, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/payment_intent_service.rb b/lib/stripe/services/payment_intent_service.rb index 3bd85b28e..654d20c85 100644 --- a/lib/stripe/services/payment_intent_service.rb +++ b/lib/stripe/services/payment_intent_service.rb @@ -68,8 +68,7 @@ def initialize(allow_redirects: nil, enabled: nil) class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -122,20 +121,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -161,11 +151,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -218,8 +205,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -230,11 +216,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -257,11 +240,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -272,11 +252,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -301,20 +278,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -356,8 +324,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -368,23 +335,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -395,14 +351,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -422,11 +373,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -455,11 +403,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -1379,8 +1324,7 @@ def initialize(setup_future_usage: nil) end end - class InteracPresent < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -1638,8 +1582,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -1781,6 +1724,19 @@ def initialize(capture_method: nil) end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + attr_accessor :capture_method + + def initialize(capture_method: nil) + @capture_method = capture_method + end + end + class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -2076,6 +2032,8 @@ def initialize(setup_future_usage: nil) attr_accessor :revolut_pay # If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. attr_accessor :sepa_debit # If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options. @@ -2133,6 +2091,7 @@ def initialize( promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -2182,6 +2141,7 @@ def initialize( @promptpay = promptpay @revolut_pay = revolut_pay @samsung_pay = samsung_pay + @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @swish = swish @@ -2315,6 +2275,8 @@ def initialize(amount: nil, destination: nil) # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. # # If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. + # If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent. + # end attr_accessor :payment_method # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. attr_accessor :payment_method_configuration @@ -2454,20 +2416,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -2493,11 +2446,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -2550,8 +2500,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -2562,11 +2511,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -2589,11 +2535,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -2604,11 +2547,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -2633,20 +2573,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -2688,8 +2619,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -2700,23 +2630,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -2727,14 +2646,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -2754,11 +2668,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -2787,11 +2698,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -3711,8 +3619,7 @@ def initialize(setup_future_usage: nil) end end - class InteracPresent < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -3970,8 +3877,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -4113,6 +4019,19 @@ def initialize(capture_method: nil) end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + attr_accessor :capture_method + + def initialize(capture_method: nil) + @capture_method = capture_method + end + end + class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -4408,6 +4327,8 @@ def initialize(setup_future_usage: nil) attr_accessor :revolut_pay # If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. attr_accessor :sepa_debit # If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options. @@ -4465,6 +4386,7 @@ def initialize( promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -4514,6 +4436,7 @@ def initialize( @promptpay = promptpay @revolut_pay = revolut_pay @samsung_pay = samsung_pay + @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @swish = swish @@ -4787,8 +4710,7 @@ def initialize( class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -4841,20 +4763,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -4880,11 +4793,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -4937,8 +4847,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -4949,11 +4858,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -4976,11 +4882,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -4991,11 +4894,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -5020,20 +4920,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -5075,8 +4966,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -5087,23 +4977,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -5114,14 +4993,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -5141,11 +5015,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -5174,11 +5045,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -6098,8 +5966,7 @@ def initialize(setup_future_usage: nil) end end - class InteracPresent < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -6357,8 +6224,7 @@ def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil) end end - class PayByBank < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. @@ -6500,6 +6366,19 @@ def initialize(capture_method: nil) end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + attr_accessor :capture_method + + def initialize(capture_method: nil) + @capture_method = capture_method + end + end + class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -6795,6 +6674,8 @@ def initialize(setup_future_usage: nil) attr_accessor :revolut_pay # If this is a `samsung_pay` PaymentMethod, this sub-hash contains details about the Samsung Pay payment method options. attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. attr_accessor :sepa_debit # If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options. @@ -6852,6 +6733,7 @@ def initialize( promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -6901,6 +6783,7 @@ def initialize( @promptpay = promptpay @revolut_pay = revolut_pay @samsung_pay = samsung_pay + @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @swish = swish @@ -6987,6 +6870,7 @@ def initialize(address: nil, carrier: nil, name: nil, phone: nil, tracking_numbe # Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). attr_accessor :off_session # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + # If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent. attr_accessor :payment_method # If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear # in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) @@ -7128,11 +7012,11 @@ def apply_customer_balance(intent, params = {}, opts = {}) ) end - # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://stripe.com/docs/payments/intents), processing. + # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing. # # After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. # - # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. def cancel(intent, params = {}, opts = {}) request( method: :post, @@ -7147,7 +7031,7 @@ def cancel(intent, params = {}, opts = {}) # # Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. # - # Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later). + # Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later). def capture(intent, params = {}, opts = {}) request( method: :post, @@ -7169,8 +7053,8 @@ def capture(intent, params = {}, opts = {}) # payment succeeds, the PaymentIntent will transition to the succeeded # status (or requires_capture, if capture_method is set to manual). # If the confirmation_method is automatic, payment may be attempted - # using our [client SDKs](https://stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) - # and the PaymentIntent's [client_secret](https://stripe.com/docs/api#payment_intent_object-client_secret). + # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) + # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret). # After next_actions are handled by the client, no additional # confirmation is required to complete the payment. # If the confirmation_method is manual, all payment attempts must be @@ -7195,13 +7079,13 @@ def confirm(intent, params = {}, opts = {}) # Creates a PaymentIntent object. # - # After the PaymentIntent is created, attach a payment method and [confirm](https://stripe.com/docs/api/payment_intents/confirm) + # After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm) # to continue the payment. Learn more about the available payment flows # with the Payment Intents API. # # When you use confirm=true during creation, it's equivalent to creating # and confirming the PaymentIntent in the same call. You can use any parameters - # available in the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) when you supply + # available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply # confirm=true. def create(params = {}, opts = {}) request( @@ -7214,9 +7098,9 @@ def create(params = {}, opts = {}) end # Perform an incremental authorization on an eligible - # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the + # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the # PaymentIntent's status must be requires_capture and - # [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + # [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) # must be true. # # Incremental authorizations attempt to increase the authorized amount on @@ -7227,16 +7111,16 @@ def create(params = {}, opts = {}) # # If the incremental authorization succeeds, the PaymentIntent object # returns with the updated - # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). + # [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). # If the incremental authorization fails, a - # [card_declined](https://stripe.com/docs/error-codes#card-declined) error returns, and no other + # [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other # fields on the PaymentIntent or Charge update. The PaymentIntent # object remains capturable for the previously authorized amount. # # Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. # After it's captured, a PaymentIntent can no longer be incremented. # - # Learn more about [incremental authorizations](https://stripe.com/docs/terminal/features/incremental-authorizations). + # Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations). def increment_authorization(intent, params = {}, opts = {}) request( method: :post, @@ -7262,7 +7146,7 @@ def list(params = {}, opts = {}) # # You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string. # - # If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the [payment intent](https://stripe.com/docs/api#payment_intent_object) object reference for more details. + # If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the [payment intent](https://docs.stripe.com/api#payment_intent_object) object reference for more details. def retrieve(intent, params = {}, opts = {}) request( method: :get, @@ -7273,7 +7157,7 @@ def retrieve(intent, params = {}, opts = {}) ) end - # Search for PaymentIntents you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for PaymentIntents you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. @@ -7293,7 +7177,7 @@ def search(params = {}, opts = {}) # PaymentIntent again. For example, updating the payment_method # always requires you to confirm the PaymentIntent again. If you prefer to # update and confirm at the same time, we recommend updating properties through - # the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) instead. + # the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead. def update(intent, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/payment_method_configuration_service.rb b/lib/stripe/services/payment_method_configuration_service.rb index 7a2b28e17..7b7a2df30 100644 --- a/lib/stripe/services/payment_method_configuration_service.rb +++ b/lib/stripe/services/payment_method_configuration_service.rb @@ -456,6 +456,23 @@ def initialize(display_preference: nil) end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -490,6 +507,23 @@ def initialize(display_preference: nil) end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -541,6 +575,23 @@ def initialize(display_preference: nil) end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -609,6 +660,23 @@ def initialize(display_preference: nil) end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -694,6 +762,23 @@ def initialize(display_preference: nil) end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -841,7 +926,7 @@ def initialize(display_preference: nil) attr_accessor :alma # Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. attr_accessor :apple_pay # Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. attr_accessor :apple_pay_later @@ -881,10 +966,14 @@ def initialize(display_preference: nil) attr_accessor :ideal # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. attr_accessor :link # MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. @@ -893,6 +982,8 @@ def initialize(display_preference: nil) attr_accessor :multibanco # Configuration name. attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. attr_accessor :nz_bank_account # OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. @@ -903,6 +994,8 @@ def initialize(display_preference: nil) attr_accessor :parent # Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. attr_accessor :paynow # PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. @@ -913,6 +1006,8 @@ def initialize(display_preference: nil) attr_accessor :promptpay # Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. attr_accessor :satispay # The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. @@ -957,22 +1052,27 @@ def initialize( grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, parent: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, @@ -1008,22 +1108,27 @@ def initialize( @grabpay = grabpay @ideal = ideal @jcb = jcb + @kakao_pay = kakao_pay @klarna = klarna @konbini = konbini + @kr_card = kr_card @link = link @mobilepay = mobilepay @multibanco = multibanco @name = name + @naver_pay = naver_pay @nz_bank_account = nz_bank_account @oxxo = oxxo @p24 = p24 @parent = parent @pay_by_bank = pay_by_bank + @payco = payco @paynow = paynow @paypal = paypal @pix = pix @promptpay = promptpay @revolut_pay = revolut_pay + @samsung_pay = samsung_pay @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort @@ -1470,6 +1575,23 @@ def initialize(display_preference: nil) end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1504,6 +1626,23 @@ def initialize(display_preference: nil) end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1555,6 +1694,23 @@ def initialize(display_preference: nil) end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1623,6 +1779,23 @@ def initialize(display_preference: nil) end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1708,6 +1881,23 @@ def initialize(display_preference: nil) end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + attr_accessor :preference + + def initialize(preference: nil) + @preference = preference + end + end + # Whether or not the payment method should be displayed. + attr_accessor :display_preference + + def initialize(display_preference: nil) + @display_preference = display_preference + end + end + class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1857,7 +2047,7 @@ def initialize(display_preference: nil) attr_accessor :alma # Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. attr_accessor :apple_pay # Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. attr_accessor :apple_pay_later @@ -1897,10 +2087,14 @@ def initialize(display_preference: nil) attr_accessor :ideal # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. attr_accessor :link # MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. @@ -1909,6 +2103,8 @@ def initialize(display_preference: nil) attr_accessor :multibanco # Configuration name. attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. attr_accessor :nz_bank_account # OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. @@ -1917,6 +2113,8 @@ def initialize(display_preference: nil) attr_accessor :p24 # Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. attr_accessor :paynow # PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. @@ -1927,6 +2125,8 @@ def initialize(display_preference: nil) attr_accessor :promptpay # Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. attr_accessor :satispay # The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. @@ -1972,21 +2172,26 @@ def initialize( grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, @@ -2023,21 +2228,26 @@ def initialize( @grabpay = grabpay @ideal = ideal @jcb = jcb + @kakao_pay = kakao_pay @klarna = klarna @konbini = konbini + @kr_card = kr_card @link = link @mobilepay = mobilepay @multibanco = multibanco @name = name + @naver_pay = naver_pay @nz_bank_account = nz_bank_account @oxxo = oxxo @p24 = p24 @pay_by_bank = pay_by_bank + @payco = payco @paynow = paynow @paypal = paypal @pix = pix @promptpay = promptpay @revolut_pay = revolut_pay + @samsung_pay = samsung_pay @satispay = satispay @sepa_debit = sepa_debit @sofort = sofort diff --git a/lib/stripe/services/payment_method_domain_service.rb b/lib/stripe/services/payment_method_domain_service.rb index c37b26d62..ddef0072f 100644 --- a/lib/stripe/services/payment_method_domain_service.rb +++ b/lib/stripe/services/payment_method_domain_service.rb @@ -128,7 +128,7 @@ def update(payment_method_domain, params = {}, opts = {}) # # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. # - # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + # Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration). def validate(payment_method_domain, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/payment_method_service.rb b/lib/stripe/services/payment_method_service.rb index 2b4817789..86d8e1f93 100644 --- a/lib/stripe/services/payment_method_service.rb +++ b/lib/stripe/services/payment_method_service.rb @@ -50,20 +50,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -89,11 +80,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -146,8 +134,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -197,11 +184,8 @@ def initialize( end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -224,11 +208,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -239,11 +220,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -268,20 +246,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -323,8 +292,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -335,23 +303,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -362,14 +319,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -389,11 +341,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -422,11 +371,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -741,11 +687,8 @@ def initialize(exp_month: nil, exp_year: nil, networks: nil) end end - class Link < Stripe::RequestParams - end - - class PayByBank < Stripe::RequestParams - end + class Link < Stripe::RequestParams; end + class PayByBank < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Bank account holder type. @@ -819,16 +762,16 @@ def initialize(expand: nil) # Attaches a PaymentMethod object to a Customer. # - # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) - # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). + # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents) + # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for # future use, which makes later declines and payment friction more likely. - # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up + # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up # future payments. # # To use this PaymentMethod as the default for invoice or subscription payments, - # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), + # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), # on the Customer to the PaymentMethod's ID. def attach(payment_method, params = {}, opts = {}) request( @@ -840,9 +783,9 @@ def attach(payment_method, params = {}, opts = {}) ) end - # Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. + # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. # - # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. + # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. def create(params = {}, opts = {}) request( method: :post, @@ -864,7 +807,7 @@ def detach(payment_method, params = {}, opts = {}) ) end - # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead. + # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. def list(params = {}, opts = {}) request( method: :get, @@ -875,7 +818,7 @@ def list(params = {}, opts = {}) ) end - # Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer) + # Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer) def retrieve(payment_method, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/payout_service.rb b/lib/stripe/services/payout_service.rb index 323bbcb3d..f775ba53d 100644 --- a/lib/stripe/services/payout_service.rb +++ b/lib/stripe/services/payout_service.rb @@ -173,11 +173,11 @@ def cancel(payout, params = {}, opts = {}) ) end - # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. + # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. # # If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode. # - # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type. + # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type. def create(params = {}, opts = {}) request(method: :post, path: "/v1/payouts", params: params, opts: opts, base_address: :api) end diff --git a/lib/stripe/services/plan_service.rb b/lib/stripe/services/plan_service.rb index 98b638ee0..af43832fa 100644 --- a/lib/stripe/services/plan_service.rb +++ b/lib/stripe/services/plan_service.rb @@ -3,8 +3,7 @@ module Stripe class PlanService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -252,7 +251,7 @@ def initialize( end end - # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + # You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. def create(params = {}, opts = {}) request(method: :post, path: "/v1/plans", params: params, opts: opts, base_address: :api) end diff --git a/lib/stripe/services/price_service.rb b/lib/stripe/services/price_service.rb index 4d45cfd57..daa7f73c2 100644 --- a/lib/stripe/services/price_service.rb +++ b/lib/stripe/services/price_service.rb @@ -501,7 +501,7 @@ def create(params = {}, opts = {}) request(method: :post, path: "/v1/prices", params: params, opts: opts, base_address: :api) end - # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. + # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. def list(params = {}, opts = {}) request(method: :get, path: "/v1/prices", params: params, opts: opts, base_address: :api) end @@ -517,7 +517,7 @@ def retrieve(price, params = {}, opts = {}) ) end - # Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/lib/stripe/services/product_feature_service.rb b/lib/stripe/services/product_feature_service.rb index b12e91f53..ded0330ce 100644 --- a/lib/stripe/services/product_feature_service.rb +++ b/lib/stripe/services/product_feature_service.rb @@ -3,8 +3,7 @@ module Stripe class ProductFeatureService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/product_service.rb b/lib/stripe/services/product_service.rb index 026886e13..ca9e16913 100644 --- a/lib/stripe/services/product_service.rb +++ b/lib/stripe/services/product_service.rb @@ -10,8 +10,7 @@ def initialize(requestor) @features = Stripe::ProductFeatureService.new(@requestor) end - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -467,7 +466,7 @@ def retrieve(id, params = {}, opts = {}) ) end - # Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/lib/stripe/services/promotion_code_service.rb b/lib/stripe/services/promotion_code_service.rb index 65d18a340..ae5720621 100644 --- a/lib/stripe/services/promotion_code_service.rb +++ b/lib/stripe/services/promotion_code_service.rb @@ -203,7 +203,7 @@ def list(params = {}, opts = {}) ) end - # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code. + # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code. def retrieve(promotion_code, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/radar/early_fraud_warning_service.rb b/lib/stripe/services/radar/early_fraud_warning_service.rb index 3d9570040..4ab5927da 100644 --- a/lib/stripe/services/radar/early_fraud_warning_service.rb +++ b/lib/stripe/services/radar/early_fraud_warning_service.rb @@ -78,7 +78,7 @@ def list(params = {}, opts = {}) # Retrieves the details of an early fraud warning that has previously been created. # - # Please refer to the [early fraud warning](https://stripe.com/docs/api#early_fraud_warning_object) object reference for more details. + # Please refer to the [early fraud warning](https://docs.stripe.com/api#early_fraud_warning_object) object reference for more details. def retrieve(early_fraud_warning, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/radar/value_list_item_service.rb b/lib/stripe/services/radar/value_list_item_service.rb index cfd9a7eb5..bb048f437 100644 --- a/lib/stripe/services/radar/value_list_item_service.rb +++ b/lib/stripe/services/radar/value_list_item_service.rb @@ -4,8 +4,7 @@ module Stripe module Radar class ValueListItemService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/radar/value_list_service.rb b/lib/stripe/services/radar/value_list_service.rb index 5bb114d6f..e4d5a63d7 100644 --- a/lib/stripe/services/radar/value_list_service.rb +++ b/lib/stripe/services/radar/value_list_service.rb @@ -4,8 +4,7 @@ module Stripe module Radar class ValueListService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/setup_intent_service.rb b/lib/stripe/services/setup_intent_service.rb index 5f3939bb1..4d7ef3a32 100644 --- a/lib/stripe/services/setup_intent_service.rb +++ b/lib/stripe/services/setup_intent_service.rb @@ -78,8 +78,7 @@ def initialize(allow_redirects: nil, enabled: nil) class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -132,20 +131,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -171,11 +161,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -228,8 +215,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -240,11 +226,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -267,11 +250,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -282,11 +262,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -311,20 +288,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -366,8 +334,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -378,23 +345,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -405,14 +361,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -432,11 +383,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -465,11 +413,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -728,8 +673,7 @@ def initialize(currency: nil, mandate_options: nil, verification_method: nil) end end - class AmazonPay < Stripe::RequestParams - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams @@ -895,8 +839,7 @@ def initialize( end end - class CardPresent < Stripe::RequestParams - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. @@ -1177,20 +1120,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -1216,11 +1150,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -1273,8 +1204,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -1285,11 +1215,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -1312,11 +1239,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -1327,11 +1251,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -1356,20 +1277,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -1411,8 +1323,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -1423,23 +1334,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -1450,14 +1350,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -1477,11 +1372,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -1510,11 +1402,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -1773,8 +1662,7 @@ def initialize(currency: nil, mandate_options: nil, verification_method: nil) end end - class AmazonPay < Stripe::RequestParams - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams @@ -1940,8 +1828,7 @@ def initialize( end end - class CardPresent < Stripe::RequestParams - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. @@ -2156,8 +2043,7 @@ def initialize(cancellation_reason: nil, expand: nil) class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. @@ -2210,20 +2096,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -2249,11 +2126,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -2306,8 +2180,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -2318,11 +2191,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -2345,11 +2215,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -2360,11 +2227,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -2389,20 +2253,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -2444,8 +2299,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -2456,23 +2310,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -2483,14 +2326,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -2510,11 +2348,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -2543,11 +2378,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. @@ -2806,8 +2638,7 @@ def initialize(currency: nil, mandate_options: nil, verification_method: nil) end end - class AmazonPay < Stripe::RequestParams - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams @@ -2973,8 +2804,7 @@ def initialize( end end - class CardPresent < Stripe::RequestParams - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. @@ -3177,7 +3007,7 @@ def initialize(amounts: nil, descriptor_code: nil, expand: nil) # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. # - # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. def cancel(intent, params = {}, opts = {}) request( method: :post, @@ -3214,7 +3044,7 @@ def confirm(intent, params = {}, opts = {}) # Creates a SetupIntent object. # - # After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm) + # After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm) # it to collect any required permissions to charge the payment method later. def create(params = {}, opts = {}) request( @@ -3241,7 +3071,7 @@ def list(params = {}, opts = {}) # # Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string. # - # When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://stripe.com/docs/api#setup_intent_object) object reference for more details. + # When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://docs.stripe.com/api#setup_intent_object) object reference for more details. def retrieve(intent, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/source_service.rb b/lib/stripe/services/source_service.rb index 5516671c9..f8908c50c 100644 --- a/lib/stripe/services/source_service.rb +++ b/lib/stripe/services/source_service.rb @@ -640,7 +640,7 @@ def retrieve(source, params = {}, opts = {}) # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged. # - # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail. + # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail. def update(source, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/subscription_item_service.rb b/lib/stripe/services/subscription_item_service.rb index 0c8e959ae..4bb90a010 100644 --- a/lib/stripe/services/subscription_item_service.rb +++ b/lib/stripe/services/subscription_item_service.rb @@ -28,6 +28,15 @@ def initialize(expand: nil) end class UpdateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -84,6 +93,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Specifies which fields in the response should be expanded. @@ -116,6 +127,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, @@ -129,6 +141,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @expand = expand @metadata = metadata @@ -172,6 +185,15 @@ def initialize( end class CreateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -228,6 +250,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Specifies which fields in the response should be expanded. @@ -260,6 +284,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, @@ -273,6 +298,7 @@ def initialize( subscription: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @expand = expand @metadata = metadata diff --git a/lib/stripe/services/subscription_schedule_service.rb b/lib/stripe/services/subscription_schedule_service.rb index fdfb0dcf9..1e58c0951 100644 --- a/lib/stripe/services/subscription_schedule_service.rb +++ b/lib/stripe/services/subscription_schedule_service.rb @@ -146,6 +146,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -189,6 +201,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. @@ -206,6 +220,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -216,6 +231,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @default_payment_method = default_payment_method @description = description @@ -311,6 +327,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -353,6 +381,15 @@ def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -409,6 +446,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. @@ -425,6 +464,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -433,6 +473,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -462,6 +503,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -486,7 +529,7 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :metadata # The account on behalf of which to charge, for each of the associated subscription's invoices. attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. attr_accessor :proration_behavior # The data with which to automatically create a Transfer for each of the associated subscription's invoices. attr_accessor :transfer_data @@ -500,6 +543,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -521,6 +565,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @currency = currency @default_payment_method = default_payment_method @@ -611,6 +656,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -654,6 +711,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings. @@ -671,6 +730,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -681,6 +741,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @default_payment_method = default_payment_method @description = description @@ -776,6 +837,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -818,6 +891,15 @@ def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -874,6 +956,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`. @@ -890,6 +974,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -898,6 +983,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -927,6 +1013,8 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :automatic_tax # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. attr_accessor :collection_method # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). @@ -951,7 +1039,7 @@ def initialize(amount_percent: nil, destination: nil) attr_accessor :metadata # The account on behalf of which to charge, for each of the associated subscription's invoices. attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. attr_accessor :start_date @@ -967,6 +1055,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -989,6 +1078,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @collection_method = collection_method @currency = currency @default_payment_method = default_payment_method @@ -1018,7 +1108,7 @@ def initialize( attr_accessor :metadata # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. attr_accessor :phases - # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. + # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`. attr_accessor :proration_behavior def initialize( diff --git a/lib/stripe/services/subscription_service.rb b/lib/stripe/services/subscription_service.rb index f8e6ca69f..bd8ab78c1 100644 --- a/lib/stripe/services/subscription_service.rb +++ b/lib/stripe/services/subscription_service.rb @@ -127,6 +127,18 @@ def initialize(enabled: nil, liability: nil) end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class CancellationDetails < Stripe::RequestParams # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. attr_accessor :comment @@ -178,6 +190,15 @@ def initialize(account_tax_ids: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -234,6 +255,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. attr_accessor :clear_usage # A flag that, if set to `true`, will delete the specified item. @@ -256,6 +279,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -267,6 +291,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @clear_usage = clear_usage @deleted = deleted @discounts = discounts @@ -383,11 +408,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -521,9 +543,11 @@ def initialize(end_behavior: nil) attr_accessor :automatic_tax # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled attr_accessor :cancellation_details @@ -569,11 +593,11 @@ def initialize(end_behavior: nil) attr_accessor :pending_invoice_item_interval # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + # If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. attr_accessor :proration_date # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. attr_accessor :transfer_data - # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. attr_accessor :trial_end # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. attr_accessor :trial_from_plan @@ -585,6 +609,7 @@ def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, cancellation_details: nil, @@ -616,6 +641,7 @@ def initialize( @application_fee_percent = application_fee_percent @automatic_tax = automatic_tax @billing_cycle_anchor = billing_cycle_anchor + @billing_thresholds = billing_thresholds @cancel_at = cancel_at @cancel_at_period_end = cancel_at_period_end @cancellation_details = cancellation_details @@ -645,8 +671,7 @@ def initialize( end end - class DeleteDiscountParams < Stripe::RequestParams - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class AutomaticTax < Stripe::RequestParams @@ -880,6 +905,18 @@ def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: ni end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + attr_accessor :reset_billing_cycle_anchor + + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil) + @amount_gte = amount_gte + @reset_billing_cycle_anchor = reset_billing_cycle_anchor + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -919,6 +956,15 @@ def initialize(account_tax_ids: nil, issuer: nil) end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + attr_accessor :usage_gte + + def initialize(usage_gte: nil) + @usage_gte = usage_gte + end + end + class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. attr_accessor :coupon @@ -975,6 +1021,8 @@ def initialize( @unit_amount_decimal = unit_amount_decimal end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. attr_accessor :discounts # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. @@ -991,6 +1039,7 @@ def initialize( attr_accessor :tax_rates def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -999,6 +1048,7 @@ def initialize( quantity: nil, tax_rates: nil ) + @billing_thresholds = billing_thresholds @discounts = discounts @metadata = metadata @plan = plan @@ -1100,11 +1150,8 @@ def initialize(bank_transfer: nil, funding_type: nil) end end - class Konbini < Stripe::RequestParams - end - - class SepaDebit < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams @@ -1242,9 +1289,11 @@ def initialize(end_behavior: nil) attr_accessor :billing_cycle_anchor # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC. attr_accessor :billing_cycle_anchor_config + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. attr_accessor :collection_method @@ -1312,6 +1361,7 @@ def initialize( backdate_start_date: nil, billing_cycle_anchor: nil, billing_cycle_anchor_config: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, collection_method: nil, @@ -1345,6 +1395,7 @@ def initialize( @backdate_start_date = backdate_start_date @billing_cycle_anchor = billing_cycle_anchor @billing_cycle_anchor_config = billing_cycle_anchor_config + @billing_thresholds = billing_thresholds @cancel_at = cancel_at @cancel_at_period_end = cancel_at_period_end @collection_method = collection_method @@ -1397,9 +1448,9 @@ class ResumeParams < Stripe::RequestParams attr_accessor :billing_cycle_anchor # Specifies which fields in the response should be expanded. attr_accessor :expand - # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. attr_accessor :proration_date def initialize( @@ -1415,9 +1466,9 @@ def initialize( end end - # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata). + # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata). # - # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. + # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. # # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. def cancel(subscription_exposed_id, params = {}, opts = {}) @@ -1435,7 +1486,7 @@ def cancel(subscription_exposed_id, params = {}, opts = {}) # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. # The payment_behavior parameter determines the exact behavior of the initial payment. # - # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. + # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. # Schedules provide the flexibility to model more complex billing configurations that change over time. def create(params = {}, opts = {}) request( @@ -1491,7 +1542,7 @@ def retrieve(subscription_exposed_id, params = {}, opts = {}) ) end - # Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. @@ -1507,7 +1558,7 @@ def search(params = {}, opts = {}) # Updates an existing subscription to match the specified parameters. # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. - # To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. + # To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint. # # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. # @@ -1519,13 +1570,13 @@ def search(params = {}, opts = {}) # A trial starts or ends. # # - # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). + # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). # - # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create). + # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create). # # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription. # - # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://stripe.com/docs/rate-limits) instead. + # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead. def update(subscription_exposed_id, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/tax/calculation_service.rb b/lib/stripe/services/tax/calculation_service.rb index e5657f99f..238f04c13 100644 --- a/lib/stripe/services/tax/calculation_service.rb +++ b/lib/stripe/services/tax/calculation_service.rb @@ -94,6 +94,8 @@ class LineItem < Stripe::RequestParams # A positive integer representing the line item's total price in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). # If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. attr_accessor :amount + # 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. + attr_accessor :metadata # If provided, the product's `tax_code` will be used as the line item's `tax_code`. attr_accessor :product # The number of units of the item being purchased. Used to calculate the per-unit price from the total `amount` for the line. For example, if `amount=100` and `quantity=4`, the calculated unit price is 25. @@ -107,6 +109,7 @@ class LineItem < Stripe::RequestParams def initialize( amount: nil, + metadata: nil, product: nil, quantity: nil, reference: nil, @@ -114,6 +117,7 @@ def initialize( tax_code: nil ) @amount = amount + @metadata = metadata @product = product @quantity = quantity @reference = reference diff --git a/lib/stripe/services/tax/registration_service.rb b/lib/stripe/services/tax/registration_service.rb index c67ea5136..d2eed5850 100644 --- a/lib/stripe/services/tax/registration_service.rb +++ b/lib/stripe/services/tax/registration_service.rb @@ -1162,7 +1162,7 @@ def initialize(type: nil) class Us < Stripe::RequestParams class LocalAmusementTax < Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). attr_accessor :jurisdiction def initialize(jurisdiction: nil) diff --git a/lib/stripe/services/tax_id_service.rb b/lib/stripe/services/tax_id_service.rb index 209bb7ec4..332d8a10a 100644 --- a/lib/stripe/services/tax_id_service.rb +++ b/lib/stripe/services/tax_id_service.rb @@ -3,8 +3,7 @@ module Stripe class TaxIdService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/terminal/configuration_service.rb b/lib/stripe/services/terminal/configuration_service.rb index 52fbe5fc1..2d7b74912 100644 --- a/lib/stripe/services/terminal/configuration_service.rb +++ b/lib/stripe/services/terminal/configuration_service.rb @@ -4,8 +4,7 @@ module Stripe module Terminal class ConfigurationService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/terminal/location_service.rb b/lib/stripe/services/terminal/location_service.rb index 3ae0693f3..a14d3bb4a 100644 --- a/lib/stripe/services/terminal/location_service.rb +++ b/lib/stripe/services/terminal/location_service.rb @@ -4,8 +4,7 @@ module Stripe module Terminal class LocationService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -149,7 +148,7 @@ def initialize( end # Creates a new Location object. - # For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide. + # For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide. def create(params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/terminal/reader_service.rb b/lib/stripe/services/terminal/reader_service.rb index 11817e1cf..cc3548229 100644 --- a/lib/stripe/services/terminal/reader_service.rb +++ b/lib/stripe/services/terminal/reader_service.rb @@ -4,8 +4,7 @@ module Stripe module Terminal class ReaderService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. @@ -106,6 +105,96 @@ def initialize(expand: nil) end end + class CollectInputsParams < Stripe::RequestParams + class Input < Stripe::RequestParams + class CustomText < Stripe::RequestParams + # The description which will be displayed when collecting this input + attr_accessor :description + # The skip button text + attr_accessor :skip_button + # The submit button text + attr_accessor :submit_button + # The title which will be displayed when collecting this input + attr_accessor :title + + def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil) + @description = description + @skip_button = skip_button + @submit_button = submit_button + @title = title + end + end + + class Selection < Stripe::RequestParams + class Choice < Stripe::RequestParams + # The unique identifier for this choice + attr_accessor :id + # The style of the button which will be shown for this choice + attr_accessor :style + # The text which will be shown on the button for this choice + attr_accessor :text + + def initialize(id: nil, style: nil, text: nil) + @id = id + @style = style + @text = text + end + end + # List of choices for the `selection` input + attr_accessor :choices + + def initialize(choices: nil) + @choices = choices + end + end + + class Toggle < Stripe::RequestParams + # The default value of the toggle + attr_accessor :default_value + # The description which will be displayed for the toggle + attr_accessor :description + # The title which will be displayed for the toggle + attr_accessor :title + + def initialize(default_value: nil, description: nil, title: nil) + @default_value = default_value + @description = description + @title = title + end + end + # Customize the text which will be displayed while collecting this input + attr_accessor :custom_text + # Indicate that this input is required, disabling the skip button + attr_accessor :required + # Options for the `selection` input + attr_accessor :selection + # List of toggles to be displayed and customization for the toggles + attr_accessor :toggles + # The type of input to collect + attr_accessor :type + + def initialize(custom_text: nil, required: nil, selection: nil, toggles: nil, type: nil) + @custom_text = custom_text + @required = required + @selection = selection + @toggles = toggles + @type = type + end + end + # Specifies which fields in the response should be expanded. + attr_accessor :expand + # List of inputs to be collected using the Reader + attr_accessor :inputs + # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + attr_accessor :metadata + + def initialize(expand: nil, inputs: nil, metadata: nil) + @expand = expand + @inputs = inputs + @metadata = metadata + end + end + class ProcessPaymentIntentParams < Stripe::RequestParams class ProcessConfig < Stripe::RequestParams class Tipping < Stripe::RequestParams @@ -120,6 +209,8 @@ def initialize(amount_eligible: nil) attr_accessor :allow_redisplay # Enables cancel button on transaction screens. attr_accessor :enable_customer_cancellation + # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. + attr_accessor :return_url # Override showing a tipping selection screen on this transaction. attr_accessor :skip_tipping # Tipping configuration for this transaction. @@ -128,11 +219,13 @@ def initialize(amount_eligible: nil) def initialize( allow_redisplay: nil, enable_customer_cancellation: nil, + return_url: nil, skip_tipping: nil, tipping: nil ) @allow_redisplay = allow_redisplay @enable_customer_cancellation = enable_customer_cancellation + @return_url = return_url @skip_tipping = skip_tipping @tipping = tipping end @@ -281,6 +374,17 @@ def cancel_action(reader, params = {}, opts = {}) ) end + # Initiates an input collection flow on a Reader. + def collect_inputs(reader, params = {}, opts = {}) + request( + method: :post, + path: format("/v1/terminal/readers/%s/collect_inputs", { reader: CGI.escape(reader) }), + params: params, + opts: opts, + base_address: :api + ) + end + # Creates a new Reader object. def create(params = {}, opts = {}) request( diff --git a/lib/stripe/services/test_helpers/confirmation_token_service.rb b/lib/stripe/services/test_helpers/confirmation_token_service.rb index eeb54a968..6f74cab39 100644 --- a/lib/stripe/services/test_helpers/confirmation_token_service.rb +++ b/lib/stripe/services/test_helpers/confirmation_token_service.rb @@ -21,20 +21,11 @@ def initialize(account_number: nil, institution_number: nil, transit_number: nil end end - class Affirm < Stripe::RequestParams - end - - class AfterpayClearpay < Stripe::RequestParams - end - - class Alipay < Stripe::RequestParams - end - - class Alma < Stripe::RequestParams - end - - class AmazonPay < Stripe::RequestParams - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. @@ -60,11 +51,8 @@ def initialize(account_number: nil, sort_code: nil) end end - class Bancontact < Stripe::RequestParams - end - - class Billie < Stripe::RequestParams - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams @@ -117,8 +105,7 @@ def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil) end end - class Blik < Stripe::RequestParams - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) @@ -129,11 +116,8 @@ def initialize(tax_id: nil) end end - class Cashapp < Stripe::RequestParams - end - - class CustomerBalance < Stripe::RequestParams - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. @@ -156,11 +140,8 @@ def initialize(account_holder_type: nil, bank: nil) end end - class Giropay < Stripe::RequestParams - end - - class Grabpay < Stripe::RequestParams - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. @@ -171,11 +152,8 @@ def initialize(bank: nil) end end - class InteracPresent < Stripe::RequestParams - end - - class KakaoPay < Stripe::RequestParams - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams @@ -200,20 +178,11 @@ def initialize(dob: nil) end end - class Konbini < Stripe::RequestParams - end - - class KrCard < Stripe::RequestParams - end - - class Link < Stripe::RequestParams - end - - class Mobilepay < Stripe::RequestParams - end - - class Multibanco < Stripe::RequestParams - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. @@ -255,8 +224,7 @@ def initialize( end end - class Oxxo < Stripe::RequestParams - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. @@ -267,23 +235,12 @@ def initialize(bank: nil) end end - class PayByBank < Stripe::RequestParams - end - - class Payco < Stripe::RequestParams - end - - class Paynow < Stripe::RequestParams - end - - class Paypal < Stripe::RequestParams - end - - class Pix < Stripe::RequestParams - end - - class Promptpay < Stripe::RequestParams - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. @@ -294,14 +251,9 @@ def initialize(session: nil) end end - class RevolutPay < Stripe::RequestParams - end - - class SamsungPay < Stripe::RequestParams - end - - class Satispay < Stripe::RequestParams - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. @@ -321,11 +273,8 @@ def initialize(country: nil) end end - class Swish < Stripe::RequestParams - end - - class Twint < Stripe::RequestParams - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. @@ -354,11 +303,8 @@ def initialize( end end - class WechatPay < Stripe::RequestParams - end - - class Zip < Stripe::RequestParams - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. attr_accessor :acss_debit # If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method. diff --git a/lib/stripe/services/test_helpers/terminal/reader_service.rb b/lib/stripe/services/test_helpers/terminal/reader_service.rb index d4237a41a..8329f2248 100644 --- a/lib/stripe/services/test_helpers/terminal/reader_service.rb +++ b/lib/stripe/services/test_helpers/terminal/reader_service.rb @@ -49,6 +49,27 @@ def initialize( end end + class SucceedInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + attr_accessor :expand + # This parameter defines the skip behavior for input collection. + attr_accessor :skip_non_required_inputs + + def initialize(expand: nil, skip_non_required_inputs: nil) + @expand = expand + @skip_non_required_inputs = skip_non_required_inputs + end + end + + class TimeoutInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + attr_accessor :expand + + def initialize(expand: nil) + @expand = expand + end + end + # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction. def present_payment_method(reader, params = {}, opts = {}) request( @@ -59,6 +80,28 @@ def present_payment_method(reader, params = {}, opts = {}) base_address: :api ) end + + # Use this endpoint to trigger a successful input collection on a simulated reader. + def succeed_input_collection(reader, params = {}, opts = {}) + request( + method: :post, + path: format("/v1/test_helpers/terminal/readers/%s/succeed_input_collection", { reader: CGI.escape(reader) }), + params: params, + opts: opts, + base_address: :api + ) + end + + # Use this endpoint to complete an input collection with a timeout error on a simulated reader. + def timeout_input_collection(reader, params = {}, opts = {}) + request( + method: :post, + path: format("/v1/test_helpers/terminal/readers/%s/timeout_input_collection", { reader: CGI.escape(reader) }), + params: params, + opts: opts, + base_address: :api + ) + end end end end diff --git a/lib/stripe/services/test_helpers/test_clock_service.rb b/lib/stripe/services/test_helpers/test_clock_service.rb index e2c2b3b8b..b3610b8ab 100644 --- a/lib/stripe/services/test_helpers/test_clock_service.rb +++ b/lib/stripe/services/test_helpers/test_clock_service.rb @@ -4,8 +4,7 @@ module Stripe module TestHelpers class TestClockService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/lib/stripe/services/token_service.rb b/lib/stripe/services/token_service.rb index 682159862..94c5ed603 100644 --- a/lib/stripe/services/token_service.rb +++ b/lib/stripe/services/token_service.rb @@ -1205,7 +1205,7 @@ def initialize( end # Creates a single-use token that represents a bank account's details. - # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. + # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. def create(params = {}, opts = {}) request(method: :post, path: "/v1/tokens", params: params, opts: opts, base_address: :api) end diff --git a/lib/stripe/services/transfer_service.rb b/lib/stripe/services/transfer_service.rb index c0f49b5ea..d35295821 100644 --- a/lib/stripe/services/transfer_service.rb +++ b/lib/stripe/services/transfer_service.rb @@ -129,7 +129,7 @@ def initialize(description: nil, expand: nil, metadata: nil) end end - # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. + # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. def create(params = {}, opts = {}) request(method: :post, path: "/v1/transfers", params: params, opts: opts, base_address: :api) end diff --git a/lib/stripe/services/v2/billing/meter_event_session_service.rb b/lib/stripe/services/v2/billing/meter_event_session_service.rb index adf6a500f..69e828a5a 100644 --- a/lib/stripe/services/v2/billing/meter_event_session_service.rb +++ b/lib/stripe/services/v2/billing/meter_event_session_service.rb @@ -5,8 +5,7 @@ module Stripe module V2 module Billing class MeterEventSessionService < StripeService - class CreateParams < Stripe::RequestParams - end + class CreateParams < Stripe::RequestParams; end # Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires. def create(params = {}, opts = {}) diff --git a/lib/stripe/services/v2/core/event_destination_service.rb b/lib/stripe/services/v2/core/event_destination_service.rb index 1c9e76112..bd86351da 100644 --- a/lib/stripe/services/v2/core/event_destination_service.rb +++ b/lib/stripe/services/v2/core/event_destination_service.rb @@ -76,14 +76,9 @@ def initialize( end end - class DeleteParams < Stripe::RequestParams - end - - class DisableParams < Stripe::RequestParams - end - - class EnableParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end + class DisableParams < Stripe::RequestParams; end + class EnableParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams # Additional fields to include in the response. Currently supports `webhook_endpoint.url`. @@ -97,8 +92,7 @@ def initialize(include: nil, limit: nil) end end - class PingParams < Stripe::RequestParams - end + class PingParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Additional fields to include in the response. diff --git a/lib/stripe/services/v2/core/event_service.rb b/lib/stripe/services/v2/core/event_service.rb index c59da45a8..7a2f5adbe 100644 --- a/lib/stripe/services/v2/core/event_service.rb +++ b/lib/stripe/services/v2/core/event_service.rb @@ -19,8 +19,7 @@ def initialize(limit: nil, object_id_: nil) end end - class RetrieveParams < Stripe::RequestParams - end + class RetrieveParams < Stripe::RequestParams; end # List events, going back up to 30 days. def list(params = {}, opts = {}) diff --git a/lib/stripe/services/webhook_endpoint_service.rb b/lib/stripe/services/webhook_endpoint_service.rb index d24e632c3..ed0176b2e 100644 --- a/lib/stripe/services/webhook_endpoint_service.rb +++ b/lib/stripe/services/webhook_endpoint_service.rb @@ -3,8 +3,7 @@ module Stripe class WebhookEndpointService < StripeService - class DeleteParams < Stripe::RequestParams - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. diff --git a/rbi/stripe/resources/account.rbi b/rbi/stripe/resources/account.rbi index 5ab7dfd78..4becbc79a 100644 --- a/rbi/stripe/resources/account.rbi +++ b/rbi/stripe/resources/account.rbi @@ -7,14 +7,14 @@ module Stripe # properties on the account like its current requirements or if the account is # enabled to make live charges or receive payouts. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is `application`, which includes Custom accounts, the properties below are always # returned. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is `stripe`, which includes Standard and Express accounts, some properties are only returned - # until you create an [Account Link](https://stripe.com/api/account_links) or [Account Session](https://stripe.com/api/account_sessions) - # to start Connect Onboarding. Learn about the [differences between accounts](https://stripe.com/connect/accounts). + # until you create an [Account Link](https://docs.stripe.com/api/account_links) or [Account Session](https://docs.stripe.com/api/account_sessions) + # to start Connect Onboarding. Learn about the [differences between accounts](https://docs.stripe.com/connect/accounts). class Account < APIResource class BusinessProfile < Stripe::StripeObject class AnnualRevenue < Stripe::StripeObject @@ -217,6 +217,9 @@ module Stripe # The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. sig { returns(String) } attr_reader :paynow_payments + # The status of the pix payments capability of the account, or whether the account can directly process pix charges. + sig { returns(String) } + attr_reader :pix_payments # The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. sig { returns(String) } attr_reader :promptpay_payments @@ -840,9 +843,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class BankAccount < Stripe::RequestParams # Attribute for param field object @@ -1278,6 +1279,13 @@ module Stripe sig { params(requested: T.nilable(T::Boolean)).void } def initialize(requested: nil); end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :requested + sig { params(requested: T.nilable(T::Boolean)).void } + def initialize(requested: nil); end + end class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. sig { returns(T.nilable(T::Boolean)) } @@ -1535,6 +1543,9 @@ module Stripe # The paynow_payments capability. sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments)) } attr_accessor :paynow_payments + # The pix_payments capability. + sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PixPayments)) } + attr_accessor :pix_payments # The promptpay_payments capability. sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments)) } attr_accessor :promptpay_payments @@ -1598,7 +1609,7 @@ module Stripe sig { returns(T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments)) } attr_accessor :zip_payments sig { - params(acss_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments), promptpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments)).void + params(acss_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PaynowPayments), pix_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::Account::UpdateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::Account::UpdateParams::Capabilities::ZipPayments)).void } def initialize( acss_debit_payments: nil, @@ -1642,6 +1653,7 @@ module Stripe pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -3226,6 +3238,13 @@ module Stripe sig { params(requested: T.nilable(T::Boolean)).void } def initialize(requested: nil); end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :requested + sig { params(requested: T.nilable(T::Boolean)).void } + def initialize(requested: nil); end + end class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. sig { returns(T.nilable(T::Boolean)) } @@ -3483,6 +3502,9 @@ module Stripe # The paynow_payments capability. sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments)) } attr_accessor :paynow_payments + # The pix_payments capability. + sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PixPayments)) } + attr_accessor :pix_payments # The promptpay_payments capability. sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments)) } attr_accessor :promptpay_payments @@ -3546,7 +3568,7 @@ module Stripe sig { returns(T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments)) } attr_accessor :zip_payments sig { - params(acss_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments), promptpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::Account::CreateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::Account::CreateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments)).void + params(acss_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PaynowPayments), pix_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::Account::CreateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::Account::CreateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::Account::CreateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::Account::CreateParams::Capabilities::ZipPayments)).void } def initialize( acss_debit_payments: nil, @@ -3590,6 +3612,7 @@ module Stripe pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -4813,10 +4836,10 @@ module Stripe sig { params(expand: T.nilable(T::Array[String]), reason: String).void } def initialize(expand: nil, reason: nil); end end - # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users. + # With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users. # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings). # - # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when + # If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding. # You can prefill any information on the account. sig { @@ -4824,11 +4847,11 @@ module Stripe } def self.create(params = {}, opts = {}); end - # With [Connect](https://stripe.com/connect), you can delete accounts you manage. + # With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage. # # Test-mode accounts can be deleted at any time. # - # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero. + # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero. # # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. sig { @@ -4836,11 +4859,11 @@ module Stripe } def self.delete(account, params = {}, opts = {}); end - # With [Connect](https://stripe.com/connect), you can delete accounts you manage. + # With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage. # # Test-mode accounts can be deleted at any time. # - # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero. + # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero. # # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. sig { @@ -4848,7 +4871,7 @@ module Stripe } def delete(params = {}, opts = {}); end - # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty. + # Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty. sig { params(params: T.any(::Stripe::Account::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } @@ -4866,7 +4889,7 @@ module Stripe } def self.persons(account, params = {}, opts = {}); end - # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. + # With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious. # # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. sig { @@ -4874,7 +4897,7 @@ module Stripe } def reject(params = {}, opts = {}); end - # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. + # With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious. # # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. sig { @@ -4882,19 +4905,19 @@ module Stripe } def self.reject(account, params = {}, opts = {}); end - # Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are + # Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are # left unchanged. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is application, which includes Custom accounts, you can update any information on the account. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is stripe, which includes Standard and Express accounts, you can update all information until you create - # an [Account Link or Account Session](https://stripe.com/api/account_links) to start Connect onboarding, + # an [Account Link or Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding, # after which some properties can no longer be updated. # # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our - # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. + # [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. sig { params(account: String, params: T.any(::Stripe::Account::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account) } diff --git a/rbi/stripe/resources/account_session.rbi b/rbi/stripe/resources/account_session.rbi index bd5f00859..43048b6a7 100644 --- a/rbi/stripe/resources/account_session.rbi +++ b/rbi/stripe/resources/account_session.rbi @@ -69,6 +69,28 @@ module Stripe sig { returns(Features) } attr_reader :features end + class DisputesList < Stripe::StripeObject + class Features < Stripe::StripeObject + # Whether to allow capturing and cancelling payment intents. This is `true` by default. + sig { returns(T::Boolean) } + attr_reader :capture_payments + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + sig { returns(T::Boolean) } + attr_reader :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + sig { returns(T::Boolean) } + attr_reader :dispute_management + # Whether to allow sending refunds. This is `true` by default. + sig { returns(T::Boolean) } + attr_reader :refund_management + end + # Whether the embedded component is enabled. + sig { returns(T::Boolean) } + attr_reader :enabled + # Attribute for field features + sig { returns(Features) } + attr_reader :features + end class Documents < Stripe::StripeObject class Features < Stripe::StripeObject; end # Whether the embedded component is enabled. @@ -198,6 +220,25 @@ module Stripe sig { returns(Features) } attr_reader :features end + class PaymentDisputes < Stripe::StripeObject + class Features < Stripe::StripeObject + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + sig { returns(T::Boolean) } + attr_reader :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + sig { returns(T::Boolean) } + attr_reader :dispute_management + # Whether to allow sending refunds. This is `true` by default. + sig { returns(T::Boolean) } + attr_reader :refund_management + end + # Whether the embedded component is enabled. + sig { returns(T::Boolean) } + attr_reader :enabled + # Attribute for field features + sig { returns(Features) } + attr_reader :features + end class Payments < Stripe::StripeObject class Features < Stripe::StripeObject # Whether to allow capturing and cancelling payment intents. This is `true` by default. @@ -281,6 +322,9 @@ module Stripe # Attribute for field balances sig { returns(Balances) } attr_reader :balances + # Attribute for field disputes_list + sig { returns(DisputesList) } + attr_reader :disputes_list # Attribute for field documents sig { returns(Documents) } attr_reader :documents @@ -302,6 +346,9 @@ module Stripe # Attribute for field payment_details sig { returns(PaymentDetails) } attr_reader :payment_details + # Attribute for field payment_disputes + sig { returns(PaymentDisputes) } + attr_reader :payment_disputes # Attribute for field payments sig { returns(Payments) } attr_reader :payments @@ -441,14 +488,49 @@ module Stripe } def initialize(enabled: nil, features: nil); end end - class Documents < Stripe::RequestParams + class DisputesList < Stripe::RequestParams class Features < Stripe::RequestParams - + # Whether to allow capturing and cancelling payment intents. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :capture_payments + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :refund_management + sig { + params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void + } + def initialize( + capture_payments: nil, + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ); end end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled # The list of features enabled in the embedded component. + sig { + returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList::Features)) + } + attr_accessor :features + sig { + params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList::Features)).void + } + def initialize(enabled: nil, features: nil); end + end + class Documents < Stripe::RequestParams + class Features < Stripe::RequestParams; end + # Whether the embedded component is enabled. + sig { returns(T::Boolean) } + attr_accessor :enabled + # The list of features enabled in the embedded component. sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents::Features)) } @@ -660,6 +742,39 @@ module Stripe } def initialize(enabled: nil, features: nil); end end + class PaymentDisputes < Stripe::RequestParams + class Features < Stripe::RequestParams + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :refund_management + sig { + params(destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void + } + def initialize( + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ); end + end + # Whether the embedded component is enabled. + sig { returns(T::Boolean) } + attr_accessor :enabled + # The list of features enabled in the embedded component. + sig { + returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes::Features)) + } + attr_accessor :features + sig { + params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes::Features)).void + } + def initialize(enabled: nil, features: nil); end + end class Payments < Stripe::RequestParams class Features < Stripe::RequestParams # Whether to allow capturing and cancelling payment intents. This is `true` by default. @@ -739,9 +854,7 @@ module Stripe def initialize(enabled: nil, features: nil); end end class PayoutsList < Stripe::RequestParams - class Features < Stripe::RequestParams - - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled @@ -756,9 +869,7 @@ module Stripe def initialize(enabled: nil, features: nil); end end class TaxRegistrations < Stripe::RequestParams - class Features < Stripe::RequestParams - - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled @@ -773,9 +884,7 @@ module Stripe def initialize(enabled: nil, features: nil); end end class TaxSettings < Stripe::RequestParams - class Features < Stripe::RequestParams - - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled @@ -802,6 +911,9 @@ module Stripe # Configuration for the balances embedded component. sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances)) } attr_accessor :balances + # Configuration for the disputes list embedded component. + sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList)) } + attr_accessor :disputes_list # Configuration for the documents embedded component. sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents)) } attr_accessor :documents @@ -833,6 +945,11 @@ module Stripe returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails)) } attr_accessor :payment_details + # Configuration for the payment disputes embedded component. + sig { + returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes)) + } + attr_accessor :payment_disputes # Configuration for the payments embedded component. sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments)) } attr_accessor :payments @@ -851,12 +968,13 @@ module Stripe sig { returns(T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings)) } attr_accessor :tax_settings sig { - params(account_management: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement), account_onboarding: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding), balances: T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances), documents: T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents), financial_account: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount), financial_account_transactions: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions), issuing_card: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard), issuing_cards_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList), notification_banner: T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner), payment_details: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails), payments: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments), payouts: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts), payouts_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList), tax_registrations: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations), tax_settings: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings)).void + params(account_management: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountManagement), account_onboarding: T.nilable(::Stripe::AccountSession::CreateParams::Components::AccountOnboarding), balances: T.nilable(::Stripe::AccountSession::CreateParams::Components::Balances), disputes_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::DisputesList), documents: T.nilable(::Stripe::AccountSession::CreateParams::Components::Documents), financial_account: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccount), financial_account_transactions: T.nilable(::Stripe::AccountSession::CreateParams::Components::FinancialAccountTransactions), issuing_card: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCard), issuing_cards_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::IssuingCardsList), notification_banner: T.nilable(::Stripe::AccountSession::CreateParams::Components::NotificationBanner), payment_details: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDetails), payment_disputes: T.nilable(::Stripe::AccountSession::CreateParams::Components::PaymentDisputes), payments: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payments), payouts: T.nilable(::Stripe::AccountSession::CreateParams::Components::Payouts), payouts_list: T.nilable(::Stripe::AccountSession::CreateParams::Components::PayoutsList), tax_registrations: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxRegistrations), tax_settings: T.nilable(::Stripe::AccountSession::CreateParams::Components::TaxSettings)).void } def initialize( account_management: nil, account_onboarding: nil, balances: nil, + disputes_list: nil, documents: nil, financial_account: nil, financial_account_transactions: nil, @@ -864,6 +982,7 @@ module Stripe issuing_cards_list: nil, notification_banner: nil, payment_details: nil, + payment_disputes: nil, payments: nil, payouts: nil, payouts_list: nil, diff --git a/rbi/stripe/resources/apple_pay_domain.rbi b/rbi/stripe/resources/apple_pay_domain.rbi index 4302bfee2..ffd501839 100644 --- a/rbi/stripe/resources/apple_pay_domain.rbi +++ b/rbi/stripe/resources/apple_pay_domain.rbi @@ -23,9 +23,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams # Attribute for param field domain_name sig { returns(T.nilable(String)) } diff --git a/rbi/stripe/resources/balance.rbi b/rbi/stripe/resources/balance.rbi index 8adeebfae..029f695f3 100644 --- a/rbi/stripe/resources/balance.rbi +++ b/rbi/stripe/resources/balance.rbi @@ -155,6 +155,58 @@ module Stripe sig { returns(SourceTypes) } attr_reader :source_types end + class RefundAndDisputePrefunding < Stripe::StripeObject + class Available < Stripe::StripeObject + class SourceTypes < Stripe::StripeObject + # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated). + sig { returns(Integer) } + attr_reader :bank_account + # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits). + sig { returns(Integer) } + attr_reader :card + # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method. + sig { returns(Integer) } + attr_reader :fpx + end + # Balance amount. + sig { returns(Integer) } + attr_reader :amount + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + sig { returns(String) } + attr_reader :currency + # Attribute for field source_types + sig { returns(SourceTypes) } + attr_reader :source_types + end + class Pending < Stripe::StripeObject + class SourceTypes < Stripe::StripeObject + # Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated). + sig { returns(Integer) } + attr_reader :bank_account + # Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits). + sig { returns(Integer) } + attr_reader :card + # Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method. + sig { returns(Integer) } + attr_reader :fpx + end + # Balance amount. + sig { returns(Integer) } + attr_reader :amount + # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). + sig { returns(String) } + attr_reader :currency + # Attribute for field source_types + sig { returns(SourceTypes) } + attr_reader :source_types + end + # Funds that are available for use. + sig { returns(T::Array[Available]) } + attr_reader :available + # Funds that are pending + sig { returns(T::Array[Pending]) } + attr_reader :pending + end # Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. sig { returns(T::Array[Available]) } attr_reader :available @@ -176,5 +228,8 @@ module Stripe # Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. sig { returns(T::Array[Pending]) } attr_reader :pending + # Attribute for field refund_and_dispute_prefunding + sig { returns(RefundAndDisputePrefunding) } + attr_reader :refund_and_dispute_prefunding end end \ No newline at end of file diff --git a/rbi/stripe/resources/balance_transaction.rbi b/rbi/stripe/resources/balance_transaction.rbi index 8f9de6351..dcba5a231 100644 --- a/rbi/stripe/resources/balance_transaction.rbi +++ b/rbi/stripe/resources/balance_transaction.rbi @@ -31,6 +31,9 @@ module Stripe # The date that the transaction's net funds become available in the Stripe balance. sig { returns(Integer) } attr_reader :available_on + # The balance that this transaction impacts. + sig { returns(String) } + attr_reader :balance_type # Time at which the object was created. Measured in seconds since the Unix epoch. sig { returns(Integer) } attr_reader :created diff --git a/rbi/stripe/resources/bank_account.rbi b/rbi/stripe/resources/bank_account.rbi index 0ebd435cf..97178f006 100644 --- a/rbi/stripe/resources/bank_account.rbi +++ b/rbi/stripe/resources/bank_account.rbi @@ -5,11 +5,11 @@ module Stripe # These bank accounts are payment methods on `Customer` objects. # - # On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer + # On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer # destinations on `Account` objects for connected accounts. # They can be bank accounts or debit cards as well, and are documented in the links above. # - # Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers) + # Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers) class BankAccount < APIResource class FutureRequirements < Stripe::StripeObject class Error < Stripe::StripeObject diff --git a/rbi/stripe/resources/billing/alert.rbi b/rbi/stripe/resources/billing/alert.rbi index 31dc2bbc1..657870f76 100644 --- a/rbi/stripe/resources/billing/alert.rbi +++ b/rbi/stripe/resources/billing/alert.rbi @@ -101,13 +101,13 @@ module Stripe sig { returns(Integer) } attr_accessor :gte # The [Billing Meter](/api/billing/meter) ID whose usage is monitored. - sig { returns(T.nilable(String)) } + sig { returns(String) } attr_accessor :meter # Whether the alert should only fire only once, or once per billing cycle. sig { returns(String) } attr_accessor :recurrence sig { - params(filters: T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: T.nilable(String), recurrence: String).void + params(filters: T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: String, recurrence: String).void } def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil); end end diff --git a/rbi/stripe/resources/billing_portal/session.rbi b/rbi/stripe/resources/billing_portal/session.rbi index f343b9f6c..f4df6aa9e 100644 --- a/rbi/stripe/resources/billing_portal/session.rbi +++ b/rbi/stripe/resources/billing_portal/session.rbi @@ -17,7 +17,7 @@ module Stripe # Create sessions on-demand when customers intend to manage their subscriptions # and billing details. # - # Related guide: [Customer management](https://stripe.com/customer-management) + # Related guide: [Customer management](https://docs.stripe.com/customer-management) class Session < APIResource class Flow < Stripe::StripeObject class AfterCompletion < Stripe::StripeObject diff --git a/rbi/stripe/resources/capability.rbi b/rbi/stripe/resources/capability.rbi index 470885712..126356a59 100644 --- a/rbi/stripe/resources/capability.rbi +++ b/rbi/stripe/resources/capability.rbi @@ -75,7 +75,7 @@ module Stripe # Fields that are due and can be satisfied by providing the corresponding alternative fields instead. sig { returns(T.nilable(T::Array[Alternative])) } attr_reader :alternatives - # Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. + # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested. sig { returns(T.nilable(Integer)) } attr_reader :current_deadline # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. diff --git a/rbi/stripe/resources/charge.rbi b/rbi/stripe/resources/charge.rbi index 76701b68c..b1d8e1acd 100644 --- a/rbi/stripe/resources/charge.rbi +++ b/rbi/stripe/resources/charge.rbi @@ -192,6 +192,12 @@ module Stripe attr_reader :transit_number end class Affirm < Stripe::StripeObject + # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(String) } + attr_reader :location + # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + sig { returns(String) } + attr_reader :reader # The Affirm transaction ID associated with this payment. sig { returns(T.nilable(String)) } attr_reader :transaction_id @@ -1236,6 +1242,12 @@ module Stripe # Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. sig { returns(T.nilable(String)) } attr_reader :fingerprint + # ID of the [location](https://stripe.com/docs/api/terminal/locations) that this transaction's reader is assigned to. + sig { returns(String) } + attr_reader :location + # ID of the [reader](https://stripe.com/docs/api/terminal/readers) this transaction was made on. + sig { returns(String) } + attr_reader :reader # Transaction ID of this particular WeChat Pay transaction. sig { returns(T.nilable(String)) } attr_reader :transaction_id @@ -2006,9 +2018,9 @@ module Stripe end # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false. # - # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. + # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. # - # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture). + # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture). sig { params(params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge) } @@ -2016,15 +2028,15 @@ module Stripe # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false. # - # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. + # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. # - # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture). + # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture). sig { params(charge: String, params: T.any(::Stripe::Charge::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge) } def self.capture(charge, params = {}, opts = {}); end - # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents) + # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents) # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge # object used to request payment. sig { diff --git a/rbi/stripe/resources/checkout/session.rbi b/rbi/stripe/resources/checkout/session.rbi index 518d282b8..c803f264f 100644 --- a/rbi/stripe/resources/checkout/session.rbi +++ b/rbi/stripe/resources/checkout/session.rbi @@ -779,6 +779,15 @@ module Stripe # Controls when the funds will be captured from the customer's account. sig { returns(String) } attr_reader :capture_method + # Indicates that you intend to make future payments with this PaymentIntent's payment method. + # + # 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. + # + # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead. + # + # 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). + sig { returns(String) } + attr_reader :setup_future_usage end class Oxxo < Stripe::StripeObject # The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. @@ -1377,7 +1386,7 @@ module Stripe # specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. sig { returns(T.nilable(String)) } attr_reader :submit_type - # The ID of the subscription for Checkout Sessions in `subscription` mode. + # The ID of the [Subscription](https://stripe.com/docs/api/subscriptions) for Checkout Sessions in `subscription` mode. sig { returns(T.nilable(T.any(String, Stripe::Subscription))) } attr_reader :subscription # The URL the customer will be directed to after the payment or @@ -2710,9 +2719,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds will be captured from the customer's account. sig { returns(T.nilable(String)) } @@ -3173,13 +3180,20 @@ module Stripe # 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. sig { returns(T.nilable(T::Array[String])) } attr_accessor :allow_redisplay_filters + # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. + sig { returns(T.nilable(String)) } + attr_accessor :payment_method_remove # Enable customers to choose if they wish to save their payment method for future use. Disabled by default. sig { returns(T.nilable(String)) } attr_accessor :payment_method_save sig { - params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_save: T.nilable(String)).void + params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String)).void } - def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end + def initialize( + allow_redisplay_filters: nil, + payment_method_remove: nil, + payment_method_save: nil + ); end end class SetupIntentData < Stripe::RequestParams # An arbitrary string attached to the object. Often useful for displaying to users. @@ -3979,6 +3993,8 @@ module Stripe def self.list_line_items(session, params = {}, opts = {}); end # Updates a Checkout Session object. + # + # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates) sig { params(session: String, params: T.any(::Stripe::Checkout::Session::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session) } diff --git a/rbi/stripe/resources/confirmation_token.rbi b/rbi/stripe/resources/confirmation_token.rbi index d282ea18f..933750c35 100644 --- a/rbi/stripe/resources/confirmation_token.rbi +++ b/rbi/stripe/resources/confirmation_token.rbi @@ -1104,21 +1104,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -1139,12 +1129,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -1199,9 +1185,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -1209,12 +1193,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1232,12 +1212,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -1245,12 +1221,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -1275,21 +1247,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -1328,9 +1290,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1338,24 +1298,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -1363,15 +1311,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -1386,12 +1328,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -1419,12 +1357,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::ConfirmationToken::CreateParams::PaymentMethodData::AcssDebit)) diff --git a/rbi/stripe/resources/country_spec.rbi b/rbi/stripe/resources/country_spec.rbi index d710eb6d5..cc7c8825a 100644 --- a/rbi/stripe/resources/country_spec.rbi +++ b/rbi/stripe/resources/country_spec.rbi @@ -8,7 +8,7 @@ module Stripe # Country Specs API makes these rules available to your integration. # # You can also view the information from this API call as [an online - # guide](https://stripe.com/docs/connect/required-verification-information). + # guide](https://docs.stripe.com/docs/connect/required-verification-information). class CountrySpec < APIResource class VerificationFields < Stripe::StripeObject class Company < Stripe::StripeObject diff --git a/rbi/stripe/resources/coupon.rbi b/rbi/stripe/resources/coupon.rbi index a2bcab7b2..9b2528e93 100644 --- a/rbi/stripe/resources/coupon.rbi +++ b/rbi/stripe/resources/coupon.rbi @@ -71,9 +71,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class CurrencyOptions < Stripe::RequestParams # A positive integer representing the amount to subtract from an invoice total. diff --git a/rbi/stripe/resources/credit_note.rbi b/rbi/stripe/resources/credit_note.rbi index 9797684b0..6ae2ccf79 100644 --- a/rbi/stripe/resources/credit_note.rbi +++ b/rbi/stripe/resources/credit_note.rbi @@ -152,6 +152,12 @@ module Stripe # The link to download the PDF of the credit note. sig { returns(String) } attr_reader :pdf + # The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof. + sig { returns(Integer) } + attr_reader :post_payment_amount + # The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced. + sig { returns(Integer) } + attr_reader :pre_payment_amount # The pretax credit amounts (ex: discount, credit grants, etc) for all line items. sig { returns(T::Array[PretaxCreditAmount]) } attr_reader :pretax_credit_amounts @@ -689,20 +695,19 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end - # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces - # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result - # in any combination of the following: + # 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. + # 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: # # - # Refund: create a new refund (using refund_amount) or link an existing refund (using refund). + # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds). # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized. # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount). # # - # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total. + # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount. # - # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount - # or post_payment_credit_notes_amount depending on its status at the time of credit note creation. + # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount, + # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation. sig { params(params: T.any(::Stripe::CreditNote::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote) } @@ -732,13 +737,13 @@ module Stripe } def self.update(id, params = {}, opts = {}); end - # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). sig { params(params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote) } def void_credit_note(params = {}, opts = {}); end - # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). sig { params(id: String, params: T.any(::Stripe::CreditNote::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote) } diff --git a/rbi/stripe/resources/customer.rbi b/rbi/stripe/resources/customer.rbi index 62404d99a..12ebfff3e 100644 --- a/rbi/stripe/resources/customer.rbi +++ b/rbi/stripe/resources/customer.rbi @@ -210,9 +210,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -459,9 +457,7 @@ module Stripe validate: nil ); end end - class DeleteDiscountParams < Stripe::RequestParams - - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Created < Stripe::RequestParams # Minimum value to filter by (exclusive) diff --git a/rbi/stripe/resources/customer_session.rbi b/rbi/stripe/resources/customer_session.rbi index 5f70c68de..bc3c7d2dc 100644 --- a/rbi/stripe/resources/customer_session.rbi +++ b/rbi/stripe/resources/customer_session.rbi @@ -6,9 +6,9 @@ module Stripe # A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access # control over a Customer. # - # Related guides: [Customer Session with the Payment Element](https://stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), - # [Customer Session with the Pricing Table](https://stripe.com/payments/checkout/pricing-table#customer-session), - # [Customer Session with the Buy Button](https://stripe.com/payment-links/buy-button#pass-an-existing-customer). + # Related guides: [Customer Session with the Payment Element](https://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods), + # [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session), + # [Customer Session with the Buy Button](https://docs.stripe.com/payment-links/buy-button#pass-an-existing-customer). class CustomerSession < APIResource class Components < Stripe::StripeObject class BuyButton < Stripe::StripeObject diff --git a/rbi/stripe/resources/dispute.rbi b/rbi/stripe/resources/dispute.rbi index 1535e5bfd..5218bf78c 100644 --- a/rbi/stripe/resources/dispute.rbi +++ b/rbi/stripe/resources/dispute.rbi @@ -340,7 +340,7 @@ module Stripe # Attribute for field payment_method_details sig { returns(PaymentMethodDetails) } attr_reader :payment_method_details - # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). + # Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). sig { returns(String) } attr_reader :reason # Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. @@ -752,7 +752,7 @@ module Stripe # 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. # - # 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). + # 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). sig { params(dispute: String, params: T.any(::Stripe::Dispute::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute) } diff --git a/rbi/stripe/resources/event.rbi b/rbi/stripe/resources/event.rbi index c107a10e2..d0baeeb63 100644 --- a/rbi/stripe/resources/event.rbi +++ b/rbi/stripe/resources/event.rbi @@ -56,7 +56,7 @@ module Stripe # The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. sig { returns(T.nilable(String)) } attr_reader :api_version - # Attribute for field context + # Authentication context needed to fetch the event or related object. sig { returns(String) } attr_reader :context # Time at which the object was created. Measured in seconds since the Unix epoch. diff --git a/rbi/stripe/resources/file.rbi b/rbi/stripe/resources/file.rbi index 5c84685f1..3ba13dd8a 100644 --- a/rbi/stripe/resources/file.rbi +++ b/rbi/stripe/resources/file.rbi @@ -7,7 +7,7 @@ module Stripe # files with the [create file](https://stripe.com/docs/api#create_file) request # (for example, when uploading dispute evidence). Stripe also # creates files independently (for example, the results of a [Sigma scheduled - # query](https://stripe.com/docs/api#scheduled_queries)). + # query](https://docs.stripe.com/api#scheduled_queries)). # # Related guide: [File upload guide](https://stripe.com/docs/file-upload) class File < APIResource diff --git a/rbi/stripe/resources/identity/verification_report.rbi b/rbi/stripe/resources/identity/verification_report.rbi index cc8800838..72df26697 100644 --- a/rbi/stripe/resources/identity/verification_report.rbi +++ b/rbi/stripe/resources/identity/verification_report.rbi @@ -108,12 +108,21 @@ module Stripe # Document ID number. sig { returns(T.nilable(String)) } attr_reader :number + # Sex of the person in the document. + sig { returns(T.nilable(String)) } + attr_reader :sex # Status of this `document` check. sig { returns(String) } attr_reader :status # Type of the document. sig { returns(T.nilable(String)) } attr_reader :type + # Place of birth as it appears in the document. + sig { returns(T.nilable(String)) } + attr_reader :unparsed_place_of_birth + # Sex as it appears in the document. + sig { returns(T.nilable(String)) } + attr_reader :unparsed_sex end class Email < Stripe::StripeObject class Error < Stripe::StripeObject diff --git a/rbi/stripe/resources/identity/verification_session.rbi b/rbi/stripe/resources/identity/verification_session.rbi index 7ab1f73a8..07ebce09c 100644 --- a/rbi/stripe/resources/identity/verification_session.rbi +++ b/rbi/stripe/resources/identity/verification_session.rbi @@ -6,11 +6,11 @@ module Stripe module Identity # A VerificationSession guides you through the process of collecting and verifying the identities # of your users. It contains details about the type of verification, such as what [verification - # check](https://stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for + # check](https://docs.stripe.com/docs/identity/verification-checks) to perform. Only create one VerificationSession for # each verification in your system. # # A VerificationSession transitions through [multiple - # statuses](https://stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through + # statuses](https://docs.stripe.com/docs/identity/how-sessions-work) throughout its lifetime as it progresses through # the verification flow. The VerificationSession contains the user's verified data after # verification checks are complete. # @@ -132,6 +132,15 @@ module Stripe # The user's verified phone number sig { returns(T.nilable(String)) } attr_reader :phone + # The user's verified sex. + sig { returns(T.nilable(String)) } + attr_reader :sex + # The user's verified place of birth as it appears in the document. + sig { returns(T.nilable(String)) } + attr_reader :unparsed_place_of_birth + # The user's verified sex as it appears in the document. + sig { returns(T.nilable(String)) } + attr_reader :unparsed_sex end # 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. sig { returns(T.nilable(String)) } @@ -422,17 +431,17 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end - # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work). + # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work). # - # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel). + # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel). sig { params(params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } def cancel(params = {}, opts = {}); end - # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work). + # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work). # - # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel). + # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel). sig { params(session: String, params: T.any(::Stripe::Identity::VerificationSession::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } @@ -444,7 +453,7 @@ module Stripe # # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode. # - # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents) + # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents) sig { params(params: T.any(::Stripe::Identity::VerificationSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } @@ -461,7 +470,7 @@ module Stripe # request logs, etc. # # A VerificationSession object can be redacted when it is in requires_input or verified - # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action + # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action # state will automatically cancel it. # # The redaction process may take up to four days. When the redaction process is in progress, the @@ -474,7 +483,7 @@ module Stripe # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or # used for any purpose. # - # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact). + # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact). sig { params(params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } @@ -485,7 +494,7 @@ module Stripe # request logs, etc. # # A VerificationSession object can be redacted when it is in requires_input or verified - # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action + # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action # state will automatically cancel it. # # The redaction process may take up to four days. When the redaction process is in progress, the @@ -498,7 +507,7 @@ module Stripe # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or # used for any purpose. # - # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact). + # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact). sig { params(session: String, params: T.any(::Stripe::Identity::VerificationSession::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } diff --git a/rbi/stripe/resources/invoice.rbi b/rbi/stripe/resources/invoice.rbi index d2a3e553a..238d38803 100644 --- a/rbi/stripe/resources/invoice.rbi +++ b/rbi/stripe/resources/invoice.rbi @@ -27,7 +27,7 @@ module Stripe # Stripe applies any customer credit on the account before determining the # amount due for the invoice (i.e., the amount that will be actually # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge - # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the + # per currency](https://docs.stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the # invoice is automatically marked paid, and we add the amount due to the # customer's credit balance which is applied to the next invoice. # @@ -675,7 +675,7 @@ module Stripe # The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. sig { returns(T.nilable(String)) } attr_reader :hosted_invoice_url - # Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. + # Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`. sig { returns(String) } attr_reader :id # The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. @@ -789,9 +789,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class AutomaticTax < Stripe::RequestParams class Liability < Stripe::RequestParams @@ -962,12 +960,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -1658,12 +1652,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -2357,6 +2347,16 @@ module Stripe } def initialize(expand: nil, invoice_metadata: nil, lines: nil); end end + class AttachPaymentParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + # The ID of the PaymentIntent to attach to the invoice. + sig { returns(T.nilable(String)) } + attr_accessor :payment_intent + sig { params(expand: T.nilable(T::Array[String]), payment_intent: T.nilable(String)).void } + def initialize(expand: nil, payment_intent: nil); end + end class FinalizeInvoiceParams < Stripe::RequestParams # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. sig { returns(T.nilable(T::Boolean)) } @@ -3079,6 +3079,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -3122,6 +3134,13 @@ module Stripe def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -3180,6 +3199,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])))) @@ -3206,9 +3230,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -3244,6 +3269,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -3286,7 +3316,7 @@ module Stripe # The account on behalf of which to charge, for each of the associated subscription's invoices. sig { returns(T.nilable(String)) } attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. @@ -3304,13 +3334,14 @@ module Stripe sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :trial_end sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -3348,6 +3379,13 @@ module Stripe end class SubscriptionDetails < Stripe::RequestParams class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -3406,6 +3444,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. sig { returns(T.nilable(T::Boolean)) } attr_accessor :clear_usage @@ -3441,9 +3484,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds))), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Invoice::CreatePreviewParams::SubscriptionDetails::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -3462,7 +3506,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. @@ -3584,7 +3628,37 @@ module Stripe } def self.add_lines(invoice, params = {}, opts = {}); end - # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. + # + # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited + # to the invoice, increasing its amount_paid. When the invoice is fully paid, the + # invoice's status becomes paid. + # + # If the PaymentIntent's status is already succeeded when it's attached, it's + # credited to the invoice immediately. + # + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. + sig { + params(params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) + } + def attach_payment(params = {}, opts = {}); end + + # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. + # + # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited + # to the invoice, increasing its amount_paid. When the invoice is fully paid, the + # invoice's status becomes paid. + # + # If the PaymentIntent's status is already succeeded when it's attached, it's + # credited to the invoice immediately. + # + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. + sig { + params(invoice: String, params: T.any(::Stripe::Invoice::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) + } + def self.attach_payment(invoice, params = {}, opts = {}); end + + # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers. sig { params(params: T.any(::Stripe::Invoice::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } @@ -3592,9 +3666,11 @@ module Stripe # At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. # - # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. + # You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. # - # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request. + # The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true. + # + # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. # # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions) sig { @@ -3602,13 +3678,13 @@ module Stripe } def self.create_preview(params = {}, opts = {}); end - # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice). + # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice). sig { params(invoice: String, params: T.any(::Stripe::Invoice::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } def self.delete(invoice, params = {}, opts = {}); end - # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice). + # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice). sig { params(params: T.any(::Stripe::Invoice::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } @@ -3694,11 +3770,11 @@ module Stripe } def self.send_invoice(invoice, params = {}, opts = {}); end - # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized), + # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized), # monetary values, as well as collection_method, become uneditable. # # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, - # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass + # sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass # auto_advance=false. sig { params(invoice: String, params: T.any(::Stripe::Invoice::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) @@ -3717,17 +3793,17 @@ module Stripe } def self.update_lines(invoice, params = {}, opts = {}); end - # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. + # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. # - # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. + # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. sig { params(params: T.any(::Stripe::Invoice::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } def void_invoice(params = {}, opts = {}); end - # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. + # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. # - # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. + # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. sig { params(invoice: String, params: T.any(::Stripe::Invoice::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } diff --git a/rbi/stripe/resources/invoice_item.rbi b/rbi/stripe/resources/invoice_item.rbi index 6411b12a1..0972c2d80 100644 --- a/rbi/stripe/resources/invoice_item.rbi +++ b/rbi/stripe/resources/invoice_item.rbi @@ -94,7 +94,7 @@ module Stripe # String representing the object's type. Objects of the same type share the same value. sig { returns(String) } attr_reader :object - # The parent that generated this invoice + # The parent that generated this invoice item. sig { returns(T.nilable(Parent)) } attr_reader :parent # Attribute for field period @@ -118,9 +118,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. diff --git a/rbi/stripe/resources/invoice_line_item.rbi b/rbi/stripe/resources/invoice_line_item.rbi index cdc89ffc6..1cdf99d2d 100644 --- a/rbi/stripe/resources/invoice_line_item.rbi +++ b/rbi/stripe/resources/invoice_line_item.rbi @@ -182,7 +182,7 @@ module Stripe # String representing the object's type. Objects of the same type share the same value. sig { returns(String) } attr_reader :object - # The parent that generated this invoice + # The parent that generated this line item. sig { returns(T.nilable(Parent)) } attr_reader :parent # Attribute for field period diff --git a/rbi/stripe/resources/invoice_payment.rbi b/rbi/stripe/resources/invoice_payment.rbi index ade2cc03d..43695e11f 100644 --- a/rbi/stripe/resources/invoice_payment.rbi +++ b/rbi/stripe/resources/invoice_payment.rbi @@ -3,10 +3,17 @@ # typed: true module Stripe - # The invoice payment object + # Invoice Payments represent payments made against invoices. Invoice Payments can + # be accessed in two ways: + # 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource. + # 2. By using the Invoice Payment retrieve and list endpoints. + # + # Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. + # This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and + # monitor the allocation details of the payments. class InvoicePayment < APIResource class Payment < Stripe::StripeObject - # ID of the successful charge for this payment when `type` is `charge`. + # ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead. sig { returns(T.any(String, Stripe::Charge)) } attr_reader :charge # ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019. diff --git a/rbi/stripe/resources/issuing/authorization.rbi b/rbi/stripe/resources/issuing/authorization.rbi index 801b5cd00..70ec30877 100644 --- a/rbi/stripe/resources/issuing/authorization.rbi +++ b/rbi/stripe/resources/issuing/authorization.rbi @@ -1239,29 +1239,29 @@ module Stripe sig { params(expand: T.nilable(T::Array[String]), reverse_amount: T.nilable(Integer)).void } def initialize(expand: nil, reverse_amount: nil); end end - # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). sig { params(params: T.any(::Stripe::Issuing::Authorization::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization) } def approve(params = {}, opts = {}); end - # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). sig { params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization) } def self.approve(authorization, params = {}, opts = {}); end - # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). sig { params(params: T.any(::Stripe::Issuing::Authorization::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization) } def decline(params = {}, opts = {}); end - # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). sig { params(authorization: String, params: T.any(::Stripe::Issuing::Authorization::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization) } diff --git a/rbi/stripe/resources/issuing/card.rbi b/rbi/stripe/resources/issuing/card.rbi index 327ad5a16..d45e13ae4 100644 --- a/rbi/stripe/resources/issuing/card.rbi +++ b/rbi/stripe/resources/issuing/card.rbi @@ -455,7 +455,7 @@ module Stripe # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } attr_accessor :expand - # Attribute for param field financial_account + # The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account. sig { returns(T.nilable(String)) } attr_accessor :financial_account # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. diff --git a/rbi/stripe/resources/issuing/dispute.rbi b/rbi/stripe/resources/issuing/dispute.rbi index 7a5adf796..dbe0f5db9 100644 --- a/rbi/stripe/resources/issuing/dispute.rbi +++ b/rbi/stripe/resources/issuing/dispute.rbi @@ -879,7 +879,7 @@ module Stripe } def initialize(expand: nil, metadata: nil); end end - # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. + # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. sig { params(params: T.any(::Stripe::Issuing::Dispute::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute) } @@ -891,13 +891,13 @@ module Stripe } def self.list(params = {}, opts = {}); end - # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). + # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). sig { params(params: T.any(::Stripe::Issuing::Dispute::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute) } def submit(params = {}, opts = {}); end - # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). + # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). sig { params(dispute: String, params: T.any(::Stripe::Issuing::Dispute::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute) } diff --git a/rbi/stripe/resources/payment_intent.rbi b/rbi/stripe/resources/payment_intent.rbi index 696bbaf2d..6255741d7 100644 --- a/rbi/stripe/resources/payment_intent.rbi +++ b/rbi/stripe/resources/payment_intent.rbi @@ -848,7 +848,7 @@ module Stripe # Attribute for field swish_handle_redirect_or_display_qr_code sig { returns(SwishHandleRedirectOrDisplayQrCode) } attr_reader :swish_handle_redirect_or_display_qr_code - # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. + # Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. sig { returns(String) } attr_reader :type # When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. @@ -1025,7 +1025,11 @@ module Stripe sig { returns(String) } attr_reader :setup_future_usage end - class Billie < Stripe::StripeObject; end + class Billie < Stripe::StripeObject + # Controls when the funds will be captured from the customer's account. + sig { returns(String) } + attr_reader :capture_method + end class Blik < Stripe::StripeObject # Indicates that you intend to make future payments with this PaymentIntent's payment method. # @@ -1532,6 +1536,11 @@ module Stripe sig { returns(String) } attr_reader :capture_method end + class Satispay < Stripe::StripeObject + # Controls when the funds will be captured from the customer's account. + sig { returns(String) } + attr_reader :capture_method + end class SepaDebit < Stripe::StripeObject class MandateOptions < Stripe::StripeObject # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -1794,6 +1803,9 @@ module Stripe # Attribute for field samsung_pay sig { returns(SamsungPay) } attr_reader :samsung_pay + # Attribute for field satispay + sig { returns(Satispay) } + attr_reader :satispay # Attribute for field sepa_debit sig { returns(SepaDebit) } attr_reader :sepa_debit @@ -2094,9 +2106,7 @@ module Stripe end class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(String) } @@ -2152,21 +2162,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -2187,12 +2187,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -2247,9 +2243,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -2257,12 +2251,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2280,12 +2270,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -2293,12 +2279,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -2323,21 +2305,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -2376,9 +2348,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2386,24 +2356,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -2411,15 +2369,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -2434,12 +2386,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -2467,12 +2415,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentIntent::CreateParams::PaymentMethodData::AcssDebit)) @@ -3455,9 +3399,7 @@ module Stripe sig { params(setup_future_usage: T.nilable(T.nilable(T.any(String, String)))).void } def initialize(setup_future_usage: nil); end end - class InteracPresent < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -3712,9 +3654,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -3847,6 +3787,17 @@ module Stripe sig { params(capture_method: T.nilable(T.nilable(String))).void } def initialize(capture_method: nil); end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + sig { returns(T.nilable(T.nilable(String))) } + attr_accessor :capture_method + sig { params(capture_method: T.nilable(T.nilable(String))).void } + def initialize(capture_method: nil); end + end class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -4267,6 +4218,11 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay)))) } attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Satispay)))) + } + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. sig { returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit)))) @@ -4303,7 +4259,7 @@ module Stripe } attr_accessor :zip sig { - params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Zip)))).void + params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SamsungPay))), satispay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Satispay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::Zip)))).void } def initialize( acss_debit: nil, @@ -4347,6 +4303,7 @@ module Stripe promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -4496,6 +4453,8 @@ module Stripe # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. # # If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. + # If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent. + # end sig { returns(T.nilable(String)) } attr_accessor :payment_method # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. @@ -4606,21 +4565,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -4641,12 +4590,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -4701,9 +4646,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -4711,12 +4654,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -4734,12 +4673,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -4747,12 +4682,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -4777,21 +4708,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -4830,9 +4751,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -4840,24 +4759,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -4865,15 +4772,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -4888,12 +4789,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -4921,12 +4818,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentIntent::UpdateParams::PaymentMethodData::AcssDebit)) @@ -5909,9 +5802,7 @@ module Stripe sig { params(setup_future_usage: T.nilable(T.nilable(T.any(String, String)))).void } def initialize(setup_future_usage: nil); end end - class InteracPresent < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -6166,9 +6057,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -6301,6 +6190,17 @@ module Stripe sig { params(capture_method: T.nilable(T.nilable(String))).void } def initialize(capture_method: nil); end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + sig { returns(T.nilable(T.nilable(String))) } + attr_accessor :capture_method + sig { params(capture_method: T.nilable(T.nilable(String))).void } + def initialize(capture_method: nil); end + end class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -6721,6 +6621,11 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay)))) } attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Satispay)))) + } + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. sig { returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit)))) @@ -6757,7 +6662,7 @@ module Stripe } attr_accessor :zip sig { - params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Zip)))).void + params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SamsungPay))), satispay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Satispay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::Zip)))).void } def initialize( acss_debit: nil, @@ -6801,6 +6706,7 @@ module Stripe promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -7074,9 +6980,7 @@ module Stripe class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(T.nilable(String)) } @@ -7134,21 +7038,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -7169,12 +7063,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -7229,9 +7119,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -7239,12 +7127,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -7262,12 +7146,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -7275,12 +7155,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -7305,21 +7181,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -7358,9 +7224,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -7368,24 +7232,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -7393,15 +7245,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -7416,12 +7262,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -7449,12 +7291,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentIntent::ConfirmParams::PaymentMethodData::AcssDebit)) @@ -8455,9 +8293,7 @@ module Stripe sig { params(setup_future_usage: T.nilable(T.nilable(T.any(String, String)))).void } def initialize(setup_future_usage: nil); end end - class InteracPresent < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -8712,9 +8548,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -8847,6 +8681,17 @@ module Stripe sig { params(capture_method: T.nilable(T.nilable(String))).void } def initialize(capture_method: nil); end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + sig { returns(T.nilable(T.nilable(String))) } + attr_accessor :capture_method + sig { params(capture_method: T.nilable(T.nilable(String))).void } + def initialize(capture_method: nil); end + end class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -9267,6 +9112,11 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay)))) } attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Satispay)))) + } + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. sig { returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit)))) @@ -9303,7 +9153,7 @@ module Stripe } attr_accessor :zip sig { - params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Zip)))).void + params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SamsungPay))), satispay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Satispay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::Zip)))).void } def initialize( acss_debit: nil, @@ -9347,6 +9197,7 @@ module Stripe promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -9441,6 +9292,7 @@ module Stripe sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_accessor :off_session # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + # If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent. sig { returns(T.nilable(String)) } attr_accessor :payment_method # If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -9579,21 +9431,21 @@ module Stripe } def self.apply_customer_balance(intent, params = {}, opts = {}); end - # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://stripe.com/docs/payments/intents), processing. + # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing. # # After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. # - # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. sig { params(params: T.any(::Stripe::PaymentIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } def cancel(params = {}, opts = {}); end - # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://stripe.com/docs/payments/intents), processing. + # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing. # # After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. # - # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. sig { params(intent: String, params: T.any(::Stripe::PaymentIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -9603,7 +9455,7 @@ module Stripe # # Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. # - # Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later). + # Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later). sig { params(params: T.any(::Stripe::PaymentIntent::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -9613,7 +9465,7 @@ module Stripe # # Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. # - # Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later). + # Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later). sig { params(intent: String, params: T.any(::Stripe::PaymentIntent::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -9630,8 +9482,8 @@ module Stripe # payment succeeds, the PaymentIntent will transition to the succeeded # status (or requires_capture, if capture_method is set to manual). # If the confirmation_method is automatic, payment may be attempted - # using our [client SDKs](https://stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) - # and the PaymentIntent's [client_secret](https://stripe.com/docs/api#payment_intent_object-client_secret). + # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) + # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret). # After next_actions are handled by the client, no additional # confirmation is required to complete the payment. # If the confirmation_method is manual, all payment attempts must be @@ -9660,8 +9512,8 @@ module Stripe # payment succeeds, the PaymentIntent will transition to the succeeded # status (or requires_capture, if capture_method is set to manual). # If the confirmation_method is automatic, payment may be attempted - # using our [client SDKs](https://stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) - # and the PaymentIntent's [client_secret](https://stripe.com/docs/api#payment_intent_object-client_secret). + # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) + # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret). # After next_actions are handled by the client, no additional # confirmation is required to complete the payment. # If the confirmation_method is manual, all payment attempts must be @@ -9681,13 +9533,13 @@ module Stripe # Creates a PaymentIntent object. # - # After the PaymentIntent is created, attach a payment method and [confirm](https://stripe.com/docs/api/payment_intents/confirm) + # After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm) # to continue the payment. Learn more about the available payment flows # with the Payment Intents API. # # When you use confirm=true during creation, it's equivalent to creating # and confirming the PaymentIntent in the same call. You can use any parameters - # available in the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) when you supply + # available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply # confirm=true. sig { params(params: T.any(::Stripe::PaymentIntent::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) @@ -9695,9 +9547,9 @@ module Stripe def self.create(params = {}, opts = {}); end # Perform an incremental authorization on an eligible - # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the + # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the # PaymentIntent's status must be requires_capture and - # [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + # [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) # must be true. # # Incremental authorizations attempt to increase the authorized amount on @@ -9708,25 +9560,25 @@ module Stripe # # If the incremental authorization succeeds, the PaymentIntent object # returns with the updated - # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). + # [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). # If the incremental authorization fails, a - # [card_declined](https://stripe.com/docs/error-codes#card-declined) error returns, and no other + # [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other # fields on the PaymentIntent or Charge update. The PaymentIntent # object remains capturable for the previously authorized amount. # # Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. # After it's captured, a PaymentIntent can no longer be incremented. # - # Learn more about [incremental authorizations](https://stripe.com/docs/terminal/features/incremental-authorizations). + # Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations). sig { params(params: T.any(::Stripe::PaymentIntent::IncrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } def increment_authorization(params = {}, opts = {}); end # Perform an incremental authorization on an eligible - # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the + # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the # PaymentIntent's status must be requires_capture and - # [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + # [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) # must be true. # # Incremental authorizations attempt to increase the authorized amount on @@ -9737,16 +9589,16 @@ module Stripe # # If the incremental authorization succeeds, the PaymentIntent object # returns with the updated - # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). + # [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). # If the incremental authorization fails, a - # [card_declined](https://stripe.com/docs/error-codes#card-declined) error returns, and no other + # [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other # fields on the PaymentIntent or Charge update. The PaymentIntent # object remains capturable for the previously authorized amount. # # Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. # After it's captured, a PaymentIntent can no longer be incremented. # - # Learn more about [incremental authorizations](https://stripe.com/docs/terminal/features/incremental-authorizations). + # Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations). sig { params(intent: String, params: T.any(::Stripe::PaymentIntent::IncrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -9774,7 +9626,7 @@ module Stripe # PaymentIntent again. For example, updating the payment_method # always requires you to confirm the PaymentIntent again. If you prefer to # update and confirm at the same time, we recommend updating properties through - # the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) instead. + # the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead. sig { params(intent: String, params: T.any(::Stripe::PaymentIntent::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } diff --git a/rbi/stripe/resources/payment_method.rbi b/rbi/stripe/resources/payment_method.rbi index 0c4b0f027..728d995c8 100644 --- a/rbi/stripe/resources/payment_method.rbi +++ b/rbi/stripe/resources/payment_method.rbi @@ -1027,21 +1027,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -1062,12 +1052,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -1122,9 +1108,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -1170,12 +1154,8 @@ module Stripe token: nil ); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1193,12 +1173,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -1206,12 +1182,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -1232,21 +1204,11 @@ module Stripe sig { params(dob: T.nilable(::Stripe::PaymentMethod::CreateParams::Klarna::Dob)).void } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -1285,9 +1247,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1295,24 +1255,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -1320,15 +1268,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -1343,12 +1285,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -1376,12 +1314,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentMethod::CreateParams::AcssDebit)) } attr_accessor :acss_debit @@ -1689,12 +1623,8 @@ module Stripe } def initialize(exp_month: nil, exp_year: nil, networks: nil); end end - class Link < Stripe::RequestParams - - end - class PayByBank < Stripe::RequestParams - - end + class Link < Stripe::RequestParams; end + class PayByBank < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Bank account holder type. sig { returns(T.nilable(String)) } @@ -1762,16 +1692,16 @@ module Stripe end # Attaches a PaymentMethod object to a Customer. # - # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) - # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). + # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents) + # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for # future use, which makes later declines and payment friction more likely. - # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up + # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up # future payments. # # To use this PaymentMethod as the default for invoice or subscription payments, - # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), + # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), # on the Customer to the PaymentMethod's ID. sig { params(params: T.any(::Stripe::PaymentMethod::AttachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod) @@ -1780,25 +1710,25 @@ module Stripe # Attaches a PaymentMethod object to a Customer. # - # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) - # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). + # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents) + # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for # future use, which makes later declines and payment friction more likely. - # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up + # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up # future payments. # # To use this PaymentMethod as the default for invoice or subscription payments, - # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), + # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), # on the Customer to the PaymentMethod's ID. sig { params(payment_method: String, params: T.any(::Stripe::PaymentMethod::AttachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod) } def self.attach(payment_method, params = {}, opts = {}); end - # Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. + # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. # - # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. + # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. sig { params(params: T.any(::Stripe::PaymentMethod::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod) } @@ -1816,7 +1746,7 @@ module Stripe } def self.detach(payment_method, params = {}, opts = {}); end - # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead. + # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. sig { params(params: T.any(::Stripe::PaymentMethod::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } diff --git a/rbi/stripe/resources/payment_method_configuration.rbi b/rbi/stripe/resources/payment_method_configuration.rbi index 5652553ab..c6a3f72a3 100644 --- a/rbi/stripe/resources/payment_method_configuration.rbi +++ b/rbi/stripe/resources/payment_method_configuration.rbi @@ -474,6 +474,25 @@ module Stripe sig { returns(DisplayPreference) } attr_reader :display_preference end + class KakaoPay < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overridable + # The account's display preference. + sig { returns(String) } + attr_reader :preference + # The effective display preference value. + sig { returns(String) } + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + sig { returns(T::Boolean) } + attr_reader :available + # Attribute for field display_preference + sig { returns(DisplayPreference) } + attr_reader :display_preference + end class Klarna < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -512,6 +531,25 @@ module Stripe sig { returns(DisplayPreference) } attr_reader :display_preference end + class KrCard < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overridable + # The account's display preference. + sig { returns(String) } + attr_reader :preference + # The effective display preference value. + sig { returns(String) } + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + sig { returns(T::Boolean) } + attr_reader :available + # Attribute for field display_preference + sig { returns(DisplayPreference) } + attr_reader :display_preference + end class Link < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -569,6 +607,25 @@ module Stripe sig { returns(DisplayPreference) } attr_reader :display_preference end + class NaverPay < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overridable + # The account's display preference. + sig { returns(String) } + attr_reader :preference + # The effective display preference value. + sig { returns(String) } + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + sig { returns(T::Boolean) } + attr_reader :available + # Attribute for field display_preference + sig { returns(DisplayPreference) } + attr_reader :display_preference + end class NzBankAccount < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -645,6 +702,25 @@ module Stripe sig { returns(DisplayPreference) } attr_reader :display_preference end + class Payco < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overridable + # The account's display preference. + sig { returns(String) } + attr_reader :preference + # The effective display preference value. + sig { returns(String) } + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + sig { returns(T::Boolean) } + attr_reader :available + # Attribute for field display_preference + sig { returns(DisplayPreference) } + attr_reader :display_preference + end class Paynow < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -740,6 +816,25 @@ module Stripe sig { returns(DisplayPreference) } attr_reader :display_preference end + class SamsungPay < Stripe::StripeObject + class DisplayPreference < Stripe::StripeObject + # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :overridable + # The account's display preference. + sig { returns(String) } + attr_reader :preference + # The effective display preference value. + sig { returns(String) } + attr_reader :value + end + # Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active. + sig { returns(T::Boolean) } + attr_reader :available + # Attribute for field display_preference + sig { returns(DisplayPreference) } + attr_reader :display_preference + end class Satispay < Stripe::StripeObject class DisplayPreference < Stripe::StripeObject # For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used. @@ -976,12 +1071,18 @@ module Stripe # Attribute for field jcb sig { returns(Jcb) } attr_reader :jcb + # Attribute for field kakao_pay + sig { returns(KakaoPay) } + attr_reader :kakao_pay # Attribute for field klarna sig { returns(Klarna) } attr_reader :klarna # Attribute for field konbini sig { returns(Konbini) } attr_reader :konbini + # Attribute for field kr_card + sig { returns(KrCard) } + attr_reader :kr_card # Attribute for field link sig { returns(Link) } attr_reader :link @@ -997,6 +1098,9 @@ module Stripe # The configuration's name. sig { returns(String) } attr_reader :name + # Attribute for field naver_pay + sig { returns(NaverPay) } + attr_reader :naver_pay # Attribute for field nz_bank_account sig { returns(NzBankAccount) } attr_reader :nz_bank_account @@ -1015,6 +1119,9 @@ module Stripe # Attribute for field pay_by_bank sig { returns(PayByBank) } attr_reader :pay_by_bank + # Attribute for field payco + sig { returns(Payco) } + attr_reader :payco # Attribute for field paynow sig { returns(Paynow) } attr_reader :paynow @@ -1030,6 +1137,9 @@ module Stripe # Attribute for field revolut_pay sig { returns(RevolutPay) } attr_reader :revolut_pay + # Attribute for field samsung_pay + sig { returns(SamsungPay) } + attr_reader :samsung_pay # Attribute for field satispay sig { returns(Satispay) } attr_reader :satispay @@ -1532,6 +1642,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1568,6 +1696,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1622,6 +1768,24 @@ module Stripe } def initialize(display_preference: nil); end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1694,6 +1858,24 @@ module Stripe } def initialize(display_preference: nil); end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1784,6 +1966,24 @@ module Stripe } def initialize(display_preference: nil); end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1948,7 +2148,7 @@ module Stripe # Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay)) } attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay)) } attr_accessor :apple_pay # Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. @@ -2012,12 +2212,18 @@ module Stripe # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb)) } attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay)) } + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna)) } attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini)) } attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard)) } + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link)) } attr_accessor :link @@ -2030,6 +2236,9 @@ module Stripe # Configuration name. sig { returns(T.nilable(String)) } attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay)) } + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount)) } attr_accessor :nz_bank_account @@ -2045,6 +2254,9 @@ module Stripe # Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank)) } attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco)) } + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow)) } attr_accessor :paynow @@ -2060,6 +2272,9 @@ module Stripe # Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay)) } attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay)) } + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay)) } attr_accessor :satispay @@ -2085,7 +2300,7 @@ module Stripe sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip)) } attr_accessor :zip sig { - params(acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb), klarna: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini), link: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco), name: T.nilable(String), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24), parent: T.nilable(String), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank), paynow: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay), satispay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip)).void + params(acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::P24), parent: T.nilable(String), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfiguration::CreateParams::Zip)).void } def initialize( acss_debit: nil, @@ -2114,22 +2329,27 @@ module Stripe grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, parent: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, @@ -2591,6 +2811,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2627,6 +2865,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2681,6 +2937,24 @@ module Stripe } def initialize(display_preference: nil); end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2753,6 +3027,24 @@ module Stripe } def initialize(display_preference: nil); end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2843,6 +3135,24 @@ module Stripe } def initialize(display_preference: nil); end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -3010,7 +3320,7 @@ module Stripe # Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay)) } attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay)) } attr_accessor :apple_pay # Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks. @@ -3074,12 +3384,18 @@ module Stripe # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb)) } attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay)) } + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna)) } attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini)) } attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard)) } + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link)) } attr_accessor :link @@ -3092,6 +3408,9 @@ module Stripe # Configuration name. sig { returns(T.nilable(String)) } attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay)) } + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount)) } attr_accessor :nz_bank_account @@ -3104,6 +3423,9 @@ module Stripe # Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank)) } attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco)) } + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow)) } attr_accessor :paynow @@ -3119,6 +3441,9 @@ module Stripe # Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay)) } attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay)) } + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay)) } attr_accessor :satispay @@ -3144,7 +3469,7 @@ module Stripe sig { returns(T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip)) } attr_accessor :zip sig { - params(acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit), active: T.nilable(T::Boolean), affirm: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb), klarna: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini), link: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco), name: T.nilable(String), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank), paynow: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay), satispay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip)).void + params(acss_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AcssDebit), active: T.nilable(T::Boolean), affirm: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfiguration::UpdateParams::Zip)).void } def initialize( acss_debit: nil, @@ -3174,21 +3499,26 @@ module Stripe grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, diff --git a/rbi/stripe/resources/payment_method_domain.rbi b/rbi/stripe/resources/payment_method_domain.rbi index 706ebabdb..8be1896dd 100644 --- a/rbi/stripe/resources/payment_method_domain.rbi +++ b/rbi/stripe/resources/payment_method_domain.rbi @@ -208,7 +208,7 @@ module Stripe # # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. # - # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + # Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration). sig { params(params: T.any(::Stripe::PaymentMethodDomain::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain) } @@ -219,7 +219,7 @@ module Stripe # # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. # - # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + # Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration). sig { params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomain::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain) } diff --git a/rbi/stripe/resources/payout.rbi b/rbi/stripe/resources/payout.rbi index 36b49a4c9..293e2aba0 100644 --- a/rbi/stripe/resources/payout.rbi +++ b/rbi/stripe/resources/payout.rbi @@ -5,9 +5,9 @@ module Stripe # A `Payout` object is created when you receive funds from Stripe, or when you # initiate a payout to either a bank account or debit card of a [connected - # Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, + # Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts, # and list all payouts. Payouts are made on [varying - # schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and + # schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and # industry. # # Related guide: [Receiving payouts](https://stripe.com/docs/payouts) @@ -259,11 +259,11 @@ module Stripe } def self.cancel(payout, params = {}, opts = {}); end - # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. + # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. # # If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode. # - # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type. + # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type. sig { params(params: T.any(::Stripe::Payout::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout) } diff --git a/rbi/stripe/resources/person.rbi b/rbi/stripe/resources/person.rbi index 1d70146b1..e0f26eb1c 100644 --- a/rbi/stripe/resources/person.rbi +++ b/rbi/stripe/resources/person.rbi @@ -5,9 +5,9 @@ module Stripe # This is an object representing a person associated with a Stripe account. # - # A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. + # A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. # - # See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information). + # See the [Standard onboarding](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information). class Person < APIResource class AdditionalTosAcceptances < Stripe::StripeObject class Account < Stripe::StripeObject diff --git a/rbi/stripe/resources/plan.rbi b/rbi/stripe/resources/plan.rbi index 22b23602c..4d32080ba 100644 --- a/rbi/stripe/resources/plan.rbi +++ b/rbi/stripe/resources/plan.rbi @@ -100,9 +100,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # Whether the plan is currently available for new subscriptions. sig { returns(T.nilable(T::Boolean)) } @@ -340,7 +338,7 @@ module Stripe usage_type: nil ); end end - # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + # You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. sig { params(params: T.any(::Stripe::Plan::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan) } diff --git a/rbi/stripe/resources/price.rbi b/rbi/stripe/resources/price.rbi index 45973686d..a0f237c27 100644 --- a/rbi/stripe/resources/price.rbi +++ b/rbi/stripe/resources/price.rbi @@ -669,7 +669,7 @@ module Stripe } def self.create(params = {}, opts = {}); end - # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. + # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. sig { params(params: T.any(::Stripe::Price::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } diff --git a/rbi/stripe/resources/product.rbi b/rbi/stripe/resources/product.rbi index 6050837ff..819bc801e 100644 --- a/rbi/stripe/resources/product.rbi +++ b/rbi/stripe/resources/product.rbi @@ -91,9 +91,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class MarketingFeature < Stripe::RequestParams # The marketing feature name. Up to 80 characters long. diff --git a/rbi/stripe/resources/radar/value_list.rbi b/rbi/stripe/resources/radar/value_list.rbi index bbdc30870..4ccf984ab 100644 --- a/rbi/stripe/resources/radar/value_list.rbi +++ b/rbi/stripe/resources/radar/value_list.rbi @@ -41,9 +41,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # The name of the value list for use in rules. sig { returns(T.nilable(String)) } diff --git a/rbi/stripe/resources/radar/value_list_item.rbi b/rbi/stripe/resources/radar/value_list_item.rbi index 987e7d73f..5a92f29fc 100644 --- a/rbi/stripe/resources/radar/value_list_item.rbi +++ b/rbi/stripe/resources/radar/value_list_item.rbi @@ -32,9 +32,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Created < Stripe::RequestParams # Minimum value to filter by (exclusive) diff --git a/rbi/stripe/resources/refund.rbi b/rbi/stripe/resources/refund.rbi index a7c5aa426..7bea23c9a 100644 --- a/rbi/stripe/resources/refund.rbi +++ b/rbi/stripe/resources/refund.rbi @@ -105,7 +105,11 @@ module Stripe attr_reader :reference_status end class Paynow < Stripe::StripeObject; end - class Paypal < Stripe::StripeObject; end + class Paypal < Stripe::StripeObject + # For refunds declined by the network, a decline code provided by the network which indicates the reason the refund failed. + sig { returns(T.nilable(String)) } + attr_reader :network_decline_code + end class Pix < Stripe::StripeObject; end class Revolut < Stripe::StripeObject; end class Sofort < Stripe::StripeObject; end diff --git a/rbi/stripe/resources/reversal.rbi b/rbi/stripe/resources/reversal.rbi index 4e79bbbd4..575c84823 100644 --- a/rbi/stripe/resources/reversal.rbi +++ b/rbi/stripe/resources/reversal.rbi @@ -9,7 +9,7 @@ module Stripe # platform's balance and subtract from the destination account's balance. # # Reversing a transfer that was made for a [destination - # charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of + # charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of # the charge. It is possible to reverse a # [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) # transfer only if the destination account has enough balance to cover the diff --git a/rbi/stripe/resources/review.rbi b/rbi/stripe/resources/review.rbi index 5e1c1b217..abe805146 100644 --- a/rbi/stripe/resources/review.rbi +++ b/rbi/stripe/resources/review.rbi @@ -5,7 +5,7 @@ module Stripe # Reviews can be used to supplement automated fraud detection with human expertise. # - # Learn more about [Radar](https://stripe.com/radar) and reviewing payments + # Learn more about [Radar](https://docs.stripe.com/radar) and reviewing payments # [here](https://stripe.com/docs/radar/reviews). class Review < APIResource class IpAddressLocation < Stripe::StripeObject diff --git a/rbi/stripe/resources/setup_intent.rbi b/rbi/stripe/resources/setup_intent.rbi index cce92b1bf..eefbc6481 100644 --- a/rbi/stripe/resources/setup_intent.rbi +++ b/rbi/stripe/resources/setup_intent.rbi @@ -167,7 +167,7 @@ module Stripe # Attribute for field redirect_to_url sig { returns(RedirectToUrl) } attr_reader :redirect_to_url - # Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. + # Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. sig { returns(String) } attr_reader :type # When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. @@ -511,9 +511,7 @@ module Stripe end class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(String) } @@ -569,21 +567,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -604,12 +592,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -664,9 +648,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -674,12 +656,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -697,12 +675,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -710,12 +684,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -740,21 +710,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -793,9 +753,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -803,24 +761,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -828,15 +774,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -851,12 +791,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -884,12 +820,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::SetupIntent::CreateParams::PaymentMethodData::AcssDebit)) @@ -1191,9 +1123,7 @@ module Stripe } def initialize(currency: nil, mandate_options: nil, verification_method: nil); end end - class AmazonPay < Stripe::RequestParams - - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. @@ -1370,9 +1300,7 @@ module Stripe three_d_secure: nil ); end end - class CardPresent < Stripe::RequestParams - - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. sig { returns(T.nilable(String)) } @@ -1657,21 +1585,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -1692,12 +1610,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -1752,9 +1666,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -1762,12 +1674,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1785,12 +1693,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -1798,12 +1702,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -1828,21 +1728,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -1881,9 +1771,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1891,24 +1779,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -1916,15 +1792,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -1939,12 +1809,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -1972,12 +1838,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::SetupIntent::UpdateParams::PaymentMethodData::AcssDebit)) @@ -2279,9 +2141,7 @@ module Stripe } def initialize(currency: nil, mandate_options: nil, verification_method: nil); end end - class AmazonPay < Stripe::RequestParams - - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. @@ -2458,9 +2318,7 @@ module Stripe three_d_secure: nil ); end end - class CardPresent < Stripe::RequestParams - - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. sig { returns(T.nilable(String)) } @@ -2691,9 +2549,7 @@ module Stripe class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(T.nilable(String)) } @@ -2751,21 +2607,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -2786,12 +2632,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -2846,9 +2688,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -2856,12 +2696,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2879,12 +2715,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -2892,12 +2724,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -2922,21 +2750,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -2975,9 +2793,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2985,24 +2801,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -3010,15 +2814,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -3033,12 +2831,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -3066,12 +2860,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::SetupIntent::ConfirmParams::PaymentMethodData::AcssDebit)) @@ -3379,9 +3169,7 @@ module Stripe } def initialize(currency: nil, mandate_options: nil, verification_method: nil); end end - class AmazonPay < Stripe::RequestParams - - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. @@ -3558,9 +3346,7 @@ module Stripe three_d_secure: nil ); end end - class CardPresent < Stripe::RequestParams - - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. sig { returns(T.nilable(String)) } @@ -3781,7 +3567,7 @@ module Stripe end # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. # - # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. sig { params(params: T.any(::Stripe::SetupIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent) } @@ -3789,7 +3575,7 @@ module Stripe # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. # - # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. sig { params(intent: String, params: T.any(::Stripe::SetupIntent::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent) } @@ -3835,7 +3621,7 @@ module Stripe # Creates a SetupIntent object. # - # After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm) + # After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm) # it to collect any required permissions to charge the payment method later. sig { params(params: T.any(::Stripe::SetupIntent::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent) diff --git a/rbi/stripe/resources/source.rbi b/rbi/stripe/resources/source.rbi index cb65a328f..e9a522804 100644 --- a/rbi/stripe/resources/source.rbi +++ b/rbi/stripe/resources/source.rbi @@ -1475,7 +1475,7 @@ module Stripe # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged. # - # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail. + # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail. sig { params(source: String, params: T.any(::Stripe::Source::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source) } diff --git a/rbi/stripe/resources/subscription.rbi b/rbi/stripe/resources/subscription.rbi index a32a7177c..e060831bf 100644 --- a/rbi/stripe/resources/subscription.rbi +++ b/rbi/stripe/resources/subscription.rbi @@ -43,6 +43,14 @@ module Stripe sig { returns(T.nilable(Integer)) } attr_reader :second end + class BillingThresholds < Stripe::StripeObject + # Monetary threshold that triggers the subscription to create an invoice + sig { returns(T.nilable(Integer)) } + attr_reader :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :reset_billing_cycle_anchor + end class CancellationDetails < Stripe::StripeObject # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. sig { returns(T.nilable(String)) } @@ -257,10 +265,13 @@ module Stripe # The fixed values used to calculate the `billing_cycle_anchor`. sig { returns(T.nilable(BillingCycleAnchorConfig)) } attr_reader :billing_cycle_anchor_config + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + sig { returns(T.nilable(BillingThresholds)) } + attr_reader :billing_thresholds # A date in the future at which the subscription will automatically get canceled sig { returns(T.nilable(Integer)) } attr_reader :cancel_at - # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. + # Whether this subscription will (if `status=active`) or did (if `status=canceled`) cancel at the end of the current billing period. This field will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T::Boolean) } attr_reader :cancel_at_period_end # If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state. @@ -377,7 +388,7 @@ module Stripe # Settings related to subscription trials. sig { returns(T.nilable(TrialSettings)) } attr_reader :trial_settings - # If the subscription has a trial, the beginning of that trial. + # If the subscription has a trial, the beginning of that trial. For subsequent trials, this date remains as the start of the first ever trial on the subscription. sig { returns(T.nilable(Integer)) } attr_reader :trial_start class CancelParams < Stripe::RequestParams @@ -504,6 +515,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class CancellationDetails < Stripe::RequestParams # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. sig { returns(T.nilable(T.nilable(String))) } @@ -554,6 +577,13 @@ module Stripe def initialize(account_tax_ids: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -610,6 +640,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. sig { returns(T.nilable(T::Boolean)) } attr_accessor :clear_usage @@ -643,9 +678,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::UpdateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::Item::BillingThresholds))), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::UpdateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -765,12 +801,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -925,10 +957,15 @@ module Stripe # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled @@ -1000,7 +1037,7 @@ module Stripe # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + # If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. sig { returns(T.nilable(Integer)) } attr_accessor :proration_date # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. @@ -1008,7 +1045,7 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData)))) } attr_accessor :transfer_data - # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. sig { returns(T.nilable(T.any(String, Integer))) } attr_accessor :trial_end # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. @@ -1018,13 +1055,14 @@ module Stripe sig { returns(T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings)) } attr_accessor :trial_settings sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax), billing_cycle_anchor: T.nilable(String), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancellation_details: T.nilable(::Stripe::Subscription::UpdateParams::CancellationDetails), collection_method: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(T.nilable(String)), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), pause_collection: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PauseCollection))), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData))), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_settings: T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings)).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::Subscription::UpdateParams::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::BillingThresholds))), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancellation_details: T.nilable(::Stripe::Subscription::UpdateParams::CancellationDetails), collection_method: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(T.nilable(String)), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::Subscription::UpdateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::Subscription::UpdateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), pause_collection: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PauseCollection))), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::Subscription::UpdateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::UpdateParams::TransferData))), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_settings: T.nilable(::Stripe::Subscription::UpdateParams::TrialSettings)).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, cancellation_details: nil, @@ -1053,9 +1091,7 @@ module Stripe trial_settings: nil ); end end - class DeleteDiscountParams < Stripe::RequestParams - - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class AutomaticTax < Stripe::RequestParams # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription. @@ -1299,6 +1335,18 @@ module Stripe } def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -1337,6 +1385,13 @@ module Stripe def initialize(account_tax_ids: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -1393,6 +1448,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount])))) @@ -1417,9 +1477,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::CreateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::Subscription::CreateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -1526,12 +1587,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -1692,10 +1749,15 @@ module Stripe # Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC. sig { returns(T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig)) } attr_accessor :billing_cycle_anchor_config + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(Integer)) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. @@ -1785,7 +1847,7 @@ module Stripe sig { returns(T.nilable(::Stripe::Subscription::CreateParams::TrialSettings)) } attr_accessor :trial_settings sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax), backdate_start_date: T.nilable(Integer), billing_cycle_anchor: T.nilable(Integer), billing_cycle_anchor_config: T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig), cancel_at: T.nilable(Integer), cancel_at_period_end: T.nilable(T::Boolean), collection_method: T.nilable(String), currency: T.nilable(String), customer: String, days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(String), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Subscription::CreateParams::TransferData), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Subscription::CreateParams::TrialSettings)).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::Subscription::CreateParams::AutomaticTax), backdate_start_date: T.nilable(Integer), billing_cycle_anchor: T.nilable(Integer), billing_cycle_anchor_config: T.nilable(::Stripe::Subscription::CreateParams::BillingCycleAnchorConfig), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::BillingThresholds))), cancel_at: T.nilable(Integer), cancel_at_period_end: T.nilable(T::Boolean), collection_method: T.nilable(String), currency: T.nilable(String), customer: String, days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(String), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::Subscription::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::Subscription::CreateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::Subscription::CreateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::Subscription::CreateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::Subscription::CreateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::Subscription::CreateParams::TransferData), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::Subscription::CreateParams::TrialSettings)).void } def initialize( add_invoice_items: nil, @@ -1794,6 +1856,7 @@ module Stripe backdate_start_date: nil, billing_cycle_anchor: nil, billing_cycle_anchor_config: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, collection_method: nil, @@ -1847,10 +1910,10 @@ module Stripe # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } attr_accessor :expand - # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. sig { returns(T.nilable(Integer)) } attr_accessor :proration_date sig { @@ -1863,9 +1926,9 @@ module Stripe proration_date: nil ); end end - # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata). + # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata). # - # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. + # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. # # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. sig { @@ -1873,9 +1936,9 @@ module Stripe } def cancel(params = {}, opts = {}); end - # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata). + # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata). # - # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. + # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. # # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. sig { @@ -1888,7 +1951,7 @@ module Stripe # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. # The payment_behavior parameter determines the exact behavior of the initial payment. # - # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. + # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. # Schedules provide the flexibility to model more complex billing configurations that change over time. sig { params(params: T.any(::Stripe::Subscription::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription) @@ -1937,7 +2000,7 @@ module Stripe # Updates an existing subscription to match the specified parameters. # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. - # To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. + # To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint. # # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. # @@ -1949,13 +2012,13 @@ module Stripe # A trial starts or ends. # # - # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). + # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). # - # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create). + # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create). # # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription. # - # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://stripe.com/docs/rate-limits) instead. + # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead. sig { params(subscription_exposed_id: String, params: T.any(::Stripe::Subscription::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription) } diff --git a/rbi/stripe/resources/subscription_item.rbi b/rbi/stripe/resources/subscription_item.rbi index 37516150c..fdc662f38 100644 --- a/rbi/stripe/resources/subscription_item.rbi +++ b/rbi/stripe/resources/subscription_item.rbi @@ -6,6 +6,14 @@ module Stripe # Subscription items allow you to create customer subscriptions with more than # one plan, making it easy to represent complex billing relationships. class SubscriptionItem < APIResource + class BillingThresholds < Stripe::StripeObject + # Usage threshold that triggers the subscription to create an invoice + sig { returns(T.nilable(Integer)) } + attr_reader :usage_gte + end + # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + sig { returns(T.nilable(BillingThresholds)) } + attr_reader :billing_thresholds # Time at which the object was created. Measured in seconds since the Unix epoch. sig { returns(Integer) } attr_reader :created @@ -73,6 +81,13 @@ module Stripe def initialize(clear_usage: nil, proration_behavior: nil, proration_date: nil); end end class UpdateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -129,6 +144,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount])))) @@ -174,9 +194,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItem::UpdateParams::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, @@ -219,6 +240,13 @@ module Stripe ); end end class CreateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -275,6 +303,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount])))) @@ -320,9 +353,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItem::CreateParams::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItem::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItem::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, diff --git a/rbi/stripe/resources/subscription_schedule.rbi b/rbi/stripe/resources/subscription_schedule.rbi index fac0f142d..226fe3cef 100644 --- a/rbi/stripe/resources/subscription_schedule.rbi +++ b/rbi/stripe/resources/subscription_schedule.rbi @@ -35,6 +35,14 @@ module Stripe sig { returns(T.nilable(Liability)) } attr_reader :liability end + class BillingThresholds < Stripe::StripeObject + # Monetary threshold that triggers the subscription to create an invoice + sig { returns(T.nilable(Integer)) } + attr_reader :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :reset_billing_cycle_anchor + end class InvoiceSettings < Stripe::StripeObject class Issuer < Stripe::StripeObject # The connected account being referenced when `type` is `account`. @@ -71,6 +79,9 @@ module Stripe # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(String) } attr_reader :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + sig { returns(T.nilable(BillingThresholds)) } + attr_reader :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. sig { returns(T.nilable(String)) } attr_reader :collection_method @@ -135,6 +146,14 @@ module Stripe sig { returns(T.nilable(Liability)) } attr_reader :liability end + class BillingThresholds < Stripe::StripeObject + # Monetary threshold that triggers the subscription to create an invoice + sig { returns(T.nilable(Integer)) } + attr_reader :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :reset_billing_cycle_anchor + end class Discount < Stripe::StripeObject # ID of the coupon to create a new discount for. sig { returns(T.nilable(T.any(String, Stripe::Coupon))) } @@ -166,6 +185,11 @@ module Stripe attr_reader :issuer end class Item < Stripe::StripeObject + class BillingThresholds < Stripe::StripeObject + # Usage threshold that triggers the subscription to create an invoice + sig { returns(T.nilable(Integer)) } + attr_reader :usage_gte + end class Discount < Stripe::StripeObject # ID of the coupon to create a new discount for. sig { returns(T.nilable(T.any(String, Stripe::Coupon))) } @@ -177,6 +201,9 @@ module Stripe sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) } attr_reader :promotion_code end + # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period + sig { returns(T.nilable(BillingThresholds)) } + attr_reader :billing_thresholds # The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. sig { returns(T::Array[Discount]) } attr_reader :discounts @@ -216,6 +243,9 @@ module Stripe # Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_reader :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period + sig { returns(T.nilable(BillingThresholds)) } + attr_reader :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. sig { returns(T.nilable(String)) } attr_reader :collection_method @@ -249,7 +279,7 @@ module Stripe # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. sig { returns(T.nilable(T.any(String, Stripe::Account))) } attr_reader :on_behalf_of - # If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. + # When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`. sig { returns(String) } attr_reader :proration_behavior # The start of this phase of the subscription schedule. @@ -469,6 +499,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -517,6 +559,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -540,12 +587,13 @@ module Stripe } attr_accessor :transfer_data sig { - params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData)))).void + params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::BillingThresholds))), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::DefaultSettings::TransferData)))).void } def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -652,6 +700,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -695,6 +755,13 @@ module Stripe def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -753,6 +820,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount])))) @@ -779,9 +851,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -817,6 +890,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -857,7 +935,7 @@ module Stripe # The account on behalf of which to charge, for each of the associated subscription's invoices. sig { returns(T.nilable(String)) } attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior # The data with which to automatically create a Transfer for each of the associated subscription's invoices. @@ -872,13 +950,14 @@ module Stripe sig { returns(T.nilable(Integer)) } attr_accessor :trial_end sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount]))), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(Integer)).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::CreateParams::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Discount]))), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionSchedule::CreateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(Integer)).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -961,6 +1040,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -1009,6 +1100,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -1032,12 +1128,13 @@ module Stripe } attr_accessor :transfer_data sig { - params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData)))).void + params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::BillingThresholds))), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::DefaultSettings::TransferData)))).void } def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -1144,6 +1241,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -1187,6 +1296,13 @@ module Stripe def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -1245,6 +1361,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount])))) @@ -1271,9 +1392,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -1309,6 +1431,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -1349,7 +1476,7 @@ module Stripe # The account on behalf of which to charge, for each of the associated subscription's invoices. sig { returns(T.nilable(String)) } attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. @@ -1367,13 +1494,14 @@ module Stripe sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :trial_end sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionSchedule::UpdateParams::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionSchedule::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -1408,7 +1536,7 @@ module Stripe # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. sig { returns(T.nilable(T::Array[::Stripe::SubscriptionSchedule::UpdateParams::Phase])) } attr_accessor :phases - # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. + # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior sig { diff --git a/rbi/stripe/resources/tax/calculation.rbi b/rbi/stripe/resources/tax/calculation.rbi index e1ed3557f..ec02b5993 100644 --- a/rbi/stripe/resources/tax/calculation.rbi +++ b/rbi/stripe/resources/tax/calculation.rbi @@ -329,6 +329,9 @@ module Stripe # If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. sig { returns(Integer) } attr_accessor :amount + # 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. + sig { returns(T.nilable(T::Hash[String, String])) } + attr_accessor :metadata # If provided, the product's `tax_code` will be used as the line item's `tax_code`. sig { returns(T.nilable(String)) } attr_accessor :product @@ -345,10 +348,11 @@ module Stripe sig { returns(T.nilable(String)) } attr_accessor :tax_code sig { - params(amount: Integer, product: T.nilable(String), quantity: T.nilable(Integer), reference: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void + params(amount: Integer, metadata: T.nilable(T::Hash[String, String]), product: T.nilable(String), quantity: T.nilable(Integer), reference: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void } def initialize( amount: nil, + metadata: nil, product: nil, quantity: nil, reference: nil, diff --git a/rbi/stripe/resources/tax/calculation_line_item.rbi b/rbi/stripe/resources/tax/calculation_line_item.rbi index 8d5084929..a2cd24e1b 100644 --- a/rbi/stripe/resources/tax/calculation_line_item.rbi +++ b/rbi/stripe/resources/tax/calculation_line_item.rbi @@ -62,6 +62,9 @@ module Stripe # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. sig { returns(T::Boolean) } attr_reader :livemode + # 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. + sig { returns(T.nilable(T::Hash[String, String])) } + attr_reader :metadata # String representing the object's type. Objects of the same type share the same value. sig { returns(String) } attr_reader :object diff --git a/rbi/stripe/resources/tax/registration.rbi b/rbi/stripe/resources/tax/registration.rbi index 4d62191a9..9d03a9af3 100644 --- a/rbi/stripe/resources/tax/registration.rbi +++ b/rbi/stripe/resources/tax/registration.rbi @@ -2142,7 +2142,7 @@ module Stripe end class Us < Stripe::RequestParams class LocalAmusementTax < Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). sig { returns(String) } attr_accessor :jurisdiction sig { params(jurisdiction: String).void } diff --git a/rbi/stripe/resources/tax_id.rbi b/rbi/stripe/resources/tax_id.rbi index 97e779bf9..25798f5aa 100644 --- a/rbi/stripe/resources/tax_id.rbi +++ b/rbi/stripe/resources/tax_id.rbi @@ -66,9 +66,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Owner < Stripe::RequestParams # Account the tax ID belongs to. Required when `type=account` diff --git a/rbi/stripe/resources/tax_rate.rbi b/rbi/stripe/resources/tax_rate.rbi index f02e45617..f103960e0 100644 --- a/rbi/stripe/resources/tax_rate.rbi +++ b/rbi/stripe/resources/tax_rate.rbi @@ -3,9 +3,9 @@ # typed: true module Stripe - # Tax rates can be applied to [invoices](https://stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://stripe.com/payments/checkout/use-manual-tax-rates) to collect tax. + # Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax. # - # Related guide: [Tax rates](https://stripe.com/billing/taxes/tax-rates) + # Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates) class TaxRate < APIResource class FlatAmount < Stripe::StripeObject # Amount of the tax when the `rate_type` is `flat_amount`. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). diff --git a/rbi/stripe/resources/terminal/configuration.rbi b/rbi/stripe/resources/terminal/configuration.rbi index 48d7e7250..c38d95109 100644 --- a/rbi/stripe/resources/terminal/configuration.rbi +++ b/rbi/stripe/resources/terminal/configuration.rbi @@ -352,9 +352,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class BbposWiseposE < Stripe::RequestParams # A File ID representing an image to display on the reader diff --git a/rbi/stripe/resources/terminal/location.rbi b/rbi/stripe/resources/terminal/location.rbi index 215df7748..97cf73773 100644 --- a/rbi/stripe/resources/terminal/location.rbi +++ b/rbi/stripe/resources/terminal/location.rbi @@ -52,9 +52,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -190,7 +188,7 @@ module Stripe ); end end # Creates a new Location object. - # For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide. + # For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide. sig { params(params: T.any(::Stripe::Terminal::Location::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location) } diff --git a/rbi/stripe/resources/terminal/reader.rbi b/rbi/stripe/resources/terminal/reader.rbi index 1eac6a8d0..06ede9c89 100644 --- a/rbi/stripe/resources/terminal/reader.rbi +++ b/rbi/stripe/resources/terminal/reader.rbi @@ -9,6 +9,124 @@ module Stripe # Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader) class Reader < APIResource class Action < Stripe::StripeObject + class CollectInputs < Stripe::StripeObject + class Input < Stripe::StripeObject + class CustomText < Stripe::StripeObject + # Customize the default description for this input + sig { returns(T.nilable(String)) } + attr_reader :description + # Customize the default label for this input's skip button + sig { returns(T.nilable(String)) } + attr_reader :skip_button + # Customize the default label for this input's submit button + sig { returns(T.nilable(String)) } + attr_reader :submit_button + # Customize the default title for this input + sig { returns(T.nilable(String)) } + attr_reader :title + end + class Email < Stripe::StripeObject + # The collected email address + sig { returns(T.nilable(String)) } + attr_reader :value + end + class Numeric < Stripe::StripeObject + # The collected number + sig { returns(T.nilable(String)) } + attr_reader :value + end + class Phone < Stripe::StripeObject + # The collected phone number + sig { returns(T.nilable(String)) } + attr_reader :value + end + class Selection < Stripe::StripeObject + class Choice < Stripe::StripeObject + # The id to be selected + sig { returns(T.nilable(String)) } + attr_reader :id + # The button style for the choice + sig { returns(T.nilable(String)) } + attr_reader :style + # The text to be selected + sig { returns(String) } + attr_reader :text + end + # List of possible choices to be selected + sig { returns(T::Array[Choice]) } + attr_reader :choices + # The id of the selected choice + sig { returns(T.nilable(String)) } + attr_reader :id + # The text of the selected choice + sig { returns(T.nilable(String)) } + attr_reader :text + end + class Signature < Stripe::StripeObject + # The File ID of a collected signature image + sig { returns(T.nilable(String)) } + attr_reader :value + end + class Text < Stripe::StripeObject + # The collected text value + sig { returns(T.nilable(String)) } + attr_reader :value + end + class Toggle < Stripe::StripeObject + # The toggle's default value + sig { returns(T.nilable(String)) } + attr_reader :default_value + # The toggle's description text + sig { returns(T.nilable(String)) } + attr_reader :description + # The toggle's title text + sig { returns(T.nilable(String)) } + attr_reader :title + # The toggle's collected value + sig { returns(T.nilable(String)) } + attr_reader :value + end + # Default text of input being collected. + sig { returns(T.nilable(CustomText)) } + attr_reader :custom_text + # Information about a email being collected using a reader + sig { returns(Email) } + attr_reader :email + # Information about a number being collected using a reader + sig { returns(Numeric) } + attr_reader :numeric + # Information about a phone number being collected using a reader + sig { returns(Phone) } + attr_reader :phone + # Indicate that this input is required, disabling the skip button. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :required + # Information about a selection being collected using a reader + sig { returns(Selection) } + attr_reader :selection + # Information about a signature being collected using a reader + sig { returns(Signature) } + attr_reader :signature + # Indicate that this input was skipped by the user. + sig { returns(T::Boolean) } + attr_reader :skipped + # Information about text being collected using a reader + sig { returns(Text) } + attr_reader :text + # List of toggles being collected. Values are present if collection is complete. + sig { returns(T.nilable(T::Array[Toggle])) } + attr_reader :toggles + # Type of input being collected. + sig { returns(String) } + attr_reader :type + end + # List of inputs to be collected. + sig { returns(T::Array[Input]) } + attr_reader :inputs + # 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. + sig { returns(T.nilable(T::Hash[String, String])) } + attr_reader :metadata + end class ProcessPaymentIntent < Stripe::StripeObject class ProcessConfig < Stripe::StripeObject class Tipping < Stripe::StripeObject @@ -19,6 +137,9 @@ module Stripe # Enable customer initiated cancellation when processing this payment. sig { returns(T::Boolean) } attr_reader :enable_customer_cancellation + # If the customer does not abandon authenticating the payment, they will be redirected to this specified URL after completion. + sig { returns(String) } + attr_reader :return_url # Override showing a tipping selection screen on this transaction. sig { returns(T::Boolean) } attr_reader :skip_tipping @@ -116,6 +237,9 @@ module Stripe sig { returns(String) } attr_reader :type end + # Represents a reader action to collect customer inputs + sig { returns(CollectInputs) } + attr_reader :collect_inputs # Failure code, only set if status is `failed`. sig { returns(T.nilable(String)) } attr_reader :failure_code @@ -147,7 +271,7 @@ module Stripe # The current software version of the reader. sig { returns(T.nilable(String)) } attr_reader :device_sw_version - # Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. + # Device type of the reader. sig { returns(String) } attr_reader :device_type # Unique identifier for the object. @@ -180,9 +304,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -271,6 +393,109 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end + class CollectInputsParams < Stripe::RequestParams + class Input < Stripe::RequestParams + class CustomText < Stripe::RequestParams + # The description which will be displayed when collecting this input + sig { returns(T.nilable(String)) } + attr_accessor :description + # The skip button text + sig { returns(T.nilable(String)) } + attr_accessor :skip_button + # The submit button text + sig { returns(T.nilable(String)) } + attr_accessor :submit_button + # The title which will be displayed when collecting this input + sig { returns(String) } + attr_accessor :title + sig { + params(description: T.nilable(String), skip_button: T.nilable(String), submit_button: T.nilable(String), title: String).void + } + def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil); end + end + class Selection < Stripe::RequestParams + class Choice < Stripe::RequestParams + # The unique identifier for this choice + sig { returns(String) } + attr_accessor :id + # The style of the button which will be shown for this choice + sig { returns(T.nilable(String)) } + attr_accessor :style + # The text which will be shown on the button for this choice + sig { returns(String) } + attr_accessor :text + sig { params(id: String, style: T.nilable(String), text: String).void } + def initialize(id: nil, style: nil, text: nil); end + end + # List of choices for the `selection` input + sig { + returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice]) + } + attr_accessor :choices + sig { + params(choices: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection::Choice]).void + } + def initialize(choices: nil); end + end + class Toggle < Stripe::RequestParams + # The default value of the toggle + sig { returns(T.nilable(String)) } + attr_accessor :default_value + # The description which will be displayed for the toggle + sig { returns(T.nilable(String)) } + attr_accessor :description + # The title which will be displayed for the toggle + sig { returns(T.nilable(String)) } + attr_accessor :title + sig { + params(default_value: T.nilable(String), description: T.nilable(String), title: T.nilable(String)).void + } + def initialize(default_value: nil, description: nil, title: nil); end + end + # Customize the text which will be displayed while collecting this input + sig { returns(::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText) } + attr_accessor :custom_text + # Indicate that this input is required, disabling the skip button + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :required + # Options for the `selection` input + sig { + returns(T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection)) + } + attr_accessor :selection + # List of toggles to be displayed and customization for the toggles + sig { + returns(T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle])) + } + attr_accessor :toggles + # The type of input to collect + sig { returns(String) } + attr_accessor :type + sig { + params(custom_text: ::Stripe::Terminal::Reader::CollectInputsParams::Input::CustomText, required: T.nilable(T::Boolean), selection: T.nilable(::Stripe::Terminal::Reader::CollectInputsParams::Input::Selection), toggles: T.nilable(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input::Toggle]), type: String).void + } + def initialize( + custom_text: nil, + required: nil, + selection: nil, + toggles: nil, + type: nil + ); end + end + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + # List of inputs to be collected using the Reader + sig { returns(T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input]) } + attr_accessor :inputs + # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + sig { returns(T.nilable(T::Hash[String, String])) } + attr_accessor :metadata + sig { + params(expand: T.nilable(T::Array[String]), inputs: T::Array[::Stripe::Terminal::Reader::CollectInputsParams::Input], metadata: T.nilable(T::Hash[String, String])).void + } + def initialize(expand: nil, inputs: nil, metadata: nil); end + end class ProcessPaymentIntentParams < Stripe::RequestParams class ProcessConfig < Stripe::RequestParams class Tipping < Stripe::RequestParams @@ -286,6 +511,9 @@ module Stripe # Enables cancel button on transaction screens. sig { returns(T.nilable(T::Boolean)) } attr_accessor :enable_customer_cancellation + # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. + sig { returns(T.nilable(String)) } + attr_accessor :return_url # Override showing a tipping selection screen on this transaction. sig { returns(T.nilable(T::Boolean)) } attr_accessor :skip_tipping @@ -295,11 +523,12 @@ module Stripe } attr_accessor :tipping sig { - params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void + params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), return_url: T.nilable(String), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void } def initialize( allow_redisplay: nil, enable_customer_cancellation: nil, + return_url: nil, skip_tipping: nil, tipping: nil ); end @@ -493,6 +722,25 @@ module Stripe type: nil ); end end + class SucceedInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + # This parameter defines the skip behavior for input collection. + sig { returns(T.nilable(String)) } + attr_accessor :skip_non_required_inputs + sig { + params(expand: T.nilable(T::Array[String]), skip_non_required_inputs: T.nilable(String)).void + } + def initialize(expand: nil, skip_non_required_inputs: nil); end + end + class TimeoutInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + sig { params(expand: T.nilable(T::Array[String])).void } + def initialize(expand: nil); end + end # Cancels the current reader action. sig { params(params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) @@ -505,6 +753,18 @@ module Stripe } def self.cancel_action(reader, params = {}, opts = {}); end + # Initiates an input collection flow on a Reader. + sig { + params(params: T.any(::Stripe::Terminal::Reader::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) + } + def collect_inputs(params = {}, opts = {}); end + + # Initiates an input collection flow on a Reader. + sig { + params(reader: String, params: T.any(::Stripe::Terminal::Reader::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) + } + def self.collect_inputs(reader, params = {}, opts = {}); end + # Creates a new Reader object. sig { params(params: T.any(::Stripe::Terminal::Reader::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) diff --git a/rbi/stripe/resources/test_helpers/test_clock.rbi b/rbi/stripe/resources/test_helpers/test_clock.rbi index e0955d74d..6292195ea 100644 --- a/rbi/stripe/resources/test_helpers/test_clock.rbi +++ b/rbi/stripe/resources/test_helpers/test_clock.rbi @@ -48,9 +48,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams # 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. sig { returns(T.nilable(String)) } diff --git a/rbi/stripe/resources/token.rbi b/rbi/stripe/resources/token.rbi index 6a50b0f20..e7baa9928 100644 --- a/rbi/stripe/resources/token.rbi +++ b/rbi/stripe/resources/token.rbi @@ -20,7 +20,7 @@ module Stripe # # You can't store or use tokens more than once. To store card or bank account # information for later use, create [Customer](https://stripe.com/docs/api#customers) - # objects or [External accounts](https://stripe.com/api#external_accounts). + # objects or [External accounts](https://docs.stripe.com/api#external_accounts). # [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, # performs best with integrations that use client-side tokenization. class Token < APIResource @@ -1274,7 +1274,7 @@ module Stripe ); end end # Creates a single-use token that represents a bank account's details. - # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. + # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. sig { params(params: T.any(::Stripe::Token::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token) } diff --git a/rbi/stripe/resources/transfer.rbi b/rbi/stripe/resources/transfer.rbi index 492f3b520..e0173e705 100644 --- a/rbi/stripe/resources/transfer.rbi +++ b/rbi/stripe/resources/transfer.rbi @@ -176,7 +176,7 @@ module Stripe } def initialize(description: nil, expand: nil, metadata: nil); end end - # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. + # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. sig { params(params: T.any(::Stripe::Transfer::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer) } diff --git a/rbi/stripe/resources/webhook_endpoint.rbi b/rbi/stripe/resources/webhook_endpoint.rbi index e19b3df37..63f77458d 100644 --- a/rbi/stripe/resources/webhook_endpoint.rbi +++ b/rbi/stripe/resources/webhook_endpoint.rbi @@ -50,9 +50,7 @@ module Stripe # Always true for a deleted object sig { returns(T::Boolean) } attr_reader :deleted - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class UpdateParams < Stripe::RequestParams # An optional description of what the webhook is used for. sig { returns(T.nilable(T.nilable(String))) } diff --git a/rbi/stripe/services/account_external_account_service.rbi b/rbi/stripe/services/account_external_account_service.rbi index d35b54f0c..8e705b74a 100644 --- a/rbi/stripe/services/account_external_account_service.rbi +++ b/rbi/stripe/services/account_external_account_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class AccountExternalAccountService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -294,7 +292,7 @@ module Stripe # a connected account and optionally sets it as the default for its currency. Other bank account # details are not editable by design. # - # You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection). + # You can only update bank accounts when [account.controller.requirement_collection is application, which includes Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection). # # You can re-enable a disabled bank account by performing an update call without providing any # arguments or changes. diff --git a/rbi/stripe/services/account_login_link_service.rbi b/rbi/stripe/services/account_login_link_service.rbi index d9aea2627..558a46455 100644 --- a/rbi/stripe/services/account_login_link_service.rbi +++ b/rbi/stripe/services/account_login_link_service.rbi @@ -13,7 +13,7 @@ module Stripe end # Creates a login link for a connected account to access the Express Dashboard. # - # You can only create login links for accounts that use the [Express Dashboard](https://stripe.com/connect/express-dashboard) and are connected to your platform. + # You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform. sig { params(account: String, params: T.any(::Stripe::AccountLoginLinkService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::LoginLink) } diff --git a/rbi/stripe/services/account_person_service.rbi b/rbi/stripe/services/account_person_service.rbi index 398b72a1a..1c98975bc 100644 --- a/rbi/stripe/services/account_person_service.rbi +++ b/rbi/stripe/services/account_person_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class AccountPersonService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/account_service.rbi b/rbi/stripe/services/account_service.rbi index b890b1cf4..ed8001c81 100644 --- a/rbi/stripe/services/account_service.rbi +++ b/rbi/stripe/services/account_service.rbi @@ -8,9 +8,7 @@ module Stripe attr_reader :external_accounts attr_reader :login_links attr_reader :persons - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -457,6 +455,13 @@ module Stripe sig { params(requested: T.nilable(T::Boolean)).void } def initialize(requested: nil); end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :requested + sig { params(requested: T.nilable(T::Boolean)).void } + def initialize(requested: nil); end + end class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. sig { returns(T.nilable(T::Boolean)) } @@ -774,6 +779,11 @@ module Stripe returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments)) } attr_accessor :paynow_payments + # The pix_payments capability. + sig { + returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PixPayments)) + } + attr_accessor :pix_payments # The promptpay_payments capability. sig { returns(T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments)) @@ -851,7 +861,7 @@ module Stripe } attr_accessor :zip_payments sig { - params(acss_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments), promptpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ZipPayments)).void + params(acss_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PaynowPayments), pix_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::AccountService::UpdateParams::Capabilities::ZipPayments)).void } def initialize( acss_debit_payments: nil, @@ -895,6 +905,7 @@ module Stripe pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -2502,6 +2513,13 @@ module Stripe sig { params(requested: T.nilable(T::Boolean)).void } def initialize(requested: nil); end end + class PixPayments < Stripe::RequestParams + # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :requested + sig { params(requested: T.nilable(T::Boolean)).void } + def initialize(requested: nil); end + end class PromptpayPayments < Stripe::RequestParams # Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. sig { returns(T.nilable(T::Boolean)) } @@ -2819,6 +2837,11 @@ module Stripe returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments)) } attr_accessor :paynow_payments + # The pix_payments capability. + sig { + returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PixPayments)) + } + attr_accessor :pix_payments # The promptpay_payments capability. sig { returns(T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments)) @@ -2896,7 +2919,7 @@ module Stripe } attr_accessor :zip_payments sig { - params(acss_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments), promptpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ZipPayments)).void + params(acss_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AcssDebitPayments), affirm_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AffirmPayments), afterpay_clearpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AfterpayClearpayPayments), alma_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AlmaPayments), amazon_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AmazonPayPayments), au_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::AuBecsDebitPayments), bacs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BacsDebitPayments), bancontact_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BancontactPayments), bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BankTransferPayments), billie_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BilliePayments), blik_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BlikPayments), boleto_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::BoletoPayments), card_issuing: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardIssuing), card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CardPayments), cartes_bancaires_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CartesBancairesPayments), cashapp_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::CashappPayments), eps_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::EpsPayments), fpx_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::FpxPayments), gb_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GbBankTransferPayments), giropay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GiropayPayments), grabpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::GrabpayPayments), ideal_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IdealPayments), india_international_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::IndiaInternationalPayments), jcb_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JcbPayments), jp_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::JpBankTransferPayments), kakao_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KakaoPayPayments), klarna_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KlarnaPayments), konbini_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KonbiniPayments), kr_card_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::KrCardPayments), legacy_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LegacyPayments), link_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::LinkPayments), mobilepay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MobilepayPayments), multibanco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MultibancoPayments), mx_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::MxBankTransferPayments), naver_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NaverPayPayments), nz_bank_account_becs_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::NzBankAccountBecsDebitPayments), oxxo_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::OxxoPayments), p24_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::P24Payments), pay_by_bank_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PayByBankPayments), payco_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaycoPayments), paynow_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PaynowPayments), pix_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PixPayments), promptpay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::PromptpayPayments), revolut_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::RevolutPayPayments), samsung_pay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SamsungPayPayments), satispay_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SatispayPayments), sepa_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaBankTransferPayments), sepa_debit_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SepaDebitPayments), sofort_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SofortPayments), swish_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::SwishPayments), tax_reporting_us_1099_k: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099K), tax_reporting_us_1099_misc: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TaxReportingUs1099Misc), transfers: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Transfers), treasury: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::Treasury), twint_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::TwintPayments), us_bank_account_ach_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankAccountAchPayments), us_bank_transfer_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::UsBankTransferPayments), zip_payments: T.nilable(::Stripe::AccountService::CreateParams::Capabilities::ZipPayments)).void } def initialize( acss_debit_payments: nil, @@ -2940,6 +2963,7 @@ module Stripe pay_by_bank_payments: nil, payco_payments: nil, paynow_payments: nil, + pix_payments: nil, promptpay_payments: nil, revolut_pay_payments: nil, samsung_pay_payments: nil, @@ -4119,10 +4143,10 @@ module Stripe sig { params(expand: T.nilable(T::Array[String]), reason: String).void } def initialize(expand: nil, reason: nil); end end - # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users. + # With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users. # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings). # - # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when + # If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding. # You can prefill any information on the account. sig { @@ -4130,11 +4154,11 @@ module Stripe } def create(params = {}, opts = {}); end - # With [Connect](https://stripe.com/connect), you can delete accounts you manage. + # With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage. # # Test-mode accounts can be deleted at any time. # - # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero. + # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero. # # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead. sig { @@ -4142,13 +4166,13 @@ module Stripe } def delete(account, params = {}, opts = {}); end - # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty. + # Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty. sig { params(params: T.any(::Stripe::AccountService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } def list(params = {}, opts = {}); end - # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious. + # With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious. # # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero. sig { @@ -4168,19 +4192,19 @@ module Stripe } def retrieve_current(params = {}, opts = {}); end - # Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are + # Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are # left unchanged. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is application, which includes Custom accounts, you can update any information on the account. # - # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) + # For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) # is stripe, which includes Standard and Express accounts, you can update all information until you create - # an [Account Link or Account Session](https://stripe.com/api/account_links) to start Connect onboarding, + # an [Account Link or Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding, # after which some properties can no longer be updated. # # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our - # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. + # [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts. sig { params(account: String, params: T.any(::Stripe::AccountService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Account) } diff --git a/rbi/stripe/services/account_session_service.rbi b/rbi/stripe/services/account_session_service.rbi index 5440de02e..f2262f09f 100644 --- a/rbi/stripe/services/account_session_service.rbi +++ b/rbi/stripe/services/account_session_service.rbi @@ -105,14 +105,49 @@ module Stripe } def initialize(enabled: nil, features: nil); end end - class Documents < Stripe::RequestParams + class DisputesList < Stripe::RequestParams class Features < Stripe::RequestParams - + # Whether to allow capturing and cancelling payment intents. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :capture_payments + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :refund_management + sig { + params(capture_payments: T.nilable(T::Boolean), destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void + } + def initialize( + capture_payments: nil, + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ); end end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled # The list of features enabled in the embedded component. + sig { + returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList::Features)) + } + attr_accessor :features + sig { + params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList::Features)).void + } + def initialize(enabled: nil, features: nil); end + end + class Documents < Stripe::RequestParams + class Features < Stripe::RequestParams; end + # Whether the embedded component is enabled. + sig { returns(T::Boolean) } + attr_accessor :enabled + # The list of features enabled in the embedded component. sig { returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents::Features)) } @@ -324,6 +359,39 @@ module Stripe } def initialize(enabled: nil, features: nil); end end + class PaymentDisputes < Stripe::RequestParams + class Features < Stripe::RequestParams + # Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :destination_on_behalf_of_charge_management + # Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :dispute_management + # Whether to allow sending refunds. This is `true` by default. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :refund_management + sig { + params(destination_on_behalf_of_charge_management: T.nilable(T::Boolean), dispute_management: T.nilable(T::Boolean), refund_management: T.nilable(T::Boolean)).void + } + def initialize( + destination_on_behalf_of_charge_management: nil, + dispute_management: nil, + refund_management: nil + ); end + end + # Whether the embedded component is enabled. + sig { returns(T::Boolean) } + attr_accessor :enabled + # The list of features enabled in the embedded component. + sig { + returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes::Features)) + } + attr_accessor :features + sig { + params(enabled: T::Boolean, features: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes::Features)).void + } + def initialize(enabled: nil, features: nil); end + end class Payments < Stripe::RequestParams class Features < Stripe::RequestParams # Whether to allow capturing and cancelling payment intents. This is `true` by default. @@ -403,9 +471,7 @@ module Stripe def initialize(enabled: nil, features: nil); end end class PayoutsList < Stripe::RequestParams - class Features < Stripe::RequestParams - - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled @@ -420,9 +486,7 @@ module Stripe def initialize(enabled: nil, features: nil); end end class TaxRegistrations < Stripe::RequestParams - class Features < Stripe::RequestParams - - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled @@ -437,9 +501,7 @@ module Stripe def initialize(enabled: nil, features: nil); end end class TaxSettings < Stripe::RequestParams - class Features < Stripe::RequestParams - - end + class Features < Stripe::RequestParams; end # Whether the embedded component is enabled. sig { returns(T::Boolean) } attr_accessor :enabled @@ -468,6 +530,11 @@ module Stripe returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances)) } attr_accessor :balances + # Configuration for the disputes list embedded component. + sig { + returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList)) + } + attr_accessor :disputes_list # Configuration for the documents embedded component. sig { returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents)) @@ -503,6 +570,11 @@ module Stripe returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails)) } attr_accessor :payment_details + # Configuration for the payment disputes embedded component. + sig { + returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes)) + } + attr_accessor :payment_disputes # Configuration for the payments embedded component. sig { returns(T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments)) @@ -529,12 +601,13 @@ module Stripe } attr_accessor :tax_settings sig { - params(account_management: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement), account_onboarding: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding), balances: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances), documents: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents), financial_account: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount), financial_account_transactions: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions), issuing_card: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard), issuing_cards_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList), notification_banner: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner), payment_details: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails), payments: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments), payouts: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts), payouts_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList), tax_registrations: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations), tax_settings: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings)).void + params(account_management: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountManagement), account_onboarding: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::AccountOnboarding), balances: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Balances), disputes_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::DisputesList), documents: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Documents), financial_account: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccount), financial_account_transactions: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::FinancialAccountTransactions), issuing_card: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCard), issuing_cards_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::IssuingCardsList), notification_banner: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::NotificationBanner), payment_details: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDetails), payment_disputes: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PaymentDisputes), payments: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payments), payouts: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::Payouts), payouts_list: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::PayoutsList), tax_registrations: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxRegistrations), tax_settings: T.nilable(::Stripe::AccountSessionService::CreateParams::Components::TaxSettings)).void } def initialize( account_management: nil, account_onboarding: nil, balances: nil, + disputes_list: nil, documents: nil, financial_account: nil, financial_account_transactions: nil, @@ -542,6 +615,7 @@ module Stripe issuing_cards_list: nil, notification_banner: nil, payment_details: nil, + payment_disputes: nil, payments: nil, payouts: nil, payouts_list: nil, diff --git a/rbi/stripe/services/apple_pay_domain_service.rbi b/rbi/stripe/services/apple_pay_domain_service.rbi index bbdd3a6f4..5950d9a90 100644 --- a/rbi/stripe/services/apple_pay_domain_service.rbi +++ b/rbi/stripe/services/apple_pay_domain_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class ApplePayDomainService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/balance_service.rbi b/rbi/stripe/services/balance_service.rbi index 9021decac..2aa45b301 100644 --- a/rbi/stripe/services/balance_service.rbi +++ b/rbi/stripe/services/balance_service.rbi @@ -12,7 +12,7 @@ module Stripe def initialize(expand: nil); end end # Retrieves the current account balance, based on the authentication that was used to make the request. - # For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances). + # For a sample request, see [Accounting for negative balances](https://docs.stripe.com/docs/connect/account-balances#accounting-for-negative-balances). sig { params(params: T.any(::Stripe::BalanceService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Balance) } diff --git a/rbi/stripe/services/billing/alert_service.rbi b/rbi/stripe/services/billing/alert_service.rbi index 29bf1e677..eeb58b5d5 100644 --- a/rbi/stripe/services/billing/alert_service.rbi +++ b/rbi/stripe/services/billing/alert_service.rbi @@ -57,13 +57,13 @@ module Stripe sig { returns(Integer) } attr_accessor :gte # The [Billing Meter](/api/billing/meter) ID whose usage is monitored. - sig { returns(T.nilable(String)) } + sig { returns(String) } attr_accessor :meter # Whether the alert should only fire only once, or once per billing cycle. sig { returns(String) } attr_accessor :recurrence sig { - params(filters: T.nilable(T::Array[::Stripe::Billing::AlertService::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: T.nilable(String), recurrence: String).void + params(filters: T.nilable(T::Array[::Stripe::Billing::AlertService::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: String, recurrence: String).void } def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil); end end diff --git a/rbi/stripe/services/charge_service.rbi b/rbi/stripe/services/charge_service.rbi index 11a254c85..2804be97f 100644 --- a/rbi/stripe/services/charge_service.rbi +++ b/rbi/stripe/services/charge_service.rbi @@ -402,15 +402,15 @@ module Stripe end # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false. # - # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. + # Uncaptured payments expire a set number of days after they are created ([7 by default](https://docs.stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail. # - # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture). + # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/capture). sig { params(charge: String, params: T.any(::Stripe::ChargeService::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Charge) } def capture(charge, params = {}, opts = {}); end - # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents) + # This method is no longer recommended—use the [Payment Intents API](https://docs.stripe.com/docs/api/payment_intents) # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge # object used to request payment. sig { @@ -430,7 +430,7 @@ module Stripe } def retrieve(charge, params = {}, opts = {}); end - # Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for charges you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/rbi/stripe/services/checkout/session_service.rbi b/rbi/stripe/services/checkout/session_service.rbi index 5c86f461a..013e6e01c 100644 --- a/rbi/stripe/services/checkout/session_service.rbi +++ b/rbi/stripe/services/checkout/session_service.rbi @@ -1322,9 +1322,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds will be captured from the customer's account. sig { returns(T.nilable(String)) } @@ -1785,13 +1783,20 @@ module Stripe # 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. sig { returns(T.nilable(T::Array[String])) } attr_accessor :allow_redisplay_filters + # Enable customers to choose if they wish to remove their saved payment methods. Disabled by default. + sig { returns(T.nilable(String)) } + attr_accessor :payment_method_remove # Enable customers to choose if they wish to save their payment method for future use. Disabled by default. sig { returns(T.nilable(String)) } attr_accessor :payment_method_save sig { - params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_save: T.nilable(String)).void + params(allow_redisplay_filters: T.nilable(T::Array[String]), payment_method_remove: T.nilable(String), payment_method_save: T.nilable(String)).void } - def initialize(allow_redisplay_filters: nil, payment_method_save: nil); end + def initialize( + allow_redisplay_filters: nil, + payment_method_remove: nil, + payment_method_save: nil + ); end end class SetupIntentData < Stripe::RequestParams # An arbitrary string attached to the object. Often useful for displaying to users. @@ -2598,6 +2603,8 @@ module Stripe def retrieve(session, params = {}, opts = {}); end # Updates a Checkout Session object. + # + # Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates) sig { params(session: String, params: T.any(::Stripe::Checkout::SessionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Checkout::Session) } diff --git a/rbi/stripe/services/coupon_service.rbi b/rbi/stripe/services/coupon_service.rbi index 248cf71dc..3467ae51e 100644 --- a/rbi/stripe/services/coupon_service.rbi +++ b/rbi/stripe/services/coupon_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class CouponService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/credit_note_service.rbi b/rbi/stripe/services/credit_note_service.rbi index 966de8f11..6e2f2f2fb 100644 --- a/rbi/stripe/services/credit_note_service.rbi +++ b/rbi/stripe/services/credit_note_service.rbi @@ -364,20 +364,19 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end - # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces - # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result - # in any combination of the following: + # 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. + # 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: # # - # Refund: create a new refund (using refund_amount) or link an existing refund (using refund). + # Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds). # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized. # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount). # # - # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total. + # The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount. # - # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount - # or post_payment_credit_notes_amount depending on its status at the time of credit note creation. + # You may issue multiple credit notes for an invoice. Each credit note may increment the invoice's pre_payment_credit_notes_amount, + # post_payment_credit_notes_amount, or both, depending on the invoice's amount_remaining at the time of credit note creation. sig { params(params: T.any(::Stripe::CreditNoteService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote) } @@ -407,7 +406,7 @@ module Stripe } def update(id, params = {}, opts = {}); end - # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + # Marks a credit note as void. Learn more about [voiding credit notes](https://docs.stripe.com/docs/billing/invoices/credit-notes#voiding). sig { params(id: String, params: T.any(::Stripe::CreditNoteService::VoidCreditNoteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CreditNote) } diff --git a/rbi/stripe/services/customer_balance_transaction_service.rbi b/rbi/stripe/services/customer_balance_transaction_service.rbi index e48fdc9e9..96af3807b 100644 --- a/rbi/stripe/services/customer_balance_transaction_service.rbi +++ b/rbi/stripe/services/customer_balance_transaction_service.rbi @@ -65,19 +65,19 @@ module Stripe } def initialize(description: nil, expand: nil, metadata: nil); end end - # Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance). + # Creates an immutable transaction that updates the customer's credit [balance](https://docs.stripe.com/docs/billing/customer/balance). sig { params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction) } def create(customer, params = {}, opts = {}); end - # Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance). + # Returns a list of transactions that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance). sig { params(customer: String, params: T.any(::Stripe::CustomerBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } def list(customer, params = {}, opts = {}); end - # Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance). + # Retrieves a specific customer balance transaction that updated the customer's [balances](https://docs.stripe.com/docs/billing/customer/balance). sig { params(customer: String, transaction: String, params: T.any(::Stripe::CustomerBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerBalanceTransaction) } diff --git a/rbi/stripe/services/customer_cash_balance_transaction_service.rbi b/rbi/stripe/services/customer_cash_balance_transaction_service.rbi index 8814a7dc5..56892fecd 100644 --- a/rbi/stripe/services/customer_cash_balance_transaction_service.rbi +++ b/rbi/stripe/services/customer_cash_balance_transaction_service.rbi @@ -29,13 +29,13 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end - # Returns a list of transactions that modified the customer's [cash balance](https://stripe.com/docs/payments/customer-balance). + # Returns a list of transactions that modified the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance). sig { params(customer: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } def list(customer, params = {}, opts = {}); end - # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://stripe.com/docs/payments/customer-balance). + # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://docs.stripe.com/docs/payments/customer-balance). sig { params(customer: String, transaction: String, params: T.any(::Stripe::CustomerCashBalanceTransactionService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerCashBalanceTransaction) } diff --git a/rbi/stripe/services/customer_payment_source_service.rbi b/rbi/stripe/services/customer_payment_source_service.rbi index efe721c05..a0519a864 100644 --- a/rbi/stripe/services/customer_payment_source_service.rbi +++ b/rbi/stripe/services/customer_payment_source_service.rbi @@ -193,7 +193,7 @@ module Stripe # # If the card's owner has no default card, then the new card will become the default. # However, if the owner already has a default, then it will not change. - # To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source. + # To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source. sig { 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)) } diff --git a/rbi/stripe/services/customer_service.rbi b/rbi/stripe/services/customer_service.rbi index ecdb4bc56..8b7824bee 100644 --- a/rbi/stripe/services/customer_service.rbi +++ b/rbi/stripe/services/customer_service.rbi @@ -11,9 +11,7 @@ module Stripe attr_reader :tax_ids attr_reader :payment_methods attr_reader :funding_instructions - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -267,9 +265,7 @@ module Stripe validate: nil ); end end - class DeleteDiscountParams < Stripe::RequestParams - - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class Created < Stripe::RequestParams # Minimum value to filter by (exclusive) @@ -631,7 +627,7 @@ module Stripe } def retrieve(customer, params = {}, opts = {}); end - # Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for customers you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/rbi/stripe/services/customer_tax_id_service.rbi b/rbi/stripe/services/customer_tax_id_service.rbi index efb27fd3b..c7a922793 100644 --- a/rbi/stripe/services/customer_tax_id_service.rbi +++ b/rbi/stripe/services/customer_tax_id_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class CustomerTaxIdService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/dispute_service.rbi b/rbi/stripe/services/dispute_service.rbi index 8e72c1404..35bd072f3 100644 --- a/rbi/stripe/services/dispute_service.rbi +++ b/rbi/stripe/services/dispute_service.rbi @@ -415,7 +415,7 @@ module Stripe # 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. # - # 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). + # 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). sig { params(dispute: String, params: T.any(::Stripe::DisputeService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Dispute) } diff --git a/rbi/stripe/services/file_service.rbi b/rbi/stripe/services/file_service.rbi index 5482889d6..d70d802ed 100644 --- a/rbi/stripe/services/file_service.rbi +++ b/rbi/stripe/services/file_service.rbi @@ -107,7 +107,7 @@ module Stripe } def list(params = {}, opts = {}); end - # 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). + # 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). sig { params(file: String, params: T.any(::Stripe::FileService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File) } diff --git a/rbi/stripe/services/identity/verification_session_service.rbi b/rbi/stripe/services/identity/verification_session_service.rbi index 534e3301a..781925602 100644 --- a/rbi/stripe/services/identity/verification_session_service.rbi +++ b/rbi/stripe/services/identity/verification_session_service.rbi @@ -251,9 +251,9 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end - # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work). + # A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work). # - # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel). + # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel). sig { params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } @@ -265,7 +265,7 @@ module Stripe # # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode. # - # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents) + # Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents) sig { params(params: T.any(::Stripe::Identity::VerificationSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } @@ -282,7 +282,7 @@ module Stripe # request logs, etc. # # A VerificationSession object can be redacted when it is in requires_input or verified - # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action + # [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action # state will automatically cancel it. # # The redaction process may take up to four days. When the redaction process is in progress, the @@ -295,7 +295,7 @@ module Stripe # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or # used for any purpose. # - # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact). + # [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact). sig { params(session: String, params: T.any(::Stripe::Identity::VerificationSessionService::RedactParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Identity::VerificationSession) } diff --git a/rbi/stripe/services/invoice_item_service.rbi b/rbi/stripe/services/invoice_item_service.rbi index c029dba57..eb595ed24 100644 --- a/rbi/stripe/services/invoice_item_service.rbi +++ b/rbi/stripe/services/invoice_item_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class InvoiceItemService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/invoice_service.rbi b/rbi/stripe/services/invoice_service.rbi index 08ebbcf99..f2560737e 100644 --- a/rbi/stripe/services/invoice_service.rbi +++ b/rbi/stripe/services/invoice_service.rbi @@ -5,9 +5,7 @@ module Stripe class InvoiceService < StripeService attr_reader :line_items - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -185,12 +183,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -883,12 +877,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -1584,6 +1574,16 @@ module Stripe } def initialize(expand: nil, invoice_metadata: nil, lines: nil); end end + class AttachPaymentParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + # The ID of the PaymentIntent to attach to the invoice. + sig { returns(T.nilable(String)) } + attr_accessor :payment_intent + sig { params(expand: T.nilable(T::Array[String]), payment_intent: T.nilable(String)).void } + def initialize(expand: nil, payment_intent: nil); end + end class FinalizeInvoiceParams < Stripe::RequestParams # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. sig { returns(T.nilable(T::Boolean)) } @@ -2314,6 +2314,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -2357,6 +2369,13 @@ module Stripe def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -2415,6 +2434,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount])))) @@ -2441,9 +2465,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -2479,6 +2504,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -2521,7 +2551,7 @@ module Stripe # The account on behalf of which to charge, for each of the associated subscription's invoices. sig { returns(T.nilable(String)) } attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. @@ -2539,13 +2569,14 @@ module Stripe sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :trial_end sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::InvoiceSettings), items: T::Array[::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::ScheduleDetails::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -2583,6 +2614,13 @@ module Stripe end class SubscriptionDetails < Stripe::RequestParams class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -2641,6 +2679,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. sig { returns(T.nilable(T::Boolean)) } attr_accessor :clear_usage @@ -2676,9 +2719,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::BillingThresholds))), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::InvoiceService::CreatePreviewParams::SubscriptionDetails::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -2697,7 +2741,7 @@ module Stripe # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # This simulates the subscription being canceled or expired immediately. @@ -2815,7 +2859,22 @@ module Stripe } def add_lines(invoice, params = {}, opts = {}); end - # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. + # + # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited + # to the invoice, increasing its amount_paid. When the invoice is fully paid, the + # invoice's status becomes paid. + # + # If the PaymentIntent's status is already succeeded when it's attached, it's + # credited to the invoice immediately. + # + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. + sig { + params(invoice: String, params: T.any(::Stripe::InvoiceService::AttachPaymentParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) + } + def attach_payment(invoice, params = {}, opts = {}); end + + # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers. sig { params(params: T.any(::Stripe::InvoiceService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } @@ -2823,9 +2882,11 @@ module Stripe # At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. # - # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. + # You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. # - # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request. + # The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true. + # + # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount. # # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions) sig { @@ -2833,7 +2894,7 @@ module Stripe } def create_preview(params = {}, opts = {}); end - # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice). + # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice). sig { params(invoice: String, params: T.any(::Stripe::InvoiceService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } @@ -2875,7 +2936,7 @@ module Stripe } def retrieve(invoice, params = {}, opts = {}); end - # Search for invoices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for invoices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. @@ -2892,11 +2953,11 @@ module Stripe } def send_invoice(invoice, params = {}, opts = {}); end - # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized), + # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized), # monetary values, as well as collection_method, become uneditable. # # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, - # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass + # sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass # auto_advance=false. sig { params(invoice: String, params: T.any(::Stripe::InvoiceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) @@ -2909,9 +2970,9 @@ module Stripe } def update_lines(invoice, params = {}, opts = {}); end - # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. + # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. # - # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. + # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business. sig { params(invoice: String, params: T.any(::Stripe::InvoiceService::VoidInvoiceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Invoice) } diff --git a/rbi/stripe/services/issuing/authorization_service.rbi b/rbi/stripe/services/issuing/authorization_service.rbi index d3f679e87..4ca654f7e 100644 --- a/rbi/stripe/services/issuing/authorization_service.rbi +++ b/rbi/stripe/services/issuing/authorization_service.rbi @@ -110,15 +110,15 @@ module Stripe } def initialize(expand: nil, metadata: nil); end end - # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). sig { params(authorization: String, params: T.any(::Stripe::Issuing::AuthorizationService::ApproveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization) } def approve(authorization, params = {}, opts = {}); end - # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow. - # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). + # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow. + # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling). sig { params(authorization: String, params: T.any(::Stripe::Issuing::AuthorizationService::DeclineParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Authorization) } diff --git a/rbi/stripe/services/issuing/card_service.rbi b/rbi/stripe/services/issuing/card_service.rbi index a7a507658..8119d112c 100644 --- a/rbi/stripe/services/issuing/card_service.rbi +++ b/rbi/stripe/services/issuing/card_service.rbi @@ -229,7 +229,7 @@ module Stripe # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } attr_accessor :expand - # Attribute for param field financial_account + # The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account. sig { returns(T.nilable(String)) } attr_accessor :financial_account # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. diff --git a/rbi/stripe/services/issuing/dispute_service.rbi b/rbi/stripe/services/issuing/dispute_service.rbi index 8b2886768..49db78856 100644 --- a/rbi/stripe/services/issuing/dispute_service.rbi +++ b/rbi/stripe/services/issuing/dispute_service.rbi @@ -673,7 +673,7 @@ module Stripe } def initialize(expand: nil, metadata: nil); end end - # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. + # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements. sig { params(params: T.any(::Stripe::Issuing::DisputeService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute) } @@ -691,7 +691,7 @@ module Stripe } def retrieve(dispute, params = {}, opts = {}); end - # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). + # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence). sig { params(dispute: String, params: T.any(::Stripe::Issuing::DisputeService::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Issuing::Dispute) } diff --git a/rbi/stripe/services/payment_intent_service.rbi b/rbi/stripe/services/payment_intent_service.rbi index 77b4c5d8f..98bdabdf9 100644 --- a/rbi/stripe/services/payment_intent_service.rbi +++ b/rbi/stripe/services/payment_intent_service.rbi @@ -70,9 +70,7 @@ module Stripe end class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(String) } @@ -130,21 +128,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -165,12 +153,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -225,9 +209,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -235,12 +217,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -258,12 +236,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -271,12 +245,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -301,21 +271,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -354,9 +314,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -364,24 +322,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -389,15 +335,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -412,12 +352,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -445,12 +381,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentIntentService::CreateParams::PaymentMethodData::AcssDebit)) @@ -1477,9 +1409,7 @@ module Stripe sig { params(setup_future_usage: T.nilable(T.nilable(T.any(String, String)))).void } def initialize(setup_future_usage: nil); end end - class InteracPresent < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -1734,9 +1664,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -1869,6 +1797,17 @@ module Stripe sig { params(capture_method: T.nilable(T.nilable(String))).void } def initialize(capture_method: nil); end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + sig { returns(T.nilable(T.nilable(String))) } + attr_accessor :capture_method + sig { params(capture_method: T.nilable(T.nilable(String))).void } + def initialize(capture_method: nil); end + end class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -2289,6 +2228,11 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay)))) } attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Satispay)))) + } + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. sig { returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit)))) @@ -2325,7 +2269,7 @@ module Stripe } attr_accessor :zip sig { - params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Zip)))).void + params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SamsungPay))), satispay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Satispay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::CreateParams::PaymentMethodOptions::Zip)))).void } def initialize( acss_debit: nil, @@ -2369,6 +2313,7 @@ module Stripe promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -2520,6 +2465,8 @@ module Stripe # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent. # # If you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. + # If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://stripe.com/docs/api#create_payment_intent-customer) parameter of this PaymentIntent. + # end sig { returns(T.nilable(String)) } attr_accessor :payment_method # The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. @@ -2640,21 +2587,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -2675,12 +2612,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -2735,9 +2668,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -2745,12 +2676,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2768,12 +2695,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -2781,12 +2704,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -2811,21 +2730,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -2864,9 +2773,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2874,24 +2781,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -2899,15 +2794,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -2922,12 +2811,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -2955,12 +2840,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentIntentService::UpdateParams::PaymentMethodData::AcssDebit)) @@ -3987,9 +3868,7 @@ module Stripe sig { params(setup_future_usage: T.nilable(T.nilable(T.any(String, String)))).void } def initialize(setup_future_usage: nil); end end - class InteracPresent < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -4244,9 +4123,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -4379,6 +4256,17 @@ module Stripe sig { params(capture_method: T.nilable(T.nilable(String))).void } def initialize(capture_method: nil); end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + sig { returns(T.nilable(T.nilable(String))) } + attr_accessor :capture_method + sig { params(capture_method: T.nilable(T.nilable(String))).void } + def initialize(capture_method: nil); end + end class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -4799,6 +4687,11 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay)))) } attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Satispay)))) + } + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. sig { returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit)))) @@ -4835,7 +4728,7 @@ module Stripe } attr_accessor :zip sig { - params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Zip)))).void + params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SamsungPay))), satispay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Satispay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::UpdateParams::PaymentMethodOptions::Zip)))).void } def initialize( acss_debit: nil, @@ -4879,6 +4772,7 @@ module Stripe promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -5152,9 +5046,7 @@ module Stripe class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(T.nilable(String)) } @@ -5212,21 +5104,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -5247,12 +5129,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -5307,9 +5185,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -5317,12 +5193,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -5340,12 +5212,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -5353,12 +5221,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -5383,21 +5247,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -5436,9 +5290,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -5446,24 +5298,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -5471,15 +5311,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -5494,12 +5328,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -5527,12 +5357,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodData::AcssDebit)) @@ -6559,9 +6385,7 @@ module Stripe sig { params(setup_future_usage: T.nilable(T.nilable(T.any(String, String)))).void } def initialize(setup_future_usage: nil); end end - class InteracPresent < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end class KakaoPay < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -6816,9 +6640,7 @@ module Stripe } def initialize(setup_future_usage: nil, tos_shown_and_accepted: nil); end end - class PayByBank < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end class Payco < Stripe::RequestParams # Controls when the funds are captured from the customer's account. # @@ -6951,6 +6773,17 @@ module Stripe sig { params(capture_method: T.nilable(T.nilable(String))).void } def initialize(capture_method: nil); end end + class Satispay < Stripe::RequestParams + # Controls when the funds are captured from the customer's account. + # + # If provided, this parameter overrides the behavior of the top-level [capture_method](/api/payment_intents/update#update_payment_intent-capture_method) for this payment method type when finalizing the payment with this payment method type. + # + # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type. + sig { returns(T.nilable(T.nilable(String))) } + attr_accessor :capture_method + sig { params(capture_method: T.nilable(T.nilable(String))).void } + def initialize(capture_method: nil); end + end class SepaDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. @@ -7371,6 +7204,11 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay)))) } attr_accessor :samsung_pay + # If this is a `satispay` PaymentMethod, this sub-hash contains details about the Satispay payment method options. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Satispay)))) + } + attr_accessor :satispay # If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options. sig { returns(T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit)))) @@ -7407,7 +7245,7 @@ module Stripe } attr_accessor :zip sig { - params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Zip)))).void + params(acss_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AcssDebit))), affirm: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Affirm))), afterpay_clearpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AfterpayClearpay))), alipay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alipay))), alma: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Alma))), amazon_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AmazonPay))), au_becs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::AuBecsDebit))), bacs_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::BacsDebit))), bancontact: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Bancontact))), billie: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Billie))), blik: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Blik))), boleto: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Boleto))), card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Card))), card_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CardPresent))), cashapp: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Cashapp))), customer_balance: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::CustomerBalance))), eps: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Eps))), fpx: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Fpx))), giropay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Giropay))), grabpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Grabpay))), ideal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Ideal))), interac_present: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::InteracPresent))), kakao_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KakaoPay))), klarna: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Klarna))), konbini: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Konbini))), kr_card: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::KrCard))), link: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Link))), mobilepay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Mobilepay))), multibanco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Multibanco))), naver_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NaverPay))), nz_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::NzBankAccount))), oxxo: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Oxxo))), p24: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::P24))), pay_by_bank: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::PayByBank))), payco: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Payco))), paynow: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paynow))), paypal: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Paypal))), pix: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Pix))), promptpay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Promptpay))), revolut_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::RevolutPay))), samsung_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SamsungPay))), satispay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Satispay))), sepa_debit: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::SepaDebit))), sofort: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Sofort))), swish: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Swish))), twint: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Twint))), us_bank_account: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::UsBankAccount))), wechat_pay: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::WechatPay))), zip: T.nilable(T.nilable(T.any(String, ::Stripe::PaymentIntentService::ConfirmParams::PaymentMethodOptions::Zip)))).void } def initialize( acss_debit: nil, @@ -7451,6 +7289,7 @@ module Stripe promptpay: nil, revolut_pay: nil, samsung_pay: nil, + satispay: nil, sepa_debit: nil, sofort: nil, swish: nil, @@ -7545,6 +7384,7 @@ module Stripe sig { returns(T.nilable(T.any(T::Boolean, String))) } attr_accessor :off_session # ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + # If the payment method is attached to a Customer, it must match the [customer](https://stripe.com/docs/api#create_payment_intent-customer) that is set on this PaymentIntent. sig { returns(T.nilable(String)) } attr_accessor :payment_method # If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear @@ -7679,11 +7519,11 @@ module Stripe } def apply_customer_balance(intent, params = {}, opts = {}); end - # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://stripe.com/docs/payments/intents), processing. + # You can cancel a PaymentIntent object when it's in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, [in rare cases](https://docs.stripe.com/docs/payments/intents), processing. # # After it's canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded. # - # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # You can't cancel the PaymentIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. sig { params(intent: String, params: T.any(::Stripe::PaymentIntentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -7693,7 +7533,7 @@ module Stripe # # Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation. # - # Learn more about [separate authorization and capture](https://stripe.com/docs/payments/capture-later). + # Learn more about [separate authorization and capture](https://docs.stripe.com/docs/payments/capture-later). sig { params(intent: String, params: T.any(::Stripe::PaymentIntentService::CaptureParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -7710,8 +7550,8 @@ module Stripe # payment succeeds, the PaymentIntent will transition to the succeeded # status (or requires_capture, if capture_method is set to manual). # If the confirmation_method is automatic, payment may be attempted - # using our [client SDKs](https://stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) - # and the PaymentIntent's [client_secret](https://stripe.com/docs/api#payment_intent_object-client_secret). + # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment) + # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret). # After next_actions are handled by the client, no additional # confirmation is required to complete the payment. # If the confirmation_method is manual, all payment attempts must be @@ -7731,13 +7571,13 @@ module Stripe # Creates a PaymentIntent object. # - # After the PaymentIntent is created, attach a payment method and [confirm](https://stripe.com/docs/api/payment_intents/confirm) + # After the PaymentIntent is created, attach a payment method and [confirm](https://docs.stripe.com/docs/api/payment_intents/confirm) # to continue the payment. Learn more about the available payment flows # with the Payment Intents API. # # When you use confirm=true during creation, it's equivalent to creating # and confirming the PaymentIntent in the same call. You can use any parameters - # available in the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) when you supply + # available in the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) when you supply # confirm=true. sig { params(params: T.any(::Stripe::PaymentIntentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) @@ -7745,9 +7585,9 @@ module Stripe def create(params = {}, opts = {}); end # Perform an incremental authorization on an eligible - # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the + # [PaymentIntent](https://docs.stripe.com/docs/api/payment_intents/object). To be eligible, the # PaymentIntent's status must be requires_capture and - # [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + # [incremental_authorization_supported](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) # must be true. # # Incremental authorizations attempt to increase the authorized amount on @@ -7758,16 +7598,16 @@ module Stripe # # If the incremental authorization succeeds, the PaymentIntent object # returns with the updated - # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). + # [amount](https://docs.stripe.com/docs/api/payment_intents/object#payment_intent_object-amount). # If the incremental authorization fails, a - # [card_declined](https://stripe.com/docs/error-codes#card-declined) error returns, and no other + # [card_declined](https://docs.stripe.com/docs/error-codes#card-declined) error returns, and no other # fields on the PaymentIntent or Charge update. The PaymentIntent # object remains capturable for the previously authorized amount. # # Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. # After it's captured, a PaymentIntent can no longer be incremented. # - # Learn more about [incremental authorizations](https://stripe.com/docs/terminal/features/incremental-authorizations). + # Learn more about [incremental authorizations](https://docs.stripe.com/docs/terminal/features/incremental-authorizations). sig { params(intent: String, params: T.any(::Stripe::PaymentIntentService::IncrementAuthorizationParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } @@ -7783,13 +7623,13 @@ module Stripe # # You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string. # - # If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the [payment intent](https://stripe.com/docs/api#payment_intent_object) object reference for more details. + # If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the [payment intent](https://docs.stripe.com/api#payment_intent_object) object reference for more details. sig { params(intent: String, params: T.any(::Stripe::PaymentIntentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } def retrieve(intent, params = {}, opts = {}); end - # Search for PaymentIntents you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for PaymentIntents you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. @@ -7804,7 +7644,7 @@ module Stripe # PaymentIntent again. For example, updating the payment_method # always requires you to confirm the PaymentIntent again. If you prefer to # update and confirm at the same time, we recommend updating properties through - # the [confirm API](https://stripe.com/docs/api/payment_intents/confirm) instead. + # the [confirm API](https://docs.stripe.com/docs/api/payment_intents/confirm) instead. sig { params(intent: String, params: T.any(::Stripe::PaymentIntentService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentIntent) } diff --git a/rbi/stripe/services/payment_method_configuration_service.rbi b/rbi/stripe/services/payment_method_configuration_service.rbi index efcd4b883..2d1caae97 100644 --- a/rbi/stripe/services/payment_method_configuration_service.rbi +++ b/rbi/stripe/services/payment_method_configuration_service.rbi @@ -482,6 +482,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -518,6 +536,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -572,6 +608,24 @@ module Stripe } def initialize(display_preference: nil); end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -644,6 +698,24 @@ module Stripe } def initialize(display_preference: nil); end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -734,6 +806,24 @@ module Stripe } def initialize(display_preference: nil); end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -902,7 +992,7 @@ module Stripe returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay)) } attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay)) } @@ -978,12 +1068,20 @@ module Stripe # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb)) } attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay)) + } + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna)) } attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini)) } attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard)) } + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link)) } attr_accessor :link @@ -1000,6 +1098,11 @@ module Stripe # Configuration name. sig { returns(T.nilable(String)) } attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay)) + } + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount)) @@ -1019,6 +1122,9 @@ module Stripe returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank)) } attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco)) } + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow)) } attr_accessor :paynow @@ -1038,6 +1144,11 @@ module Stripe returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay)) } attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay)) + } + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay)) @@ -1071,7 +1182,7 @@ module Stripe sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip)) } attr_accessor :zip sig { - params(acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb), klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini), link: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco), name: T.nilable(String), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24), parent: T.nilable(String), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank), paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay), satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip)).void + params(acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AcssDebit), affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::P24), parent: T.nilable(String), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfigurationService::CreateParams::Zip)).void } def initialize( acss_debit: nil, @@ -1100,22 +1211,27 @@ module Stripe grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, parent: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, @@ -1584,6 +1700,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KakaoPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Klarna < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1620,6 +1754,24 @@ module Stripe } def initialize(display_preference: nil); end end + class KrCard < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Link < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1674,6 +1826,24 @@ module Stripe } def initialize(display_preference: nil); end end + class NaverPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class NzBankAccount < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1746,6 +1916,24 @@ module Stripe } def initialize(display_preference: nil); end end + class Payco < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Paynow < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -1836,6 +2024,24 @@ module Stripe } def initialize(display_preference: nil); end end + class SamsungPay < Stripe::RequestParams + class DisplayPreference < Stripe::RequestParams + # The account's preference for whether or not to display this payment method. + sig { returns(T.nilable(String)) } + attr_accessor :preference + sig { params(preference: T.nilable(String)).void } + def initialize(preference: nil); end + end + # Whether or not the payment method should be displayed. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay::DisplayPreference)) + } + attr_accessor :display_preference + sig { + params(display_preference: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay::DisplayPreference)).void + } + def initialize(display_preference: nil); end + end class Satispay < Stripe::RequestParams class DisplayPreference < Stripe::RequestParams # The account's preference for whether or not to display this payment method. @@ -2007,7 +2213,7 @@ module Stripe returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay)) } attr_accessor :amazon_pay - # Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + # Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay)) } @@ -2083,12 +2289,20 @@ module Stripe # JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb)) } attr_accessor :jcb + # Kakao Pay is a popular local wallet available in South Korea. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay)) + } + attr_accessor :kakao_pay # Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna)) } attr_accessor :klarna # Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini)) } attr_accessor :konbini + # Korean cards let users pay using locally issued cards from South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard)) } + attr_accessor :kr_card # [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link)) } attr_accessor :link @@ -2105,6 +2319,11 @@ module Stripe # Configuration name. sig { returns(T.nilable(String)) } attr_accessor :name + # Naver Pay is a popular local wallet available in South Korea. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay)) + } + attr_accessor :naver_pay # Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount)) @@ -2121,6 +2340,9 @@ module Stripe returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank)) } attr_accessor :pay_by_bank + # PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco)) } + attr_accessor :payco # PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow)) } attr_accessor :paynow @@ -2140,6 +2362,11 @@ module Stripe returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay)) } attr_accessor :revolut_pay + # Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + sig { + returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay)) + } + attr_accessor :samsung_pay # Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay)) @@ -2173,7 +2400,7 @@ module Stripe sig { returns(T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip)) } attr_accessor :zip sig { - params(acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit), active: T.nilable(T::Boolean), affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb), klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini), link: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco), name: T.nilable(String), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank), paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay), satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip)).void + params(acss_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AcssDebit), active: T.nilable(T::Boolean), affirm: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Affirm), afterpay_clearpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AfterpayClearpay), alipay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alipay), alma: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Alma), amazon_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AmazonPay), apple_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePay), apple_pay_later: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::ApplePayLater), au_becs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::AuBecsDebit), bacs_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::BacsDebit), bancontact: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Bancontact), billie: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Billie), blik: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Blik), boleto: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Boleto), card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Card), cartes_bancaires: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CartesBancaires), cashapp: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Cashapp), customer_balance: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::CustomerBalance), eps: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Eps), expand: T.nilable(T::Array[String]), fpx: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Fpx), giropay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Giropay), google_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::GooglePay), grabpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Grabpay), ideal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Ideal), jcb: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Jcb), kakao_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KakaoPay), klarna: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Klarna), konbini: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Konbini), kr_card: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::KrCard), link: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Link), mobilepay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Mobilepay), multibanco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Multibanco), name: T.nilable(String), naver_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NaverPay), nz_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::NzBankAccount), oxxo: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Oxxo), p24: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::P24), pay_by_bank: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::PayByBank), payco: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Payco), paynow: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paynow), paypal: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Paypal), pix: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Pix), promptpay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Promptpay), revolut_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::RevolutPay), samsung_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SamsungPay), satispay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Satispay), sepa_debit: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::SepaDebit), sofort: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Sofort), swish: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Swish), twint: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Twint), us_bank_account: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::UsBankAccount), wechat_pay: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::WechatPay), zip: T.nilable(::Stripe::PaymentMethodConfigurationService::UpdateParams::Zip)).void } def initialize( acss_debit: nil, @@ -2203,21 +2430,26 @@ module Stripe grabpay: nil, ideal: nil, jcb: nil, + kakao_pay: nil, klarna: nil, konbini: nil, + kr_card: nil, link: nil, mobilepay: nil, multibanco: nil, name: nil, + naver_pay: nil, nz_bank_account: nil, oxxo: nil, p24: nil, pay_by_bank: nil, + payco: nil, paynow: nil, paypal: nil, pix: nil, promptpay: nil, revolut_pay: nil, + samsung_pay: nil, satispay: nil, sepa_debit: nil, sofort: nil, diff --git a/rbi/stripe/services/payment_method_domain_service.rbi b/rbi/stripe/services/payment_method_domain_service.rbi index ccd976523..c8f532f9b 100644 --- a/rbi/stripe/services/payment_method_domain_service.rbi +++ b/rbi/stripe/services/payment_method_domain_service.rbi @@ -103,7 +103,7 @@ module Stripe # # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint. # - # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + # Related guides: [Payment method domains](https://docs.stripe.com/docs/payments/payment-methods/pmd-registration). sig { params(payment_method_domain: String, params: T.any(::Stripe::PaymentMethodDomainService::ValidateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethodDomain) } diff --git a/rbi/stripe/services/payment_method_service.rbi b/rbi/stripe/services/payment_method_service.rbi index a25bd66c2..02a9bdf04 100644 --- a/rbi/stripe/services/payment_method_service.rbi +++ b/rbi/stripe/services/payment_method_service.rbi @@ -51,21 +51,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -86,12 +76,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -146,9 +132,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -194,12 +178,8 @@ module Stripe token: nil ); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -217,12 +197,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -230,12 +206,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -258,21 +230,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -311,9 +273,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -321,24 +281,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -346,15 +294,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -369,12 +311,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -402,12 +340,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::PaymentMethodService::CreateParams::AcssDebit)) } attr_accessor :acss_debit @@ -722,12 +656,8 @@ module Stripe } def initialize(exp_month: nil, exp_year: nil, networks: nil); end end - class Link < Stripe::RequestParams - - end - class PayByBank < Stripe::RequestParams - - end + class Link < Stripe::RequestParams; end + class PayByBank < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Bank account holder type. sig { returns(T.nilable(String)) } @@ -795,25 +725,25 @@ module Stripe end # Attaches a PaymentMethod object to a Customer. # - # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://stripe.com/docs/api/setup_intents) - # or a PaymentIntent with [setup_future_usage](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). + # To attach a new PaymentMethod to a customer for future payments, we recommend you use a [SetupIntent](https://docs.stripe.com/docs/api/setup_intents) + # or a PaymentIntent with [setup_future_usage](https://docs.stripe.com/docs/api/payment_intents/create#create_payment_intent-setup_future_usage). # These approaches will perform any necessary steps to set up the PaymentMethod for future payments. Using the /v1/payment_methods/:id/attach # endpoint without first using a SetupIntent or PaymentIntent with setup_future_usage does not optimize the PaymentMethod for # future use, which makes later declines and payment friction more likely. - # See [Optimizing cards for future payments](https://stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up + # See [Optimizing cards for future payments](https://docs.stripe.com/docs/payments/payment-intents#future-usage) for more information about setting up # future payments. # # To use this PaymentMethod as the default for invoice or subscription payments, - # set [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), + # set [invoice_settings.default_payment_method](https://docs.stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method), # on the Customer to the PaymentMethod's ID. sig { params(payment_method: String, params: T.any(::Stripe::PaymentMethodService::AttachParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod) } def attach(payment_method, params = {}, opts = {}); end - # Creates a PaymentMethod object. Read the [Stripe.js reference](https://stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. + # Creates a PaymentMethod object. Read the [Stripe.js reference](https://docs.stripe.com/docs/stripe-js/reference#stripe-create-payment-method) to learn how to create PaymentMethods via Stripe.js. # - # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. + # Instead of creating a PaymentMethod directly, we recommend using the [PaymentIntents API to accept a payment immediately or the SetupIntent](https://docs.stripe.com/docs/payments/accept-a-payment) API to collect payment method details ahead of a future payment. sig { params(params: T.any(::Stripe::PaymentMethodService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod) } @@ -825,13 +755,13 @@ module Stripe } def detach(payment_method, params = {}, opts = {}); end - # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer_list) API instead. + # Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the [List a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer_list) API instead. sig { params(params: T.any(::Stripe::PaymentMethodService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } def list(params = {}, opts = {}); end - # Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://stripe.com/docs/api/payment_methods/customer) + # Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use [Retrieve a Customer's PaymentMethods](https://docs.stripe.com/docs/api/payment_methods/customer) sig { params(payment_method: String, params: T.any(::Stripe::PaymentMethodService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PaymentMethod) } diff --git a/rbi/stripe/services/payout_service.rbi b/rbi/stripe/services/payout_service.rbi index 8d43ee612..cf15387e2 100644 --- a/rbi/stripe/services/payout_service.rbi +++ b/rbi/stripe/services/payout_service.rbi @@ -166,11 +166,11 @@ module Stripe } def cancel(payout, params = {}, opts = {}); end - # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. + # To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error. # # If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode. # - # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type. + # If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type. sig { params(params: T.any(::Stripe::PayoutService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Payout) } diff --git a/rbi/stripe/services/plan_service.rbi b/rbi/stripe/services/plan_service.rbi index 6fb407034..2959c73dd 100644 --- a/rbi/stripe/services/plan_service.rbi +++ b/rbi/stripe/services/plan_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class PlanService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -251,7 +249,7 @@ module Stripe usage_type: nil ); end end - # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + # You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. sig { params(params: T.any(::Stripe::PlanService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Plan) } diff --git a/rbi/stripe/services/price_service.rbi b/rbi/stripe/services/price_service.rbi index 75c8c316f..b33f25afe 100644 --- a/rbi/stripe/services/price_service.rbi +++ b/rbi/stripe/services/price_service.rbi @@ -516,7 +516,7 @@ module Stripe } def create(params = {}, opts = {}); end - # Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. + # Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false. sig { params(params: T.any(::Stripe::PriceService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject) } @@ -528,7 +528,7 @@ module Stripe } def retrieve(price, params = {}, opts = {}); end - # Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/rbi/stripe/services/product_feature_service.rbi b/rbi/stripe/services/product_feature_service.rbi index 333ae38a8..3248c2e35 100644 --- a/rbi/stripe/services/product_feature_service.rbi +++ b/rbi/stripe/services/product_feature_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class ProductFeatureService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/product_service.rbi b/rbi/stripe/services/product_service.rbi index d5b5a8377..df26b5684 100644 --- a/rbi/stripe/services/product_service.rbi +++ b/rbi/stripe/services/product_service.rbi @@ -5,9 +5,7 @@ module Stripe class ProductService < StripeService attr_reader :features - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -461,7 +459,7 @@ module Stripe } def retrieve(id, params = {}, opts = {}); end - # Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. diff --git a/rbi/stripe/services/promotion_code_service.rbi b/rbi/stripe/services/promotion_code_service.rbi index 28b56a410..97ad15e6f 100644 --- a/rbi/stripe/services/promotion_code_service.rbi +++ b/rbi/stripe/services/promotion_code_service.rbi @@ -199,7 +199,7 @@ module Stripe } def list(params = {}, opts = {}); end - # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code. + # Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code. sig { params(promotion_code: String, params: T.any(::Stripe::PromotionCodeService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::PromotionCode) } diff --git a/rbi/stripe/services/radar/early_fraud_warning_service.rbi b/rbi/stripe/services/radar/early_fraud_warning_service.rbi index 1090fcf13..e99968f8e 100644 --- a/rbi/stripe/services/radar/early_fraud_warning_service.rbi +++ b/rbi/stripe/services/radar/early_fraud_warning_service.rbi @@ -75,7 +75,7 @@ module Stripe # Retrieves the details of an early fraud warning that has previously been created. # - # Please refer to the [early fraud warning](https://stripe.com/docs/api#early_fraud_warning_object) object reference for more details. + # Please refer to the [early fraud warning](https://docs.stripe.com/api#early_fraud_warning_object) object reference for more details. sig { params(early_fraud_warning: String, params: T.any(::Stripe::Radar::EarlyFraudWarningService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Radar::EarlyFraudWarning) } diff --git a/rbi/stripe/services/radar/value_list_item_service.rbi b/rbi/stripe/services/radar/value_list_item_service.rbi index dffd05bf3..8973832a5 100644 --- a/rbi/stripe/services/radar/value_list_item_service.rbi +++ b/rbi/stripe/services/radar/value_list_item_service.rbi @@ -5,9 +5,7 @@ module Stripe module Radar class ValueListItemService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/radar/value_list_service.rbi b/rbi/stripe/services/radar/value_list_service.rbi index 95ef60ef1..41efeb4eb 100644 --- a/rbi/stripe/services/radar/value_list_service.rbi +++ b/rbi/stripe/services/radar/value_list_service.rbi @@ -5,9 +5,7 @@ module Stripe module Radar class ValueListService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/setup_intent_service.rbi b/rbi/stripe/services/setup_intent_service.rbi index 5bd3f8af9..58526aa40 100644 --- a/rbi/stripe/services/setup_intent_service.rbi +++ b/rbi/stripe/services/setup_intent_service.rbi @@ -78,9 +78,7 @@ module Stripe end class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(String) } @@ -136,21 +134,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -171,12 +159,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -231,9 +215,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -241,12 +223,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -264,12 +242,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -277,12 +251,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -307,21 +277,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -360,9 +320,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -370,24 +328,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -395,15 +341,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -418,12 +358,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -451,12 +387,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::SetupIntentService::CreateParams::PaymentMethodData::AcssDebit)) @@ -816,9 +748,7 @@ module Stripe } def initialize(currency: nil, mandate_options: nil, verification_method: nil); end end - class AmazonPay < Stripe::RequestParams - - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. @@ -995,9 +925,7 @@ module Stripe three_d_secure: nil ); end end - class CardPresent < Stripe::RequestParams - - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. sig { returns(T.nilable(String)) } @@ -1298,21 +1226,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -1333,12 +1251,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -1393,9 +1307,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -1403,12 +1315,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1426,12 +1334,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -1439,12 +1343,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -1469,21 +1369,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -1522,9 +1412,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -1532,24 +1420,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -1557,15 +1433,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -1580,12 +1450,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -1613,12 +1479,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::SetupIntentService::UpdateParams::PaymentMethodData::AcssDebit)) @@ -1978,9 +1840,7 @@ module Stripe } def initialize(currency: nil, mandate_options: nil, verification_method: nil); end end - class AmazonPay < Stripe::RequestParams - - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. @@ -2157,9 +2017,7 @@ module Stripe three_d_secure: nil ); end end - class CardPresent < Stripe::RequestParams - - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. sig { returns(T.nilable(String)) } @@ -2394,9 +2252,7 @@ module Stripe class ConfirmParams < Stripe::RequestParams class MandateData < Stripe::RequestParams class CustomerAcceptance < Stripe::RequestParams - class Offline < Stripe::RequestParams - - end + class Offline < Stripe::RequestParams; end class Online < Stripe::RequestParams # The IP address from which the Mandate was accepted by the customer. sig { returns(T.nilable(String)) } @@ -2454,21 +2310,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -2489,12 +2335,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -2549,9 +2391,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -2559,12 +2399,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2582,12 +2418,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -2595,12 +2427,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -2625,21 +2453,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -2678,9 +2496,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -2688,24 +2504,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -2713,15 +2517,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -2736,12 +2534,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -2769,12 +2563,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::SetupIntentService::ConfirmParams::PaymentMethodData::AcssDebit)) @@ -3134,9 +2924,7 @@ module Stripe } def initialize(currency: nil, mandate_options: nil, verification_method: nil); end end - class AmazonPay < Stripe::RequestParams - - end + class AmazonPay < Stripe::RequestParams; end class BacsDebit < Stripe::RequestParams class MandateOptions < Stripe::RequestParams # Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. @@ -3313,9 +3101,7 @@ module Stripe three_d_secure: nil ); end end - class CardPresent < Stripe::RequestParams - - end + class CardPresent < Stripe::RequestParams; end class Link < Stripe::RequestParams # [Deprecated] This is a legacy parameter that no longer has any function. sig { returns(T.nilable(String)) } @@ -3540,7 +3326,7 @@ module Stripe end # You can cancel a SetupIntent object when it's in one of these statuses: requires_payment_method, requires_confirmation, or requires_action. # - # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. + # After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can't cancel the SetupIntent for a Checkout Session. [Expire the Checkout Session](https://docs.stripe.com/docs/api/checkout/sessions/expire) instead. sig { params(intent: String, params: T.any(::Stripe::SetupIntentService::CancelParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent) } @@ -3567,7 +3353,7 @@ module Stripe # Creates a SetupIntent object. # - # After you create the SetupIntent, attach a payment method and [confirm](https://stripe.com/docs/api/setup_intents/confirm) + # After you create the SetupIntent, attach a payment method and [confirm](https://docs.stripe.com/docs/api/setup_intents/confirm) # it to collect any required permissions to charge the payment method later. sig { params(params: T.any(::Stripe::SetupIntentService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent) @@ -3584,7 +3370,7 @@ module Stripe # # Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string. # - # When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://stripe.com/docs/api#setup_intent_object) object reference for more details. + # When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the [SetupIntent](https://docs.stripe.com/api#setup_intent_object) object reference for more details. sig { params(intent: String, params: T.any(::Stripe::SetupIntentService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SetupIntent) } diff --git a/rbi/stripe/services/source_service.rbi b/rbi/stripe/services/source_service.rbi index d927df7f2..4b52a5baa 100644 --- a/rbi/stripe/services/source_service.rbi +++ b/rbi/stripe/services/source_service.rbi @@ -648,7 +648,7 @@ module Stripe # Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged. # - # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://stripe.com/docs/sources) for more detail. + # This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our [payment method guides](https://docs.stripe.com/docs/sources) for more detail. sig { params(source: String, params: T.any(::Stripe::SourceService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Source) } diff --git a/rbi/stripe/services/subscription_item_service.rbi b/rbi/stripe/services/subscription_item_service.rbi index 723d6f8ff..f9d48f66f 100644 --- a/rbi/stripe/services/subscription_item_service.rbi +++ b/rbi/stripe/services/subscription_item_service.rbi @@ -27,6 +27,13 @@ module Stripe def initialize(expand: nil); end end class UpdateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -83,6 +90,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::UpdateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount])))) @@ -128,9 +140,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::UpdateParams::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItemService::UpdateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, @@ -173,6 +186,13 @@ module Stripe ); end end class CreateParams < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -229,6 +249,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::CreateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount])))) @@ -274,9 +299,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItemService::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionItemService::CreateParams::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionItemService::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), metadata: T.nilable(T::Hash[String, String]), payment_behavior: T.nilable(String), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionItemService::CreateParams::PriceData), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), quantity: T.nilable(Integer), subscription: String, tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, expand: nil, metadata: nil, diff --git a/rbi/stripe/services/subscription_schedule_service.rbi b/rbi/stripe/services/subscription_schedule_service.rbi index 0b374bbb8..ef3eae455 100644 --- a/rbi/stripe/services/subscription_schedule_service.rbi +++ b/rbi/stripe/services/subscription_schedule_service.rbi @@ -157,6 +157,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -205,6 +217,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -228,12 +245,13 @@ module Stripe } attr_accessor :transfer_data sig { - params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData)))).void + params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::BillingThresholds))), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::DefaultSettings::TransferData)))).void } def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -340,6 +358,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -383,6 +413,13 @@ module Stripe def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -441,6 +478,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount])))) @@ -467,9 +509,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -505,6 +548,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -545,7 +593,7 @@ module Stripe # The account on behalf of which to charge, for each of the associated subscription's invoices. sig { returns(T.nilable(String)) } attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior # The data with which to automatically create a Transfer for each of the associated subscription's invoices. @@ -560,13 +608,14 @@ module Stripe sig { returns(T.nilable(Integer)) } attr_accessor :trial_end sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]))), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(Integer)).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::CreateParams::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Discount]))), end_date: T.nilable(Integer), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::CreateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::CreateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(Integer)).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -660,6 +709,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class InvoiceSettings < Stripe::RequestParams class Issuer < Stripe::RequestParams # The connected account being referenced when `type` is `account`. @@ -708,6 +769,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -731,12 +797,13 @@ module Stripe } attr_accessor :transfer_data sig { - params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData)))).void + params(application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::BillingThresholds))), collection_method: T.nilable(String), default_payment_method: T.nilable(String), description: T.nilable(T.nilable(String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::InvoiceSettings), on_behalf_of: T.nilable(T.nilable(String)), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::DefaultSettings::TransferData)))).void } def initialize( application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, default_payment_method: nil, description: nil, @@ -843,6 +910,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -886,6 +965,13 @@ module Stripe def initialize(account_tax_ids: nil, days_until_due: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -944,6 +1030,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount])))) @@ -970,9 +1061,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -1008,6 +1100,11 @@ module Stripe # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation. sig { returns(T.nilable(String)) } attr_accessor :collection_method @@ -1048,7 +1145,7 @@ module Stripe # The account on behalf of which to charge, for each of the associated subscription's invoices. sig { returns(T.nilable(String)) } attr_accessor :on_behalf_of - # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase. + # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. @@ -1066,13 +1163,14 @@ module Stripe sig { returns(T.nilable(T.any(Integer, String))) } attr_accessor :trial_end sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AddInvoiceItem]), application_fee_percent: T.nilable(Float), automatic_tax: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionScheduleService::UpdateParams::Phase::BillingThresholds))), collection_method: T.nilable(String), currency: T.nilable(String), default_payment_method: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Discount]))), end_date: T.nilable(T.any(Integer, String)), invoice_settings: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::InvoiceSettings), items: T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase::Item], iterations: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), on_behalf_of: T.nilable(String), proration_behavior: T.nilable(String), start_date: T.nilable(T.any(Integer, String)), transfer_data: T.nilable(::Stripe::SubscriptionScheduleService::UpdateParams::Phase::TransferData), trial: T.nilable(T::Boolean), trial_end: T.nilable(T.any(Integer, String))).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, collection_method: nil, currency: nil, default_payment_method: nil, @@ -1111,7 +1209,7 @@ module Stripe returns(T.nilable(T::Array[::Stripe::SubscriptionScheduleService::UpdateParams::Phase])) } attr_accessor :phases - # If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. + # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior sig { diff --git a/rbi/stripe/services/subscription_service.rbi b/rbi/stripe/services/subscription_service.rbi index 33f775dec..c949b349b 100644 --- a/rbi/stripe/services/subscription_service.rbi +++ b/rbi/stripe/services/subscription_service.rbi @@ -139,6 +139,18 @@ module Stripe } def initialize(enabled: nil, liability: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class CancellationDetails < Stripe::RequestParams # Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. sig { returns(T.nilable(T.nilable(String))) } @@ -191,6 +203,13 @@ module Stripe def initialize(account_tax_ids: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -247,6 +266,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached. sig { returns(T.nilable(T::Boolean)) } attr_accessor :clear_usage @@ -280,9 +304,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::Item::BillingThresholds))), clear_usage: T.nilable(T::Boolean), deleted: T.nilable(T::Boolean), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Item::Discount]))), id: T.nilable(String), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::UpdateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, clear_usage: nil, deleted: nil, discounts: nil, @@ -402,12 +427,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -564,10 +585,15 @@ module Stripe # Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). sig { returns(T.nilable(String)) } attr_accessor :billing_cycle_anchor + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Details about why this subscription was cancelled @@ -639,7 +665,7 @@ module Stripe # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + # If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. sig { returns(T.nilable(Integer)) } attr_accessor :proration_date # If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. @@ -647,7 +673,7 @@ module Stripe returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData)))) } attr_accessor :transfer_data - # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. + # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. sig { returns(T.nilable(T.any(String, Integer))) } attr_accessor :trial_end # Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. @@ -657,13 +683,14 @@ module Stripe sig { returns(T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings)) } attr_accessor :trial_settings sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax), billing_cycle_anchor: T.nilable(String), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancellation_details: T.nilable(::Stripe::SubscriptionService::UpdateParams::CancellationDetails), collection_method: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(T.nilable(String)), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), pause_collection: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PauseCollection))), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData))), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings)).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::SubscriptionService::UpdateParams::AutomaticTax), billing_cycle_anchor: T.nilable(String), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::BillingThresholds))), cancel_at: T.nilable(T.nilable(T.any(String, Integer))), cancel_at_period_end: T.nilable(T::Boolean), cancellation_details: T.nilable(::Stripe::SubscriptionService::UpdateParams::CancellationDetails), collection_method: T.nilable(String), days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(T.nilable(String)), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(T.nilable(String)), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::UpdateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::SubscriptionService::UpdateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), pause_collection: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PauseCollection))), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), proration_date: T.nilable(Integer), transfer_data: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::UpdateParams::TransferData))), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_settings: T.nilable(::Stripe::SubscriptionService::UpdateParams::TrialSettings)).void } def initialize( add_invoice_items: nil, application_fee_percent: nil, automatic_tax: nil, billing_cycle_anchor: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, cancellation_details: nil, @@ -692,9 +719,7 @@ module Stripe trial_settings: nil ); end end - class DeleteDiscountParams < Stripe::RequestParams - - end + class DeleteDiscountParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams class AutomaticTax < Stripe::RequestParams # Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription. @@ -942,6 +967,18 @@ module Stripe } def initialize(day_of_month: nil, hour: nil, minute: nil, month: nil, second: nil); end end + class BillingThresholds < Stripe::RequestParams + # Monetary threshold that triggers the subscription to advance to a new billing period + sig { returns(T.nilable(Integer)) } + attr_accessor :amount_gte + # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :reset_billing_cycle_anchor + sig { + params(amount_gte: T.nilable(Integer), reset_billing_cycle_anchor: T.nilable(T::Boolean)).void + } + def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -982,6 +1019,13 @@ module Stripe def initialize(account_tax_ids: nil, issuer: nil); end end class Item < Stripe::RequestParams + class BillingThresholds < Stripe::RequestParams + # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte)) + sig { returns(Integer) } + attr_accessor :usage_gte + sig { params(usage_gte: Integer).void } + def initialize(usage_gte: nil); end + end class Discount < Stripe::RequestParams # ID of the coupon to create a new discount for. sig { returns(T.nilable(String)) } @@ -1038,6 +1082,11 @@ module Stripe unit_amount_decimal: nil ); end end + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds)))) + } + attr_accessor :billing_thresholds # The coupons to redeem into discounts for the subscription item. sig { returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount])))) @@ -1062,9 +1111,10 @@ module Stripe sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) } attr_accessor :tax_rates sig { - params(discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void + params(billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::Item::BillingThresholds))), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Item::Discount]))), metadata: T.nilable(T::Hash[String, String]), plan: T.nilable(String), price: T.nilable(String), price_data: T.nilable(::Stripe::SubscriptionService::CreateParams::Item::PriceData), quantity: T.nilable(Integer), tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String])))).void } def initialize( + billing_thresholds: nil, discounts: nil, metadata: nil, plan: nil, @@ -1171,12 +1221,8 @@ module Stripe } def initialize(bank_transfer: nil, funding_type: nil); end end - class Konbini < Stripe::RequestParams - - end - class SepaDebit < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class SepaDebit < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams class FinancialConnections < Stripe::RequestParams class Filters < Stripe::RequestParams @@ -1341,10 +1387,15 @@ module Stripe returns(T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig)) } attr_accessor :billing_cycle_anchor_config + # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + sig { + returns(T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::BillingThresholds)))) + } + attr_accessor :billing_thresholds # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. sig { returns(T.nilable(Integer)) } attr_accessor :cancel_at - # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. + # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead. sig { returns(T.nilable(T::Boolean)) } attr_accessor :cancel_at_period_end # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. @@ -1434,7 +1485,7 @@ module Stripe sig { returns(T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings)) } attr_accessor :trial_settings sig { - params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax), backdate_start_date: T.nilable(Integer), billing_cycle_anchor: T.nilable(Integer), billing_cycle_anchor_config: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig), cancel_at: T.nilable(Integer), cancel_at_period_end: T.nilable(T::Boolean), collection_method: T.nilable(String), currency: T.nilable(String), customer: String, days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(String), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionService::CreateParams::TransferData), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings)).void + params(add_invoice_items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::AddInvoiceItem]), application_fee_percent: T.nilable(T.nilable(T.any(String, Float))), automatic_tax: T.nilable(::Stripe::SubscriptionService::CreateParams::AutomaticTax), backdate_start_date: T.nilable(Integer), billing_cycle_anchor: T.nilable(Integer), billing_cycle_anchor_config: T.nilable(::Stripe::SubscriptionService::CreateParams::BillingCycleAnchorConfig), billing_thresholds: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::BillingThresholds))), cancel_at: T.nilable(Integer), cancel_at_period_end: T.nilable(T::Boolean), collection_method: T.nilable(String), currency: T.nilable(String), customer: String, days_until_due: T.nilable(Integer), default_payment_method: T.nilable(String), default_source: T.nilable(String), default_tax_rates: T.nilable(T.nilable(T.any(String, T::Array[String]))), description: T.nilable(String), discounts: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::SubscriptionService::CreateParams::Discount]))), expand: T.nilable(T::Array[String]), invoice_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::InvoiceSettings), items: T.nilable(T::Array[::Stripe::SubscriptionService::CreateParams::Item]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), off_session: T.nilable(T::Boolean), on_behalf_of: T.nilable(T.nilable(String)), payment_behavior: T.nilable(String), payment_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::PaymentSettings), pending_invoice_item_interval: T.nilable(T.nilable(T.any(String, ::Stripe::SubscriptionService::CreateParams::PendingInvoiceItemInterval))), proration_behavior: T.nilable(String), transfer_data: T.nilable(::Stripe::SubscriptionService::CreateParams::TransferData), trial_end: T.nilable(T.any(String, Integer)), trial_from_plan: T.nilable(T::Boolean), trial_period_days: T.nilable(Integer), trial_settings: T.nilable(::Stripe::SubscriptionService::CreateParams::TrialSettings)).void } def initialize( add_invoice_items: nil, @@ -1443,6 +1494,7 @@ module Stripe backdate_start_date: nil, billing_cycle_anchor: nil, billing_cycle_anchor_config: nil, + billing_thresholds: nil, cancel_at: nil, cancel_at_period_end: nil, collection_method: nil, @@ -1496,10 +1548,10 @@ module Stripe # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } attr_accessor :expand - # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. sig { returns(T.nilable(String)) } attr_accessor :proration_behavior - # If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + # If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. sig { returns(T.nilable(Integer)) } attr_accessor :proration_date sig { @@ -1512,9 +1564,9 @@ module Stripe proration_date: nil ); end end - # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata). + # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://docs.stripe.com/metadata). # - # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. + # Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true. # # By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all. sig { @@ -1527,7 +1579,7 @@ module Stripe # When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. # The payment_behavior parameter determines the exact behavior of the initial payment. # - # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. + # To start subscriptions where the first invoice always begins in a draft status, use [subscription schedules](https://docs.stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. # Schedules provide the flexibility to model more complex billing configurations that change over time. sig { params(params: T.any(::Stripe::SubscriptionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription) @@ -1558,7 +1610,7 @@ module Stripe } def retrieve(subscription_exposed_id, params = {}, opts = {}); end - # Search for subscriptions you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language). + # Search for subscriptions you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language). # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up # to an hour behind during outages. Search functionality is not available to merchants in India. @@ -1569,7 +1621,7 @@ module Stripe # Updates an existing subscription to match the specified parameters. # When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. - # To preview how the proration is calculated, use the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. + # To preview how the proration is calculated, use the [create preview](https://docs.stripe.com/docs/api/invoices/create_preview) endpoint. # # By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they'll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month's 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes. # @@ -1581,13 +1633,13 @@ module Stripe # A trial starts or ends. # # - # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). + # In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. Learn about how [Stripe immediately attempts payment for subscription changes](https://docs.stripe.com/docs/billing/subscriptions/upgrade-downgrade#immediate-payment). # - # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create). + # If you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription's renewal date, you need to manually [invoice the customer](https://docs.stripe.com/docs/api/invoices/create). # # If you don't want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don't generate any credits for the old subscription's unused time. We still reset the billing date and bill immediately for the new subscription. # - # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://stripe.com/docs/rate-limits) instead. + # Updating the quantity on a subscription many times in an hour may result in [rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing](https://docs.stripe.com/docs/rate-limits) instead. sig { params(subscription_exposed_id: String, params: T.any(::Stripe::SubscriptionService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Subscription) } diff --git a/rbi/stripe/services/tax/calculation_service.rbi b/rbi/stripe/services/tax/calculation_service.rbi index 6fd746dff..53584e73e 100644 --- a/rbi/stripe/services/tax/calculation_service.rbi +++ b/rbi/stripe/services/tax/calculation_service.rbi @@ -91,6 +91,9 @@ module Stripe # If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount. sig { returns(Integer) } attr_accessor :amount + # 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. + sig { returns(T.nilable(T::Hash[String, String])) } + attr_accessor :metadata # If provided, the product's `tax_code` will be used as the line item's `tax_code`. sig { returns(T.nilable(String)) } attr_accessor :product @@ -107,10 +110,11 @@ module Stripe sig { returns(T.nilable(String)) } attr_accessor :tax_code sig { - params(amount: Integer, product: T.nilable(String), quantity: T.nilable(Integer), reference: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void + params(amount: Integer, metadata: T.nilable(T::Hash[String, String]), product: T.nilable(String), quantity: T.nilable(Integer), reference: T.nilable(String), tax_behavior: T.nilable(String), tax_code: T.nilable(String)).void } def initialize( amount: nil, + metadata: nil, product: nil, quantity: nil, reference: nil, diff --git a/rbi/stripe/services/tax/registration_service.rbi b/rbi/stripe/services/tax/registration_service.rbi index 33fc696a8..6cd438775 100644 --- a/rbi/stripe/services/tax/registration_service.rbi +++ b/rbi/stripe/services/tax/registration_service.rbi @@ -1065,7 +1065,7 @@ module Stripe end class Us < Stripe::RequestParams class LocalAmusementTax < Stripe::RequestParams - # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `64343` (River Grove), and `68081` (Schiller Park). + # A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park). sig { returns(String) } attr_accessor :jurisdiction sig { params(jurisdiction: String).void } diff --git a/rbi/stripe/services/tax_id_service.rbi b/rbi/stripe/services/tax_id_service.rbi index e02d13afa..46a6816c4 100644 --- a/rbi/stripe/services/tax_id_service.rbi +++ b/rbi/stripe/services/tax_id_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class TaxIdService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/terminal/configuration_service.rbi b/rbi/stripe/services/terminal/configuration_service.rbi index 199fd2184..cf9cb0967 100644 --- a/rbi/stripe/services/terminal/configuration_service.rbi +++ b/rbi/stripe/services/terminal/configuration_service.rbi @@ -5,9 +5,7 @@ module Stripe module Terminal class ConfigurationService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/terminal/location_service.rbi b/rbi/stripe/services/terminal/location_service.rbi index 3b29176aa..ffaa4e7f2 100644 --- a/rbi/stripe/services/terminal/location_service.rbi +++ b/rbi/stripe/services/terminal/location_service.rbi @@ -5,9 +5,7 @@ module Stripe module Terminal class LocationService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -150,7 +148,7 @@ module Stripe ); end end # Creates a new Location object. - # For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide. + # For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide. sig { params(params: T.any(::Stripe::Terminal::LocationService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Location) } diff --git a/rbi/stripe/services/terminal/reader_service.rbi b/rbi/stripe/services/terminal/reader_service.rbi index 1ac4d6c3b..04d77f58a 100644 --- a/rbi/stripe/services/terminal/reader_service.rbi +++ b/rbi/stripe/services/terminal/reader_service.rbi @@ -5,9 +5,7 @@ module Stripe module Terminal class ReaderService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } @@ -103,6 +101,109 @@ module Stripe sig { params(expand: T.nilable(T::Array[String])).void } def initialize(expand: nil); end end + class CollectInputsParams < Stripe::RequestParams + class Input < Stripe::RequestParams + class CustomText < Stripe::RequestParams + # The description which will be displayed when collecting this input + sig { returns(T.nilable(String)) } + attr_accessor :description + # The skip button text + sig { returns(T.nilable(String)) } + attr_accessor :skip_button + # The submit button text + sig { returns(T.nilable(String)) } + attr_accessor :submit_button + # The title which will be displayed when collecting this input + sig { returns(String) } + attr_accessor :title + sig { + params(description: T.nilable(String), skip_button: T.nilable(String), submit_button: T.nilable(String), title: String).void + } + def initialize(description: nil, skip_button: nil, submit_button: nil, title: nil); end + end + class Selection < Stripe::RequestParams + class Choice < Stripe::RequestParams + # The unique identifier for this choice + sig { returns(String) } + attr_accessor :id + # The style of the button which will be shown for this choice + sig { returns(T.nilable(String)) } + attr_accessor :style + # The text which will be shown on the button for this choice + sig { returns(String) } + attr_accessor :text + sig { params(id: String, style: T.nilable(String), text: String).void } + def initialize(id: nil, style: nil, text: nil); end + end + # List of choices for the `selection` input + sig { + returns(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection::Choice]) + } + attr_accessor :choices + sig { + params(choices: T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection::Choice]).void + } + def initialize(choices: nil); end + end + class Toggle < Stripe::RequestParams + # The default value of the toggle + sig { returns(T.nilable(String)) } + attr_accessor :default_value + # The description which will be displayed for the toggle + sig { returns(T.nilable(String)) } + attr_accessor :description + # The title which will be displayed for the toggle + sig { returns(T.nilable(String)) } + attr_accessor :title + sig { + params(default_value: T.nilable(String), description: T.nilable(String), title: T.nilable(String)).void + } + def initialize(default_value: nil, description: nil, title: nil); end + end + # Customize the text which will be displayed while collecting this input + sig { returns(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::CustomText) } + attr_accessor :custom_text + # Indicate that this input is required, disabling the skip button + sig { returns(T.nilable(T::Boolean)) } + attr_accessor :required + # Options for the `selection` input + sig { + returns(T.nilable(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection)) + } + attr_accessor :selection + # List of toggles to be displayed and customization for the toggles + sig { + returns(T.nilable(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Toggle])) + } + attr_accessor :toggles + # The type of input to collect + sig { returns(String) } + attr_accessor :type + sig { + params(custom_text: ::Stripe::Terminal::ReaderService::CollectInputsParams::Input::CustomText, required: T.nilable(T::Boolean), selection: T.nilable(::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Selection), toggles: T.nilable(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input::Toggle]), type: String).void + } + def initialize( + custom_text: nil, + required: nil, + selection: nil, + toggles: nil, + type: nil + ); end + end + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + # List of inputs to be collected using the Reader + sig { returns(T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input]) } + attr_accessor :inputs + # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + sig { returns(T.nilable(T::Hash[String, String])) } + attr_accessor :metadata + sig { + params(expand: T.nilable(T::Array[String]), inputs: T::Array[::Stripe::Terminal::ReaderService::CollectInputsParams::Input], metadata: T.nilable(T::Hash[String, String])).void + } + def initialize(expand: nil, inputs: nil, metadata: nil); end + end class ProcessPaymentIntentParams < Stripe::RequestParams class ProcessConfig < Stripe::RequestParams class Tipping < Stripe::RequestParams @@ -118,6 +219,9 @@ module Stripe # Enables cancel button on transaction screens. sig { returns(T.nilable(T::Boolean)) } attr_accessor :enable_customer_cancellation + # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. + sig { returns(T.nilable(String)) } + attr_accessor :return_url # Override showing a tipping selection screen on this transaction. sig { returns(T.nilable(T::Boolean)) } attr_accessor :skip_tipping @@ -127,11 +231,12 @@ module Stripe } attr_accessor :tipping sig { - params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void + params(allow_redisplay: T.nilable(String), enable_customer_cancellation: T.nilable(T::Boolean), return_url: T.nilable(String), skip_tipping: T.nilable(T::Boolean), tipping: T.nilable(::Stripe::Terminal::ReaderService::ProcessPaymentIntentParams::ProcessConfig::Tipping)).void } def initialize( allow_redisplay: nil, enable_customer_cancellation: nil, + return_url: nil, skip_tipping: nil, tipping: nil ); end @@ -286,6 +391,12 @@ module Stripe } def cancel_action(reader, params = {}, opts = {}); end + # Initiates an input collection flow on a Reader. + sig { + params(reader: String, params: T.any(::Stripe::Terminal::ReaderService::CollectInputsParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) + } + def collect_inputs(reader, params = {}, opts = {}); end + # Creates a new Reader object. sig { params(params: T.any(::Stripe::Terminal::ReaderService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) diff --git a/rbi/stripe/services/test_helpers/confirmation_token_service.rbi b/rbi/stripe/services/test_helpers/confirmation_token_service.rbi index 65fed3bcf..110f9c6be 100644 --- a/rbi/stripe/services/test_helpers/confirmation_token_service.rbi +++ b/rbi/stripe/services/test_helpers/confirmation_token_service.rbi @@ -22,21 +22,11 @@ module Stripe } def initialize(account_number: nil, institution_number: nil, transit_number: nil); end end - class Affirm < Stripe::RequestParams - - end - class AfterpayClearpay < Stripe::RequestParams - - end - class Alipay < Stripe::RequestParams - - end - class Alma < Stripe::RequestParams - - end - class AmazonPay < Stripe::RequestParams - - end + class Affirm < Stripe::RequestParams; end + class AfterpayClearpay < Stripe::RequestParams; end + class Alipay < Stripe::RequestParams; end + class Alma < Stripe::RequestParams; end + class AmazonPay < Stripe::RequestParams; end class AuBecsDebit < Stripe::RequestParams # The account number for the bank account. sig { returns(String) } @@ -57,12 +47,8 @@ module Stripe sig { params(account_number: T.nilable(String), sort_code: T.nilable(String)).void } def initialize(account_number: nil, sort_code: nil); end end - class Bancontact < Stripe::RequestParams - - end - class Billie < Stripe::RequestParams - - end + class Bancontact < Stripe::RequestParams; end + class Billie < Stripe::RequestParams; end class BillingDetails < Stripe::RequestParams class Address < Stripe::RequestParams # City, district, suburb, town, or village. @@ -117,9 +103,7 @@ module Stripe } def initialize(address: nil, email: nil, name: nil, phone: nil, tax_id: nil); end end - class Blik < Stripe::RequestParams - - end + class Blik < Stripe::RequestParams; end class Boleto < Stripe::RequestParams # The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers) sig { returns(String) } @@ -127,12 +111,8 @@ module Stripe sig { params(tax_id: String).void } def initialize(tax_id: nil); end end - class Cashapp < Stripe::RequestParams - - end - class CustomerBalance < Stripe::RequestParams - - end + class Cashapp < Stripe::RequestParams; end + class CustomerBalance < Stripe::RequestParams; end class Eps < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -150,12 +130,8 @@ module Stripe sig { params(account_holder_type: T.nilable(String), bank: String).void } def initialize(account_holder_type: nil, bank: nil); end end - class Giropay < Stripe::RequestParams - - end - class Grabpay < Stripe::RequestParams - - end + class Giropay < Stripe::RequestParams; end + class Grabpay < Stripe::RequestParams; end class Ideal < Stripe::RequestParams # The customer's bank. Only use this parameter for existing customers. Don't use it for new customers. sig { returns(T.nilable(String)) } @@ -163,12 +139,8 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class InteracPresent < Stripe::RequestParams - - end - class KakaoPay < Stripe::RequestParams - - end + class InteracPresent < Stripe::RequestParams; end + class KakaoPay < Stripe::RequestParams; end class Klarna < Stripe::RequestParams class Dob < Stripe::RequestParams # The day of birth, between 1 and 31. @@ -193,21 +165,11 @@ module Stripe } def initialize(dob: nil); end end - class Konbini < Stripe::RequestParams - - end - class KrCard < Stripe::RequestParams - - end - class Link < Stripe::RequestParams - - end - class Mobilepay < Stripe::RequestParams - - end - class Multibanco < Stripe::RequestParams - - end + class Konbini < Stripe::RequestParams; end + class KrCard < Stripe::RequestParams; end + class Link < Stripe::RequestParams; end + class Mobilepay < Stripe::RequestParams; end + class Multibanco < Stripe::RequestParams; end class NaverPay < Stripe::RequestParams # Whether to use Naver Pay points or a card to fund this transaction. If not provided, this defaults to `card`. sig { returns(T.nilable(String)) } @@ -246,9 +208,7 @@ module Stripe suffix: nil ); end end - class Oxxo < Stripe::RequestParams - - end + class Oxxo < Stripe::RequestParams; end class P24 < Stripe::RequestParams # The customer's bank. sig { returns(T.nilable(String)) } @@ -256,24 +216,12 @@ module Stripe sig { params(bank: T.nilable(String)).void } def initialize(bank: nil); end end - class PayByBank < Stripe::RequestParams - - end - class Payco < Stripe::RequestParams - - end - class Paynow < Stripe::RequestParams - - end - class Paypal < Stripe::RequestParams - - end - class Pix < Stripe::RequestParams - - end - class Promptpay < Stripe::RequestParams - - end + class PayByBank < Stripe::RequestParams; end + class Payco < Stripe::RequestParams; end + class Paynow < Stripe::RequestParams; end + class Paypal < Stripe::RequestParams; end + class Pix < Stripe::RequestParams; end + class Promptpay < Stripe::RequestParams; end class RadarOptions < Stripe::RequestParams # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. sig { returns(T.nilable(String)) } @@ -281,15 +229,9 @@ module Stripe sig { params(session: T.nilable(String)).void } def initialize(session: nil); end end - class RevolutPay < Stripe::RequestParams - - end - class SamsungPay < Stripe::RequestParams - - end - class Satispay < Stripe::RequestParams - - end + class RevolutPay < Stripe::RequestParams; end + class SamsungPay < Stripe::RequestParams; end + class Satispay < Stripe::RequestParams; end class SepaDebit < Stripe::RequestParams # IBAN of the bank account. sig { returns(String) } @@ -304,12 +246,8 @@ module Stripe sig { params(country: String).void } def initialize(country: nil); end end - class Swish < Stripe::RequestParams - - end - class Twint < Stripe::RequestParams - - end + class Swish < Stripe::RequestParams; end + class Twint < Stripe::RequestParams; end class UsBankAccount < Stripe::RequestParams # Account holder type: individual or company. sig { returns(T.nilable(String)) } @@ -337,12 +275,8 @@ module Stripe routing_number: nil ); end end - class WechatPay < Stripe::RequestParams - - end - class Zip < Stripe::RequestParams - - end + class WechatPay < Stripe::RequestParams; end + class Zip < Stripe::RequestParams; end # If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method. sig { returns(T.nilable(::Stripe::TestHelpers::ConfirmationTokenService::CreateParams::PaymentMethodData::AcssDebit)) diff --git a/rbi/stripe/services/test_helpers/terminal/reader_service.rbi b/rbi/stripe/services/test_helpers/terminal/reader_service.rbi index b13288bb2..58ab84cc4 100644 --- a/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +++ b/rbi/stripe/services/test_helpers/terminal/reader_service.rbi @@ -51,11 +51,42 @@ module Stripe type: nil ); end end + class SucceedInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + # This parameter defines the skip behavior for input collection. + sig { returns(T.nilable(String)) } + attr_accessor :skip_non_required_inputs + sig { + params(expand: T.nilable(T::Array[String]), skip_non_required_inputs: T.nilable(String)).void + } + def initialize(expand: nil, skip_non_required_inputs: nil); end + end + class TimeoutInputCollectionParams < Stripe::RequestParams + # Specifies which fields in the response should be expanded. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :expand + sig { params(expand: T.nilable(T::Array[String])).void } + def initialize(expand: nil); end + end # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction. sig { params(reader: String, params: T.any(::Stripe::TestHelpers::Terminal::ReaderService::PresentPaymentMethodParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) } def present_payment_method(reader, params = {}, opts = {}); end + + # Use this endpoint to trigger a successful input collection on a simulated reader. + sig { + params(reader: String, params: T.any(::Stripe::TestHelpers::Terminal::ReaderService::SucceedInputCollectionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) + } + def succeed_input_collection(reader, params = {}, opts = {}); end + + # Use this endpoint to complete an input collection with a timeout error on a simulated reader. + sig { + params(reader: String, params: T.any(::Stripe::TestHelpers::Terminal::ReaderService::TimeoutInputCollectionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader) + } + def timeout_input_collection(reader, params = {}, opts = {}); end end end end diff --git a/rbi/stripe/services/test_helpers/test_clock_service.rbi b/rbi/stripe/services/test_helpers/test_clock_service.rbi index 5933a920b..bffeb6540 100644 --- a/rbi/stripe/services/test_helpers/test_clock_service.rbi +++ b/rbi/stripe/services/test_helpers/test_clock_service.rbi @@ -5,9 +5,7 @@ module Stripe module TestHelpers class TestClockService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/token_service.rbi b/rbi/stripe/services/token_service.rbi index 6feaecb9e..c1474d64c 100644 --- a/rbi/stripe/services/token_service.rbi +++ b/rbi/stripe/services/token_service.rbi @@ -1242,7 +1242,7 @@ module Stripe ); end end # Creates a single-use token that represents a bank account's details. - # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. + # You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts. sig { params(params: T.any(::Stripe::TokenService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Token) } diff --git a/rbi/stripe/services/transfer_service.rbi b/rbi/stripe/services/transfer_service.rbi index 635feb569..a50ea2b05 100644 --- a/rbi/stripe/services/transfer_service.rbi +++ b/rbi/stripe/services/transfer_service.rbi @@ -123,7 +123,7 @@ module Stripe } def initialize(description: nil, expand: nil, metadata: nil); end end - # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. + # To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error. sig { params(params: T.any(::Stripe::TransferService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Transfer) } diff --git a/rbi/stripe/services/v2/billing/meter_event_session_service.rbi b/rbi/stripe/services/v2/billing/meter_event_session_service.rbi index a0fdf5817..e61dfa48f 100644 --- a/rbi/stripe/services/v2/billing/meter_event_session_service.rbi +++ b/rbi/stripe/services/v2/billing/meter_event_session_service.rbi @@ -6,9 +6,7 @@ module Stripe module V2 module Billing class MeterEventSessionService < StripeService - class CreateParams < Stripe::RequestParams - - end + class CreateParams < Stripe::RequestParams; end # Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires. sig { params(params: T.any(::Stripe::V2::Billing::MeterEventSessionService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::Billing::MeterEventSession) diff --git a/rbi/stripe/services/v2/core/event_destination_service.rbi b/rbi/stripe/services/v2/core/event_destination_service.rbi index 835e341f2..e5ccfe947 100644 --- a/rbi/stripe/services/v2/core/event_destination_service.rbi +++ b/rbi/stripe/services/v2/core/event_destination_service.rbi @@ -78,15 +78,9 @@ module Stripe webhook_endpoint: nil ); end end - class DeleteParams < Stripe::RequestParams - - end - class DisableParams < Stripe::RequestParams - - end - class EnableParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end + class DisableParams < Stripe::RequestParams; end + class EnableParams < Stripe::RequestParams; end class ListParams < Stripe::RequestParams # Additional fields to include in the response. Currently supports `webhook_endpoint.url`. sig { returns(T.nilable(T::Array[String])) } @@ -97,9 +91,7 @@ module Stripe sig { params(include: T.nilable(T::Array[String]), limit: T.nilable(Integer)).void } def initialize(include: nil, limit: nil); end end - class PingParams < Stripe::RequestParams - - end + class PingParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Additional fields to include in the response. sig { returns(T.nilable(T::Array[String])) } diff --git a/rbi/stripe/services/v2/core/event_service.rbi b/rbi/stripe/services/v2/core/event_service.rbi index 9095f6e53..89088826b 100644 --- a/rbi/stripe/services/v2/core/event_service.rbi +++ b/rbi/stripe/services/v2/core/event_service.rbi @@ -18,9 +18,7 @@ module Stripe sig { params(limit: T.nilable(Integer), object_id_: String).void } def initialize(limit: nil, object_id_: nil); end end - class RetrieveParams < Stripe::RequestParams - - end + class RetrieveParams < Stripe::RequestParams; end # List events, going back up to 30 days. sig { params(params: T.any(::Stripe::V2::Core::EventService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::V2::ListObject) diff --git a/rbi/stripe/services/webhook_endpoint_service.rbi b/rbi/stripe/services/webhook_endpoint_service.rbi index 994f6abef..5a89badc5 100644 --- a/rbi/stripe/services/webhook_endpoint_service.rbi +++ b/rbi/stripe/services/webhook_endpoint_service.rbi @@ -4,9 +4,7 @@ # typed: true module Stripe class WebhookEndpointService < StripeService - class DeleteParams < Stripe::RequestParams - - end + class DeleteParams < Stripe::RequestParams; end class RetrieveParams < Stripe::RequestParams # Specifies which fields in the response should be expanded. sig { returns(T.nilable(T::Array[String])) } From 655385565f35ad90b8a02d341215184cf71a488a Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Thu, 29 May 2025 00:28:57 +0530 Subject: [PATCH 2/2] Bump version to 15.2.0 --- CHANGELOG.md | 40 ++++++++++++++++++++++++++++++++++------ VERSION | 2 +- lib/stripe/version.rb | 2 +- 3 files changed, 36 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f2847660..f32e89b58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,32 @@ # Changelog +## 15.2.0 - 2025-05-29 + This release changes the pinned API version to `2025-05-28.basil`. + +* [#1605](https://github.com/stripe/stripe-ruby/pull/1605) Update generated code + * Add support for `attach_payment` method on resource `Invoice` + * Add support for `collect_inputs` method on resource `Terminal::Reader` + * Add support for `succeed_input_collection` and `timeout_input_collection` test helper methods on resource `Terminal::Reader` + * Add support for `pix_payments` on `Account::Capability`, `Account::CreateParams::Capability`, and `Account::UpdateParams::Capability` + * Add support for `disputes_list` and `payment_disputes` on `AccountSession::Component` and `AccountSession::CreateParams::Component` + * Add support for `refund_and_dispute_prefunding` on `Balance` + * Add support for `balance_type` on `BalanceTransaction` + * Change `Billing::Alert::CreateParams::UsageThreshold.meter` to be required + * Add support for `location` and `reader` on `Charge::PaymentMethodDetail::Affirm` and `Charge::PaymentMethodDetail::WechatPay` + * Add support for `payment_method_remove` on `Checkout::Session::CreateParams::SavedPaymentMethodOption` + * Add support for `setup_future_usage` on `Checkout::Session::PaymentMethodOption::NaverPay` + * Change `ConfirmationToken::PaymentMethodPreview::NaverPay.buyer_id` and `PaymentMethod::NaverPay.buyer_id` to be required + * Add support for `post_payment_amount` and `pre_payment_amount` on `CreditNote` + * Add support for `sex`, `unparsed_place_of_birth`, and `unparsed_sex` on `Identity::VerificationReport::Document` and `Identity::VerificationSession::VerifiedOutput` + * Add support for `billing_thresholds` on `Invoice::CreatePreviewParams::ScheduleDetail::Phase::Item`, `Invoice::CreatePreviewParams::ScheduleDetail::Phase`, `Invoice::CreatePreviewParams::SubscriptionDetail::Item`, `Subscription::CreateParams::Item`, `Subscription::CreateParams`, `Subscription::UpdateParams::Item`, `Subscription::UpdateParams`, `SubscriptionItem::CreateParams`, `SubscriptionItem::UpdateParams`, `SubscriptionItem`, `SubscriptionSchedule::CreateParams::DefaultSetting`, `SubscriptionSchedule::CreateParams::Phase::Item`, `SubscriptionSchedule::CreateParams::Phase`, `SubscriptionSchedule::DefaultSetting`, `SubscriptionSchedule::Phase::Item`, `SubscriptionSchedule::Phase`, `SubscriptionSchedule::UpdateParams::DefaultSetting`, `SubscriptionSchedule::UpdateParams::Phase::Item`, `SubscriptionSchedule::UpdateParams::Phase`, and `Subscription` + * Add support for `satispay` on `PaymentIntent::ConfirmParams::PaymentMethodOption`, `PaymentIntent::CreateParams::PaymentMethodOption`, `PaymentIntent::PaymentMethodOption`, and `PaymentIntent::UpdateParams::PaymentMethodOption` + * Add support for `capture_method` on `PaymentIntent::PaymentMethodOption::Billie` + * Add support for `kakao_pay`, `kr_card`, `naver_pay`, `payco`, and `samsung_pay` on `PaymentMethodConfiguration::CreateParams`, `PaymentMethodConfiguration::UpdateParams`, and `PaymentMethodConfiguration` + * Add support for `network_decline_code` on `Refund::DestinationDetail::Paypal` + * Add support for `metadata` on `Tax::Calculation::CreateParams::LineItem` and `Tax::CalculationLineItem` + * Add support for `return_url` on `Terminal::Reader::Action::ProcessPaymentIntent::ProcessConfig` and `Terminal::Reader::ProcessPaymentIntentParams::ProcessConfig` + * Add support for `collect_inputs` on `Terminal::Reader::Action` +* [#1601](https://github.com/stripe/stripe-ruby/pull/1601) Adds CONTRIBUTING.md + ## 15.1.0 - 2025-04-30 This release changes the pinned API version to `2025-04-30.basil`. @@ -34,12 +62,12 @@ * [#1576](https://github.com/stripe/stripe-ruby/pull/1576) Explicitly pass through custom headers in retrieve * Fix custom options passing for resource-based retrieve * [#1571](https://github.com/stripe/stripe-ruby/pull/1571) Validate all instance variable keys returned from the API - * Validate all keys returned from the API, including custom response fields, to make sure they can be set in an instance variable, as brought up in https://github.com/stripe/stripe-ruby/issues/1564 - * We do not set instance variables for invalid field names (as defined by the [Ruby spec](https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#ident)). We recommend for custom hash map response fields, use the `[]` accessor. - ```ruby - c = client.v1.customers.retrieve("cus_123") - c.metadata["invalid-variable-name!"] - c.metadata["valid_key_name_works_too"] + * Validate all keys returned from the API, including custom response fields, to make sure they can be set in an instance variable, as brought up in https://github.com/stripe/stripe-ruby/issues/1564 + * We do not set instance variables for invalid field names (as defined by the [Ruby spec](https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html#ident)). We recommend for custom hash map response fields, use the `[]` accessor. + ```ruby + c = client.v1.customers.retrieve("cus_123") + c.metadata["invalid-variable-name!"] + c.metadata["valid_key_name_works_too"] ``` * [#1575](https://github.com/stripe/stripe-ruby/pull/1575) Remove unused youtube playlist link * [#1573](https://github.com/stripe/stripe-ruby/pull/1573) Remove link for stale youtube video playlist diff --git a/VERSION b/VERSION index d14dfbac3..6c43fc8ae 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -15.1.0 +15.2.0 diff --git a/lib/stripe/version.rb b/lib/stripe/version.rb index e0f1c75b0..8c281c677 100644 --- a/lib/stripe/version.rb +++ b/lib/stripe/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Stripe - VERSION = "15.1.0" + VERSION = "15.2.0" end