From 1200cf23426136ef60d8f66b884af8b838423b17 Mon Sep 17 00:00:00 2001 From: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Date: Tue, 20 May 2025 18:14:52 +0000 Subject: [PATCH] Update generated code for v1770 --- lib/stripe/resources/account.rb | 36 +- lib/stripe/resources/bank_account.rb | 4 +- .../resources/billing_portal/session.rb | 2 +- lib/stripe/resources/charge.rb | 10 +- lib/stripe/resources/checkout/session.rb | 2 +- lib/stripe/resources/country_spec.rb | 2 +- lib/stripe/resources/credit_note.rb | 4 +- lib/stripe/resources/customer_session.rb | 6 +- lib/stripe/resources/dispute.rb | 2 +- lib/stripe/resources/file.rb | 2 +- .../identity/verification_session.rb | 22 +- lib/stripe/resources/invoice.rb | 24 +- lib/stripe/resources/issuing/authorization.rb | 16 +- lib/stripe/resources/issuing/dispute.rb | 6 +- lib/stripe/resources/order.rb | 4 +- lib/stripe/resources/payment_intent.rb | 58 +-- lib/stripe/resources/payment_method.rb | 22 +- 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 | 2 +- lib/stripe/resources/price.rb | 2 +- lib/stripe/resources/quote_preview_invoice.rb | 2 +- lib/stripe/resources/reversal.rb | 2 +- lib/stripe/resources/review.rb | 2 +- lib/stripe/resources/setup_intent.rb | 6 +- lib/stripe/resources/source.rb | 2 +- lib/stripe/resources/subscription.rb | 18 +- lib/stripe/resources/tax_rate.rb | 4 +- lib/stripe/resources/terminal/location.rb | 2 +- lib/stripe/resources/token.rb | 4 +- lib/stripe/resources/transfer.rb | 2 +- .../account_external_account_service.rb | 2 +- .../services/account_login_link_service.rb | 2 +- lib/stripe/services/account_service.rb | 22 +- lib/stripe/services/balance_service.rb | 2 +- .../services/balance_settings_service.rb | 4 +- lib/stripe/services/charge_service.rb | 8 +- .../services/checkout/session_service.rb | 2 +- lib/stripe/services/credit_note_service.rb | 2 +- .../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 | 2 +- lib/stripe/services/dispute_service.rb | 2 +- .../services/external_account_service.rb | 2 +- lib/stripe/services/file_service.rb | 2 +- .../identity/verification_session_service.rb | 10 +- lib/stripe/services/invoice_service.rb | 16 +- .../services/issuing/authorization_service.rb | 8 +- .../services/issuing/dispute_service.rb | 4 +- lib/stripe/services/order_service.rb | 2 +- lib/stripe/services/payment_intent_service.rb | 36 +- .../services/payment_method_domain_service.rb | 2 +- lib/stripe/services/payment_method_service.rb | 16 +- lib/stripe/services/payout_service.rb | 4 +- lib/stripe/services/plan_service.rb | 2 +- lib/stripe/services/price_service.rb | 4 +- lib/stripe/services/product_service.rb | 2 +- lib/stripe/services/promotion_code_service.rb | 2 +- .../radar/early_fraud_warning_service.rb | 2 +- lib/stripe/services/setup_intent_service.rb | 6 +- lib/stripe/services/source_service.rb | 2 +- lib/stripe/services/subscription_service.rb | 16 +- .../services/terminal/location_service.rb | 2 +- lib/stripe/services/token_service.rb | 2 +- lib/stripe/services/transfer_service.rb | 2 +- rbi/stripe.rbi | 490 +++++++++--------- rbi/stripe/resources/account.rbi | 36 +- rbi/stripe/resources/bank_account.rbi | 4 +- .../resources/billing_portal/session.rbi | 2 +- rbi/stripe/resources/charge.rbi | 10 +- rbi/stripe/resources/checkout/session.rbi | 2 +- rbi/stripe/resources/country_spec.rbi | 2 +- rbi/stripe/resources/credit_note.rbi | 4 +- rbi/stripe/resources/customer_session.rbi | 6 +- rbi/stripe/resources/dispute.rbi | 2 +- rbi/stripe/resources/file.rbi | 2 +- .../identity/verification_session.rbi | 22 +- rbi/stripe/resources/invoice.rbi | 24 +- .../resources/issuing/authorization.rbi | 16 +- rbi/stripe/resources/issuing/dispute.rbi | 6 +- rbi/stripe/resources/order.rbi | 4 +- rbi/stripe/resources/payment_intent.rbi | 58 +-- rbi/stripe/resources/payment_method.rbi | 22 +- .../resources/payment_method_domain.rbi | 4 +- rbi/stripe/resources/payout.rbi | 8 +- rbi/stripe/resources/person.rbi | 4 +- rbi/stripe/resources/plan.rbi | 2 +- rbi/stripe/resources/price.rbi | 2 +- .../resources/quote_preview_invoice.rbi | 2 +- rbi/stripe/resources/reversal.rbi | 2 +- rbi/stripe/resources/review.rbi | 2 +- rbi/stripe/resources/setup_intent.rbi | 6 +- rbi/stripe/resources/source.rbi | 2 +- rbi/stripe/resources/subscription.rbi | 18 +- rbi/stripe/resources/tax_rate.rbi | 4 +- rbi/stripe/resources/terminal/location.rbi | 2 +- rbi/stripe/resources/token.rbi | 4 +- rbi/stripe/resources/transfer.rbi | 2 +- .../account_external_account_service.rbi | 2 +- .../services/account_login_link_service.rbi | 2 +- rbi/stripe/services/account_service.rbi | 22 +- rbi/stripe/services/balance_service.rbi | 2 +- .../services/balance_settings_service.rbi | 4 +- rbi/stripe/services/charge_service.rbi | 8 +- .../services/checkout/session_service.rbi | 2 +- rbi/stripe/services/credit_note_service.rbi | 2 +- .../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 | 2 +- rbi/stripe/services/dispute_service.rbi | 2 +- .../services/external_account_service.rbi | 2 +- rbi/stripe/services/file_service.rbi | 2 +- .../identity/verification_session_service.rbi | 10 +- rbi/stripe/services/invoice_service.rbi | 16 +- .../issuing/authorization_service.rbi | 8 +- .../services/issuing/dispute_service.rbi | 4 +- rbi/stripe/services/order_service.rbi | 2 +- .../services/payment_intent_service.rbi | 36 +- .../payment_method_domain_service.rbi | 2 +- .../services/payment_method_service.rbi | 16 +- rbi/stripe/services/payout_service.rbi | 4 +- rbi/stripe/services/plan_service.rbi | 2 +- rbi/stripe/services/price_service.rbi | 4 +- rbi/stripe/services/product_service.rbi | 2 +- .../services/promotion_code_service.rbi | 2 +- .../radar/early_fraud_warning_service.rbi | 2 +- rbi/stripe/services/setup_intent_service.rbi | 6 +- rbi/stripe/services/source_service.rbi | 2 +- rbi/stripe/services/subscription_service.rbi | 16 +- .../services/terminal/location_service.rbi | 2 +- rbi/stripe/services/token_service.rbi | 2 +- rbi/stripe/services/transfer_service.rbi | 2 +- 135 files changed, 735 insertions(+), 735 deletions(-) diff --git a/lib/stripe/resources/account.rb b/lib/stripe/resources/account.rb index d76944f6..9c90496d 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 @@ -5406,21 +5406,21 @@ module Stripe # 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 = {}) @@ -5432,11 +5432,11 @@ module Stripe ) 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 = {}) @@ -5448,7 +5448,7 @@ module Stripe ) 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 @@ -5473,7 +5473,7 @@ module Stripe ) 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 = {}) @@ -5485,7 +5485,7 @@ module Stripe ) 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 = {}) @@ -5497,19 +5497,19 @@ module Stripe ) 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/bank_account.rb b/lib/stripe/resources/bank_account.rb index 493385e4..276550fb 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 c87e54f4..d2412712 100644 --- a/lib/stripe/resources/billing_portal/session.rb +++ b/lib/stripe/resources/billing_portal/session.rb @@ -16,7 +16,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 extend Stripe::APIOperations::Create diff --git a/lib/stripe/resources/charge.rb b/lib/stripe/resources/charge.rb index 8ed64c67..fc72887d 100644 --- a/lib/stripe/resources/charge.rb +++ b/lib/stripe/resources/charge.rb @@ -3182,9 +3182,9 @@ 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). def capture(params = {}, opts = {}) request_stripe_object( method: :post, @@ -3196,9 +3196,9 @@ 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). def self.capture(charge, params = {}, opts = {}) request_stripe_object( method: :post, @@ -3208,7 +3208,7 @@ module Stripe ) 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 13b8b4ea..3c199e48 100644 --- a/lib/stripe/resources/checkout/session.rb +++ b/lib/stripe/resources/checkout/session.rb @@ -3994,7 +3994,7 @@ module Stripe # Updates a Checkout Session object. # - # Related guide: [Dynamically update Checkout](https://stripe.com/payments/checkout/dynamic-updates) + # 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/country_spec.rb b/lib/stripe/resources/country_spec.rb index d448586e..e2fb0c71 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/credit_note.rb b/lib/stripe/resources/credit_note.rb index 284c8fcc..23456683 100644 --- a/lib/stripe/resources/credit_note.rb +++ b/lib/stripe/resources/credit_note.rb @@ -716,7 +716,7 @@ module Stripe ) 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, @@ -726,7 +726,7 @@ module Stripe ) 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_session.rb b/lib/stripe/resources/customer_session.rb index 1e0f357a..db3ec438 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 396b5ec4..4c7f6f4a 100644 --- a/lib/stripe/resources/dispute.rb +++ b/lib/stripe/resources/dispute.rb @@ -657,7 +657,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). def self.update(dispute, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/file.rb b/lib/stripe/resources/file.rb index 665385e2..f17612a8 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_session.rb b/lib/stripe/resources/identity/verification_session.rb index ad3ecc11..95c3eba7 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. # @@ -392,9 +392,9 @@ module Stripe # 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, @@ -404,9 +404,9 @@ module Stripe ) 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, @@ -422,7 +422,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) def self.create(params = {}, opts = {}) request_stripe_object( method: :post, @@ -447,7 +447,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 @@ -460,7 +460,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). def redact(params = {}, opts = {}) request_stripe_object( method: :post, @@ -475,7 +475,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 @@ -488,7 +488,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). 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 6a08dbd1..58f4697b 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. # @@ -4343,7 +4343,7 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. def attach_payment(params = {}, opts = {}) request_stripe_object( method: :post, @@ -4362,7 +4362,7 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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, @@ -4372,7 +4372,7 @@ module Stripe ) 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. + # 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 @@ -4393,7 +4393,7 @@ module Stripe ) 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, @@ -4403,7 +4403,7 @@ module Stripe ) 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, @@ -4530,11 +4530,11 @@ module Stripe ) 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( @@ -4565,9 +4565,9 @@ module Stripe ) 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, @@ -4577,9 +4577,9 @@ module Stripe ) 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/issuing/authorization.rb b/lib/stripe/resources/issuing/authorization.rb index dd3cce9e..68c7746b 100644 --- a/lib/stripe/resources/issuing/authorization.rb +++ b/lib/stripe/resources/issuing/authorization.rb @@ -1122,8 +1122,8 @@ module Stripe # 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 @@ module Stripe 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 @@ module Stripe 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 @@ module Stripe 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/dispute.rb b/lib/stripe/resources/issuing/dispute.rb index 62aae499..abf1a0b2 100644 --- a/lib/stripe/resources/issuing/dispute.rb +++ b/lib/stripe/resources/issuing/dispute.rb @@ -797,7 +797,7 @@ module Stripe # [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 @@ module Stripe ) 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 @@ module Stripe ) 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/order.rb b/lib/stripe/resources/order.rb index 27d85117..3f8004b6 100644 --- a/lib/stripe/resources/order.rb +++ b/lib/stripe/resources/order.rb @@ -2773,7 +2773,7 @@ module Stripe ) end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. def submit(params = {}, opts = {}) request_stripe_object( method: :post, @@ -2783,7 +2783,7 @@ module Stripe ) end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. def self.submit(id, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/payment_intent.rb b/lib/stripe/resources/payment_intent.rb index eabab44a..7dc823f8 100644 --- a/lib/stripe/resources/payment_intent.rb +++ b/lib/stripe/resources/payment_intent.rb @@ -13538,11 +13538,11 @@ module Stripe ) 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, @@ -13552,11 +13552,11 @@ module Stripe ) 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, @@ -13570,7 +13570,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). def capture(params = {}, opts = {}) request_stripe_object( method: :post, @@ -13584,7 +13584,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). def self.capture(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -13605,8 +13605,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 @@ -13639,8 +13639,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 @@ -13664,22 +13664,22 @@ 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. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/payment_intents", params: params, opts: opts) end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -13687,7 +13687,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -13702,9 +13702,9 @@ module Stripe end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -13712,7 +13712,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -13727,9 +13727,9 @@ module Stripe 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 @@ -13740,16 +13740,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). def increment_authorization(params = {}, opts = {}) request_stripe_object( method: :post, @@ -13760,9 +13760,9 @@ module Stripe 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 @@ -13773,16 +13773,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). def self.increment_authorization(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -13836,7 +13836,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. 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 7e2e5dba..8eeb7ae1 100644 --- a/lib/stripe/resources/payment_method.rb +++ b/lib/stripe/resources/payment_method.rb @@ -1703,16 +1703,16 @@ 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. def attach(params = {}, opts = {}) request_stripe_object( @@ -1725,16 +1725,16 @@ 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. def self.attach(payment_method, params = {}, opts = {}) request_stripe_object( @@ -1745,9 +1745,9 @@ module Stripe ) 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 @@ -1772,7 +1772,7 @@ module Stripe ) 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_domain.rb b/lib/stripe/resources/payment_method_domain.rb index efee2edb..ce64acf5 100644 --- a/lib/stripe/resources/payment_method_domain.rb +++ b/lib/stripe/resources/payment_method_domain.rb @@ -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). def validate(params = {}, opts = {}) request_stripe_object( method: :post, @@ -223,7 +223,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). 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 9c064abe..30eb7578 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) @@ -255,11 +255,11 @@ module Stripe ) 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 c104a11f..660184b7 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 07506a99..e94b9a99 100644 --- a/lib/stripe/resources/plan.rb +++ b/lib/stripe/resources/plan.rb @@ -322,7 +322,7 @@ module Stripe # 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 47d9fec8..bfa70f2f 100644 --- a/lib/stripe/resources/price.rb +++ b/lib/stripe/resources/price.rb @@ -658,7 +658,7 @@ module Stripe 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/quote_preview_invoice.rb b/lib/stripe/resources/quote_preview_invoice.rb index 74ef1c08..d3ebd009 100644 --- a/lib/stripe/resources/quote_preview_invoice.rb +++ b/lib/stripe/resources/quote_preview_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. # diff --git a/lib/stripe/resources/reversal.rb b/lib/stripe/resources/reversal.rb index 9ae78179..2f067d99 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 c25c2c03..11a3fe65 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 5ff5e3c4..e737fc26 100644 --- a/lib/stripe/resources/setup_intent.rb +++ b/lib/stripe/resources/setup_intent.rb @@ -3916,7 +3916,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. def cancel(params = {}, opts = {}) request_stripe_object( method: :post, @@ -3928,7 +3928,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. def self.cancel(intent, params = {}, opts = {}) request_stripe_object( method: :post, @@ -3986,7 +3986,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. 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 03ce9fd6..2fc586a1 100644 --- a/lib/stripe/resources/source.rb +++ b/lib/stripe/resources/source.rb @@ -1258,7 +1258,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. 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 2223fbf0..61421588 100644 --- a/lib/stripe/resources/subscription.rb +++ b/lib/stripe/resources/subscription.rb @@ -1999,9 +1999,9 @@ module Stripe # If the subscription has a trial, the beginning of that trial. 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 = {}) @@ -2013,9 +2013,9 @@ module Stripe ) 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 = {}) @@ -2032,7 +2032,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. def self.create(params = {}, opts = {}) request_stripe_object(method: :post, path: "/v1/subscriptions", params: params, opts: opts) @@ -2118,7 +2118,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. # @@ -2130,13 +2130,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. def self.update(subscription_exposed_id, params = {}, opts = {}) request_stripe_object( method: :post, diff --git a/lib/stripe/resources/tax_rate.rb b/lib/stripe/resources/tax_rate.rb index 91706665..df6d459a 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/location.rb b/lib/stripe/resources/terminal/location.rb index e73b03dc..e24aed52 100644 --- a/lib/stripe/resources/terminal/location.rb +++ b/lib/stripe/resources/terminal/location.rb @@ -183,7 +183,7 @@ module Stripe 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/token.rb b/lib/stripe/resources/token.rb index 52a4752c..065129b6 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 @@ module Stripe 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 1171b333..565a3517 100644 --- a/lib/stripe/resources/transfer.rb +++ b/lib/stripe/resources/transfer.rb @@ -175,7 +175,7 @@ module Stripe # 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/services/account_external_account_service.rb b/lib/stripe/services/account_external_account_service.rb index b1cc3759..a8315369 100644 --- a/lib/stripe/services/account_external_account_service.rb +++ b/lib/stripe/services/account_external_account_service.rb @@ -300,7 +300,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/lib/stripe/services/account_login_link_service.rb b/lib/stripe/services/account_login_link_service.rb index 80b16c8b..c2151852 100644 --- a/lib/stripe/services/account_login_link_service.rb +++ b/lib/stripe/services/account_login_link_service.rb @@ -14,7 +14,7 @@ module Stripe # 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_service.rb b/lib/stripe/services/account_service.rb index 1b33a40b..cae44b74 100644 --- a/lib/stripe/services/account_service.rb +++ b/lib/stripe/services/account_service.rb @@ -4645,21 +4645,21 @@ module Stripe 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 = {}) @@ -4672,12 +4672,12 @@ module Stripe ) 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 = {}) @@ -4706,19 +4706,19 @@ module Stripe 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/balance_service.rb b/lib/stripe/services/balance_service.rb index 2849e754..8d252438 100644 --- a/lib/stripe/services/balance_service.rb +++ b/lib/stripe/services/balance_service.rb @@ -13,7 +13,7 @@ module Stripe 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/balance_settings_service.rb b/lib/stripe/services/balance_settings_service.rb index e569d583..9842f319 100644 --- a/lib/stripe/services/balance_settings_service.rb +++ b/lib/stripe/services/balance_settings_service.rb @@ -70,7 +70,7 @@ module Stripe end # Retrieves balance settings for a given connected account. - # Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication) + # Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication) def retrieve(params = {}, opts = {}) request( method: :get, @@ -82,7 +82,7 @@ module Stripe end # Updates balance settings for a given connected account. - # Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication) + # Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication) def update(params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/charge_service.rb b/lib/stripe/services/charge_service.rb index 120e772a..75349302 100644 --- a/lib/stripe/services/charge_service.rb +++ b/lib/stripe/services/charge_service.rb @@ -1825,9 +1825,9 @@ 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). def capture(charge, params = {}, opts = {}) request( method: :post, @@ -1838,7 +1838,7 @@ module Stripe ) 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 = {}) @@ -1861,7 +1861,7 @@ module Stripe ) 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 207ca896..97290dd0 100644 --- a/lib/stripe/services/checkout/session_service.rb +++ b/lib/stripe/services/checkout/session_service.rb @@ -2725,7 +2725,7 @@ module Stripe # Updates a Checkout Session object. # - # Related guide: [Dynamically update Checkout](https://stripe.com/payments/checkout/dynamic-updates) + # 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/credit_note_service.rb b/lib/stripe/services/credit_note_service.rb index d9a3fadf..3d983c80 100644 --- a/lib/stripe/services/credit_note_service.rb +++ b/lib/stripe/services/credit_note_service.rb @@ -447,7 +447,7 @@ module Stripe ) 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 4a7bd9c8..c82cba43 100644 --- a/lib/stripe/services/customer_balance_transaction_service.rb +++ b/lib/stripe/services/customer_balance_transaction_service.rb @@ -66,7 +66,7 @@ module Stripe 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 @@ module Stripe ) 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 @@ module Stripe ) 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 fa7b07df..f88065d8 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 @@ module Stripe 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 @@ module Stripe ) 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 462d3804..ce17df94 100644 --- a/lib/stripe/services/customer_payment_source_service.rb +++ b/lib/stripe/services/customer_payment_source_service.rb @@ -186,7 +186,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. 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 0474acab..1d0e5802 100644 --- a/lib/stripe/services/customer_service.rb +++ b/lib/stripe/services/customer_service.rb @@ -634,7 +634,7 @@ module Stripe ) 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/dispute_service.rb b/lib/stripe/services/dispute_service.rb index ce23b5ce..cc266abd 100644 --- a/lib/stripe/services/dispute_service.rb +++ b/lib/stripe/services/dispute_service.rb @@ -408,7 +408,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). def update(dispute, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/external_account_service.rb b/lib/stripe/services/external_account_service.rb index 4f4c1b80..2775f200 100644 --- a/lib/stripe/services/external_account_service.rb +++ b/lib/stripe/services/external_account_service.rb @@ -300,7 +300,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/lib/stripe/services/file_service.rb b/lib/stripe/services/file_service.rb index 6304b84c..bb2adff9 100644 --- a/lib/stripe/services/file_service.rb +++ b/lib/stripe/services/file_service.rb @@ -110,7 +110,7 @@ module Stripe 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 e9c64af5..0e67c98d 100644 --- a/lib/stripe/services/identity/verification_session_service.rb +++ b/lib/stripe/services/identity/verification_session_service.rb @@ -243,9 +243,9 @@ module Stripe 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, @@ -262,7 +262,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) def create(params = {}, opts = {}) request( method: :post, @@ -289,7 +289,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 @@ -302,7 +302,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). def redact(session, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/invoice_service.rb b/lib/stripe/services/invoice_service.rb index 56e8d467..e1569f6b 100644 --- a/lib/stripe/services/invoice_service.rb +++ b/lib/stripe/services/invoice_service.rb @@ -3687,7 +3687,7 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more. def attach_payment(invoice, params = {}, opts = {}) request( method: :post, @@ -3698,7 +3698,7 @@ module Stripe ) 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. + # 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 @@ -3720,7 +3720,7 @@ module Stripe ) 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, @@ -3791,7 +3791,7 @@ module Stripe ) 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. @@ -3818,11 +3818,11 @@ module Stripe ) 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( @@ -3845,9 +3845,9 @@ module Stripe ) 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 77c99384..ebecd780 100644 --- a/lib/stripe/services/issuing/authorization_service.rb +++ b/lib/stripe/services/issuing/authorization_service.rb @@ -108,8 +108,8 @@ module Stripe 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 @@ module Stripe ) 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/dispute_service.rb b/lib/stripe/services/issuing/dispute_service.rb index d172a921..bafb3fda 100644 --- a/lib/stripe/services/issuing/dispute_service.rb +++ b/lib/stripe/services/issuing/dispute_service.rb @@ -637,7 +637,7 @@ module Stripe 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 @@ module Stripe ) 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/order_service.rb b/lib/stripe/services/order_service.rb index a25f538b..1bd0b53a 100644 --- a/lib/stripe/services/order_service.rb +++ b/lib/stripe/services/order_service.rb @@ -2211,7 +2211,7 @@ module Stripe ) end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. def submit(id, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/payment_intent_service.rb b/lib/stripe/services/payment_intent_service.rb index d1da069f..1bec027a 100644 --- a/lib/stripe/services/payment_intent_service.rb +++ b/lib/stripe/services/payment_intent_service.rb @@ -11463,11 +11463,11 @@ module Stripe ) 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, @@ -11482,7 +11482,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). def capture(intent, params = {}, opts = {}) request( method: :post, @@ -11504,8 +11504,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 @@ -11530,13 +11530,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. def create(params = {}, opts = {}) request( @@ -11549,9 +11549,9 @@ module Stripe end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -11559,7 +11559,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -11575,9 +11575,9 @@ module Stripe 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 @@ -11588,16 +11588,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). def increment_authorization(intent, params = {}, opts = {}) request( method: :post, @@ -11623,7 +11623,7 @@ 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. def retrieve(intent, params = {}, opts = {}) request( method: :get, @@ -11634,7 +11634,7 @@ module Stripe ) 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. @@ -11665,7 +11665,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. def update(intent, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/payment_method_domain_service.rb b/lib/stripe/services/payment_method_domain_service.rb index c37b26d6..ddef0072 100644 --- a/lib/stripe/services/payment_method_domain_service.rb +++ b/lib/stripe/services/payment_method_domain_service.rb @@ -128,7 +128,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). 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 7d1095fd..a6e47727 100644 --- a/lib/stripe/services/payment_method_service.rb +++ b/lib/stripe/services/payment_method_service.rb @@ -881,16 +881,16 @@ 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. def attach(payment_method, params = {}, opts = {}) request( @@ -902,9 +902,9 @@ module Stripe ) 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, @@ -926,7 +926,7 @@ module Stripe ) 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, @@ -937,7 +937,7 @@ module Stripe ) 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 07d81b81..4951daa0 100644 --- a/lib/stripe/services/payout_service.rb +++ b/lib/stripe/services/payout_service.rb @@ -177,11 +177,11 @@ module Stripe ) 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 25bbc268..af43832f 100644 --- a/lib/stripe/services/plan_service.rb +++ b/lib/stripe/services/plan_service.rb @@ -251,7 +251,7 @@ module Stripe 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 f4021fcc..ef6a827c 100644 --- a/lib/stripe/services/price_service.rb +++ b/lib/stripe/services/price_service.rb @@ -520,7 +520,7 @@ module Stripe 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 @@ -536,7 +536,7 @@ module Stripe ) 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_service.rb b/lib/stripe/services/product_service.rb index 99e88af1..ca9e1691 100644 --- a/lib/stripe/services/product_service.rb +++ b/lib/stripe/services/product_service.rb @@ -466,7 +466,7 @@ module Stripe ) 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 04aeaf53..fbd18448 100644 --- a/lib/stripe/services/promotion_code_service.rb +++ b/lib/stripe/services/promotion_code_service.rb @@ -211,7 +211,7 @@ module Stripe ) 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 3d957004..4ab5927d 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 @@ 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. def retrieve(early_fraud_warning, params = {}, opts = {}) request( method: :get, diff --git a/lib/stripe/services/setup_intent_service.rb b/lib/stripe/services/setup_intent_service.rb index 092d350d..bd9fbca6 100644 --- a/lib/stripe/services/setup_intent_service.rb +++ b/lib/stripe/services/setup_intent_service.rb @@ -3536,7 +3536,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. def cancel(intent, params = {}, opts = {}) request( method: :post, @@ -3573,7 +3573,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. def create(params = {}, opts = {}) request( @@ -3600,7 +3600,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. 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 5516671c..f8908c50 100644 --- a/lib/stripe/services/source_service.rb +++ b/lib/stripe/services/source_service.rb @@ -640,7 +640,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. def update(source, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/subscription_service.rb b/lib/stripe/services/subscription_service.rb index 5ef71f6e..0633e1f0 100644 --- a/lib/stripe/services/subscription_service.rb +++ b/lib/stripe/services/subscription_service.rb @@ -1664,9 +1664,9 @@ module Stripe 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 = {}) @@ -1684,7 +1684,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. def create(params = {}, opts = {}) request( @@ -1751,7 +1751,7 @@ module Stripe ) 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. @@ -1767,7 +1767,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. # @@ -1779,13 +1779,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. def update(subscription_exposed_id, params = {}, opts = {}) request( method: :post, diff --git a/lib/stripe/services/terminal/location_service.rb b/lib/stripe/services/terminal/location_service.rb index 4ff54d7f..a14d3bb4 100644 --- a/lib/stripe/services/terminal/location_service.rb +++ b/lib/stripe/services/terminal/location_service.rb @@ -148,7 +148,7 @@ module Stripe 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/token_service.rb b/lib/stripe/services/token_service.rb index 68215986..94c5ed60 100644 --- a/lib/stripe/services/token_service.rb +++ b/lib/stripe/services/token_service.rb @@ -1205,7 +1205,7 @@ module Stripe 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 a0f80951..944e1d35 100644 --- a/lib/stripe/services/transfer_service.rb +++ b/lib/stripe/services/transfer_service.rb @@ -133,7 +133,7 @@ module Stripe 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/rbi/stripe.rbi b/rbi/stripe.rbi index 6fee0803..5817f52a 100644 --- a/rbi/stripe.rbi +++ b/rbi/stripe.rbi @@ -4475,14 +4475,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 @@ -9934,10 +9934,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 { @@ -9945,11 +9945,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 { @@ -9957,11 +9957,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 { @@ -9969,7 +9969,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) } @@ -9987,7 +9987,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 { @@ -9995,7 +9995,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 { @@ -10003,19 +10003,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) } @@ -12339,11 +12339,11 @@ end 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 @@ -14227,7 +14227,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 @@ -18875,9 +18875,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) } @@ -18885,15 +18885,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 { @@ -23286,7 +23286,7 @@ module Stripe # Updates a Checkout Session object. # - # Related guide: [Dynamically update Checkout](https://stripe.com/payments/checkout/dynamic-updates) + # 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) } @@ -25712,7 +25712,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 @@ -26808,13 +26808,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) } @@ -28147,9 +28147,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 @@ -29149,7 +29149,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) } @@ -29674,7 +29674,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 @@ -31981,11 +31981,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. # @@ -32417,17 +32417,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) } @@ -32439,7 +32439,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) } @@ -32456,7 +32456,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 @@ -32469,7 +32469,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) } @@ -32480,7 +32480,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 @@ -32493,7 +32493,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) } @@ -32536,7 +32536,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. # @@ -37298,7 +37298,7 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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) } @@ -37313,13 +37313,13 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # 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) } @@ -37337,13 +37337,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) } @@ -37429,11 +37429,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) @@ -37452,17 +37452,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) } @@ -39431,29 +39431,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) } @@ -42461,7 +42461,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) } @@ -42473,13 +42473,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) } @@ -48380,13 +48380,13 @@ module Stripe } def self.reopen(id, params = {}, opts = {}); end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. sig { params(params: T.any(::Stripe::Order::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order) } def submit(params = {}, opts = {}); end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. sig { params(id: String, params: T.any(::Stripe::Order::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order) } @@ -64482,21 +64482,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) } @@ -64506,7 +64506,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) } @@ -64516,7 +64516,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) } @@ -64533,8 +64533,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 @@ -64563,8 +64563,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 @@ -64584,13 +64584,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) @@ -64598,9 +64598,9 @@ module Stripe def self.create(params = {}, opts = {}); end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -64608,7 +64608,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -64619,9 +64619,9 @@ module Stripe def decrement_authorization(params = {}, opts = {}); end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -64629,7 +64629,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -64640,9 +64640,9 @@ module Stripe def self.decrement_authorization(intent, 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 @@ -64653,25 +64653,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 @@ -64682,16 +64682,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) } @@ -64731,7 +64731,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) } @@ -68527,16 +68527,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) @@ -68545,25 +68545,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) } @@ -68581,7 +68581,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) } @@ -72678,7 +72678,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) } @@ -72689,7 +72689,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) } @@ -74596,9 +74596,9 @@ end 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) @@ -74857,11 +74857,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) } @@ -74900,9 +74900,9 @@ end 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 @@ -75631,7 +75631,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) } @@ -76361,7 +76361,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) } @@ -81151,7 +81151,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. # @@ -83607,7 +83607,7 @@ end 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 @@ -88498,7 +88498,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) } @@ -88506,7 +88506,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) } @@ -88552,7 +88552,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) @@ -90401,7 +90401,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) } @@ -92809,9 +92809,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 { @@ -92819,9 +92819,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 { @@ -92834,7 +92834,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) @@ -92895,7 +92895,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. # @@ -92907,13 +92907,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) } @@ -100296,9 +100296,9 @@ module Stripe end # 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). @@ -102134,7 +102134,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) } @@ -103348,7 +103348,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 @@ -104602,7 +104602,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) } @@ -105010,7 +105010,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) } @@ -105039,7 +105039,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 @@ -113793,10 +113793,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 { @@ -113804,11 +113804,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 { @@ -113816,13 +113816,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 { @@ -113842,19 +113842,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) } @@ -114200,7 +114200,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. @@ -114222,7 +114222,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) } @@ -116652,7 +116652,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) } @@ -116729,14 +116729,14 @@ module Stripe ); end end # Retrieves balance settings for a given connected account. - # Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication) + # Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication) sig { params(params: T.any(::Stripe::BalanceSettingsService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceSettings) } def retrieve(params = {}, opts = {}); end # Updates balance settings for a given connected account. - # Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication) + # Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication) sig { params(params: T.any(::Stripe::BalanceSettingsService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceSettings) } @@ -120446,15 +120446,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 { @@ -120474,7 +120474,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. @@ -123368,7 +123368,7 @@ module Stripe # Updates a Checkout Session object. # - # Related guide: [Dynamically update Checkout](https://stripe.com/payments/checkout/dynamic-updates) + # 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) } @@ -127643,7 +127643,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) } @@ -128468,7 +128468,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. @@ -128592,19 +128592,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) } @@ -128645,13 +128645,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) } @@ -128850,7 +128850,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)) } @@ -129594,7 +129594,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) } @@ -130041,7 +130041,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) } @@ -131234,9 +131234,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) } @@ -131248,7 +131248,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) } @@ -131265,7 +131265,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 @@ -131278,7 +131278,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) } @@ -135260,13 +135260,13 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # 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) } @@ -135284,7 +135284,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) } @@ -135326,7 +135326,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. @@ -135343,11 +135343,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) @@ -135360,9 +135360,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) } @@ -136308,15 +136308,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) } @@ -138600,7 +138600,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) } @@ -138618,7 +138618,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) } @@ -141698,7 +141698,7 @@ module Stripe } def retrieve(id, params = {}, opts = {}); end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. sig { params(id: String, params: T.any(::Stripe::OrderService::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order) } @@ -154066,11 +154066,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) } @@ -154080,7 +154080,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) } @@ -154097,8 +154097,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 @@ -154118,13 +154118,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) @@ -154132,9 +154132,9 @@ module Stripe def create(params = {}, opts = {}); end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -154142,7 +154142,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -154153,9 +154153,9 @@ module Stripe def decrement_authorization(intent, 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 @@ -154166,16 +154166,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) } @@ -154191,13 +154191,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. @@ -154218,7 +154218,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) } @@ -156472,25 +156472,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) } @@ -156502,13 +156502,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) } @@ -159335,7 +159335,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) } @@ -160039,11 +160039,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) } @@ -160324,7 +160324,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) } @@ -160889,7 +160889,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) } @@ -160901,7 +160901,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. @@ -161601,7 +161601,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. @@ -161887,7 +161887,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) } @@ -164621,7 +164621,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) } @@ -169332,7 +169332,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) } @@ -169359,7 +169359,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) @@ -169376,7 +169376,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) } @@ -170280,7 +170280,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) } @@ -172102,9 +172102,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 { @@ -172117,7 +172117,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) @@ -172154,7 +172154,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. @@ -172165,7 +172165,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. # @@ -172177,13 +172177,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) } @@ -178885,7 +178885,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) } @@ -180714,7 +180714,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) } @@ -181026,7 +181026,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) } @@ -183468,7 +183468,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/resources/account.rbi b/rbi/stripe/resources/account.rbi index ee0e8d1c..9f80222e 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 @@ -5466,10 +5466,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 { @@ -5477,11 +5477,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 { @@ -5489,11 +5489,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 { @@ -5501,7 +5501,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) } @@ -5519,7 +5519,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 { @@ -5527,7 +5527,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 { @@ -5535,19 +5535,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/bank_account.rbi b/rbi/stripe/resources/bank_account.rbi index 0ebd435c..97178f00 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_portal/session.rbi b/rbi/stripe/resources/billing_portal/session.rbi index 0bb17a71..c9a96397 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/charge.rbi b/rbi/stripe/resources/charge.rbi index a27b8471..d4e2f823 100644 --- a/rbi/stripe/resources/charge.rbi +++ b/rbi/stripe/resources/charge.rbi @@ -3669,9 +3669,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) } @@ -3679,15 +3679,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 acb6895d..c2641718 100644 --- a/rbi/stripe/resources/checkout/session.rbi +++ b/rbi/stripe/resources/checkout/session.rbi @@ -4363,7 +4363,7 @@ module Stripe # Updates a Checkout Session object. # - # Related guide: [Dynamically update Checkout](https://stripe.com/payments/checkout/dynamic-updates) + # 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/country_spec.rbi b/rbi/stripe/resources/country_spec.rbi index d710eb6d..cc7c8825 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/credit_note.rbi b/rbi/stripe/resources/credit_note.rbi index b8abd111..6979b9bc 100644 --- a/rbi/stripe/resources/credit_note.rbi +++ b/rbi/stripe/resources/credit_note.rbi @@ -744,13 +744,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_session.rbi b/rbi/stripe/resources/customer_session.rbi index d9f56f0e..446fbe3f 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 a55092e1..5218bf78 100644 --- a/rbi/stripe/resources/dispute.rbi +++ b/rbi/stripe/resources/dispute.rbi @@ -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/file.rbi b/rbi/stripe/resources/file.rbi index 5c84685f..3ba13dd8 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_session.rbi b/rbi/stripe/resources/identity/verification_session.rbi index 01bf7a9a..4c65dc37 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. # @@ -442,17 +442,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) } @@ -464,7 +464,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) } @@ -481,7 +481,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 @@ -494,7 +494,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) } @@ -505,7 +505,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 @@ -518,7 +518,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 0bbc14f6..af9655ea 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. # @@ -4789,7 +4789,7 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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) } @@ -4804,13 +4804,13 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # 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) } @@ -4828,13 +4828,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) } @@ -4920,11 +4920,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) @@ -4943,17 +4943,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/issuing/authorization.rbi b/rbi/stripe/resources/issuing/authorization.rbi index 801b5cd0..70ec3087 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/dispute.rbi b/rbi/stripe/resources/issuing/dispute.rbi index 7a5adf79..dbe0f5db 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/order.rbi b/rbi/stripe/resources/order.rbi index 69f93359..5498e8d3 100644 --- a/rbi/stripe/resources/order.rbi +++ b/rbi/stripe/resources/order.rbi @@ -3002,13 +3002,13 @@ module Stripe } def self.reopen(id, params = {}, opts = {}); end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. sig { params(params: T.any(::Stripe::Order::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order) } def submit(params = {}, opts = {}); end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. sig { params(id: String, params: T.any(::Stripe::Order::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order) } diff --git a/rbi/stripe/resources/payment_intent.rbi b/rbi/stripe/resources/payment_intent.rbi index 837f7c32..1477b780 100644 --- a/rbi/stripe/resources/payment_intent.rbi +++ b/rbi/stripe/resources/payment_intent.rbi @@ -14702,21 +14702,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) } @@ -14726,7 +14726,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) } @@ -14736,7 +14736,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) } @@ -14753,8 +14753,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 @@ -14783,8 +14783,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 @@ -14804,13 +14804,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) @@ -14818,9 +14818,9 @@ module Stripe def self.create(params = {}, opts = {}); end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -14828,7 +14828,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -14839,9 +14839,9 @@ module Stripe def decrement_authorization(params = {}, opts = {}); end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -14849,7 +14849,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -14860,9 +14860,9 @@ module Stripe def self.decrement_authorization(intent, 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 @@ -14873,25 +14873,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 @@ -14902,16 +14902,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) } @@ -14951,7 +14951,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 893081f1..d72a5c72 100644 --- a/rbi/stripe/resources/payment_method.rbi +++ b/rbi/stripe/resources/payment_method.rbi @@ -1897,16 +1897,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) @@ -1915,25 +1915,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) } @@ -1951,7 +1951,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_domain.rbi b/rbi/stripe/resources/payment_method_domain.rbi index 706ebabd..8be1896d 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 9200bf3e..e7520981 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) @@ -266,11 +266,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 1d70146b..e0f26eb1 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 d8da1060..4d32080b 100644 --- a/rbi/stripe/resources/plan.rbi +++ b/rbi/stripe/resources/plan.rbi @@ -338,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 2faff8e6..b4ed8d49 100644 --- a/rbi/stripe/resources/price.rbi +++ b/rbi/stripe/resources/price.rbi @@ -700,7 +700,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/quote_preview_invoice.rbi b/rbi/stripe/resources/quote_preview_invoice.rbi index 90d832df..9be3c2b4 100644 --- a/rbi/stripe/resources/quote_preview_invoice.rbi +++ b/rbi/stripe/resources/quote_preview_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. # diff --git a/rbi/stripe/resources/reversal.rbi b/rbi/stripe/resources/reversal.rbi index 4e79bbbd..575c8482 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 5e1c1b21..abe80514 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 717c8cc7..93721ae9 100644 --- a/rbi/stripe/resources/setup_intent.rbi +++ b/rbi/stripe/resources/setup_intent.rbi @@ -4171,7 +4171,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) } @@ -4179,7 +4179,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) } @@ -4225,7 +4225,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 e234dea1..d711e480 100644 --- a/rbi/stripe/resources/source.rbi +++ b/rbi/stripe/resources/source.rbi @@ -1516,7 +1516,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 238cb638..d3ebbc40 100644 --- a/rbi/stripe/resources/subscription.rbi +++ b/rbi/stripe/resources/subscription.rbi @@ -2192,9 +2192,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 { @@ -2202,9 +2202,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 { @@ -2217,7 +2217,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) @@ -2278,7 +2278,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. # @@ -2290,13 +2290,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/tax_rate.rbi b/rbi/stripe/resources/tax_rate.rbi index f02e4561..f103960e 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/location.rbi b/rbi/stripe/resources/terminal/location.rbi index cc21d84a..97cf7377 100644 --- a/rbi/stripe/resources/terminal/location.rbi +++ b/rbi/stripe/resources/terminal/location.rbi @@ -188,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/token.rbi b/rbi/stripe/resources/token.rbi index 6a50b0f2..e7baa992 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 c529886c..0ab30758 100644 --- a/rbi/stripe/resources/transfer.rbi +++ b/rbi/stripe/resources/transfer.rbi @@ -183,7 +183,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/services/account_external_account_service.rbi b/rbi/stripe/services/account_external_account_service.rbi index f835ac65..8e705b74 100644 --- a/rbi/stripe/services/account_external_account_service.rbi +++ b/rbi/stripe/services/account_external_account_service.rbi @@ -292,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 d9aea262..558a4645 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_service.rbi b/rbi/stripe/services/account_service.rbi index 86bc3488..400496cc 100644 --- a/rbi/stripe/services/account_service.rbi +++ b/rbi/stripe/services/account_service.rbi @@ -4691,10 +4691,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 { @@ -4702,11 +4702,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 { @@ -4714,13 +4714,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 { @@ -4740,19 +4740,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/balance_service.rbi b/rbi/stripe/services/balance_service.rbi index 9021deca..2aa45b30 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/balance_settings_service.rbi b/rbi/stripe/services/balance_settings_service.rbi index d74b29ff..471f8fc6 100644 --- a/rbi/stripe/services/balance_settings_service.rbi +++ b/rbi/stripe/services/balance_settings_service.rbi @@ -71,14 +71,14 @@ module Stripe ); end end # Retrieves balance settings for a given connected account. - # Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication) + # Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication) sig { params(params: T.any(::Stripe::BalanceSettingsService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceSettings) } def retrieve(params = {}, opts = {}); end # Updates balance settings for a given connected account. - # Related guide: [Making API calls for connected accounts](https://stripe.com/connect/authentication) + # Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication) sig { params(params: T.any(::Stripe::BalanceSettingsService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::BalanceSettings) } diff --git a/rbi/stripe/services/charge_service.rbi b/rbi/stripe/services/charge_service.rbi index 72b76afc..a088060d 100644 --- a/rbi/stripe/services/charge_service.rbi +++ b/rbi/stripe/services/charge_service.rbi @@ -1914,15 +1914,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 { @@ -1942,7 +1942,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 6f80e2f8..f4dff3cc 100644 --- a/rbi/stripe/services/checkout/session_service.rbi +++ b/rbi/stripe/services/checkout/session_service.rbi @@ -2873,7 +2873,7 @@ module Stripe # Updates a Checkout Session object. # - # Related guide: [Dynamically update Checkout](https://stripe.com/payments/checkout/dynamic-updates) + # 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/credit_note_service.rbi b/rbi/stripe/services/credit_note_service.rbi index edaf2ecc..4e71c72e 100644 --- a/rbi/stripe/services/credit_note_service.rbi +++ b/rbi/stripe/services/credit_note_service.rbi @@ -410,7 +410,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 e48fdc9e..96af3807 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 8814a7dc..56892fec 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 efe721c0..a0519a86 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 5488506d..8b7824be 100644 --- a/rbi/stripe/services/customer_service.rbi +++ b/rbi/stripe/services/customer_service.rbi @@ -627,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/dispute_service.rbi b/rbi/stripe/services/dispute_service.rbi index 8e72c140..35bd072f 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/external_account_service.rbi b/rbi/stripe/services/external_account_service.rbi index 0d8234f4..fba8d287 100644 --- a/rbi/stripe/services/external_account_service.rbi +++ b/rbi/stripe/services/external_account_service.rbi @@ -292,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/file_service.rbi b/rbi/stripe/services/file_service.rbi index 5482889d..d70d802e 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 71ebe1c3..5c82c3e5 100644 --- a/rbi/stripe/services/identity/verification_session_service.rbi +++ b/rbi/stripe/services/identity/verification_session_service.rbi @@ -259,9 +259,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) } @@ -273,7 +273,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) } @@ -290,7 +290,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 @@ -303,7 +303,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_service.rbi b/rbi/stripe/services/invoice_service.rbi index e093c13c..2bba5591 100644 --- a/rbi/stripe/services/invoice_service.rbi +++ b/rbi/stripe/services/invoice_service.rbi @@ -3957,13 +3957,13 @@ module Stripe # If the PaymentIntent's status is already succeeded when it's attached, it's # credited to the invoice immediately. # - # See: [Partial payments](https://stripe.com/docs/invoicing/partial-payments) to learn more. + # 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://stripe.com/docs/api#finalize_invoice) the invoice to your customers. + # 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) } @@ -3981,7 +3981,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) } @@ -4023,7 +4023,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. @@ -4040,11 +4040,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) @@ -4057,9 +4057,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 d3f679e8..4ca654f7 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/dispute_service.rbi b/rbi/stripe/services/issuing/dispute_service.rbi index 8b288676..49db7885 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/order_service.rbi b/rbi/stripe/services/order_service.rbi index f7f30341..11a58c2f 100644 --- a/rbi/stripe/services/order_service.rbi +++ b/rbi/stripe/services/order_service.rbi @@ -2327,7 +2327,7 @@ module Stripe } def retrieve(id, params = {}, opts = {}); end - # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called. + # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://docs.stripe.com/api#reopen_order) method is called. sig { params(id: String, params: T.any(::Stripe::OrderService::SubmitParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Order) } diff --git a/rbi/stripe/services/payment_intent_service.rbi b/rbi/stripe/services/payment_intent_service.rbi index 6bd914ad..08136f69 100644 --- a/rbi/stripe/services/payment_intent_service.rbi +++ b/rbi/stripe/services/payment_intent_service.rbi @@ -12295,11 +12295,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) } @@ -12309,7 +12309,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) } @@ -12326,8 +12326,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 @@ -12347,13 +12347,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) @@ -12361,9 +12361,9 @@ module Stripe def create(params = {}, opts = {}); end # Perform a decremental 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 - # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) + # [decremental_authorization.status](https://docs.stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization) # must be available. # # Decremental authorizations decrease the authorized amount on your customer's card @@ -12371,7 +12371,7 @@ module Stripe # # After decrement, 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). # The PaymentIntent will now be capturable up to the new authorized amount. # # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines. @@ -12382,9 +12382,9 @@ module Stripe def decrement_authorization(intent, 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 @@ -12395,16 +12395,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) } @@ -12420,13 +12420,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. @@ -12447,7 +12447,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_domain_service.rbi b/rbi/stripe/services/payment_method_domain_service.rbi index ccd97652..c8f532f9 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 b65836ea..57c5280c 100644 --- a/rbi/stripe/services/payment_method_service.rbi +++ b/rbi/stripe/services/payment_method_service.rbi @@ -837,25 +837,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) } @@ -867,13 +867,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 6a26076a..14596e16 100644 --- a/rbi/stripe/services/payout_service.rbi +++ b/rbi/stripe/services/payout_service.rbi @@ -170,11 +170,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 6f5f3eb1..2959c73d 100644 --- a/rbi/stripe/services/plan_service.rbi +++ b/rbi/stripe/services/plan_service.rbi @@ -249,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 4f5105d6..e8dd470a 100644 --- a/rbi/stripe/services/price_service.rbi +++ b/rbi/stripe/services/price_service.rbi @@ -535,7 +535,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) } @@ -547,7 +547,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_service.rbi b/rbi/stripe/services/product_service.rbi index 40301d2e..df26b568 100644 --- a/rbi/stripe/services/product_service.rbi +++ b/rbi/stripe/services/product_service.rbi @@ -459,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 4953dc26..90a8db5f 100644 --- a/rbi/stripe/services/promotion_code_service.rbi +++ b/rbi/stripe/services/promotion_code_service.rbi @@ -207,7 +207,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 1090fcf1..e99968f8 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/setup_intent_service.rbi b/rbi/stripe/services/setup_intent_service.rbi index a3c108a5..fd5f86ed 100644 --- a/rbi/stripe/services/setup_intent_service.rbi +++ b/rbi/stripe/services/setup_intent_service.rbi @@ -3915,7 +3915,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) } @@ -3942,7 +3942,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) @@ -3959,7 +3959,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 d927df7f..4b52a5ba 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_service.rbi b/rbi/stripe/services/subscription_service.rbi index e0788a50..2b5432d4 100644 --- a/rbi/stripe/services/subscription_service.rbi +++ b/rbi/stripe/services/subscription_service.rbi @@ -1782,9 +1782,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 { @@ -1797,7 +1797,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) @@ -1834,7 +1834,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. @@ -1845,7 +1845,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. # @@ -1857,13 +1857,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/terminal/location_service.rbi b/rbi/stripe/services/terminal/location_service.rbi index cdba851a..ffaa4e7f 100644 --- a/rbi/stripe/services/terminal/location_service.rbi +++ b/rbi/stripe/services/terminal/location_service.rbi @@ -148,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/token_service.rbi b/rbi/stripe/services/token_service.rbi index 6feaecb9..c1474d64 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 988a345a..358df04d 100644 --- a/rbi/stripe/services/transfer_service.rbi +++ b/rbi/stripe/services/transfer_service.rbi @@ -127,7 +127,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) }