stripe 5.28.0 → 8.7.0

data/lib/stripe/object_types.rb

@@ -1,3 +1,4 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 # rubocop:disable Metrics/MethodLength
@@ -8,22 +9,23 @@ module Stripe
       {
         # data structures
         ListObject::OBJECT_NAME => ListObject,
+        SearchResultObject::OBJECT_NAME => SearchResultObject,
 
         # business objects
         Account::OBJECT_NAME => Account,
         AccountLink::OBJECT_NAME => AccountLink,
-        AlipayAccount::OBJECT_NAME => AlipayAccount,
         ApplePayDomain::OBJECT_NAME => ApplePayDomain,
         ApplicationFee::OBJECT_NAME => ApplicationFee,
         ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
+        Apps::Secret::OBJECT_NAME => Apps::Secret,
         Balance::OBJECT_NAME => Balance,
         BalanceTransaction::OBJECT_NAME => BalanceTransaction,
         BankAccount::OBJECT_NAME => BankAccount,
+        BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
         BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
-        BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
-        BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
         Capability::OBJECT_NAME => Capability,
         Card::OBJECT_NAME => Card,
+        CashBalance::OBJECT_NAME => CashBalance,
         Charge::OBJECT_NAME => Charge,
         Checkout::Session::OBJECT_NAME => Checkout::Session,
         CountrySpec::OBJECT_NAME => CountrySpec,
@@ -32,6 +34,7 @@ module Stripe
         CreditNoteLineItem::OBJECT_NAME => CreditNoteLineItem,
         Customer::OBJECT_NAME => Customer,
         CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
+        CustomerCashBalanceTransaction::OBJECT_NAME => CustomerCashBalanceTransaction,
         Discount::OBJECT_NAME => Discount,
         Dispute::OBJECT_NAME => Dispute,
         EphemeralKey::OBJECT_NAME => EphemeralKey,
@@ -40,21 +43,27 @@ module Stripe
         File::OBJECT_NAME => File,
         File::OBJECT_NAME_ALT => File,
         FileLink::OBJECT_NAME => FileLink,
+        FinancialConnections::Account::OBJECT_NAME => FinancialConnections::Account,
+        FinancialConnections::AccountOwner::OBJECT_NAME => FinancialConnections::AccountOwner,
+        FinancialConnections::AccountOwnership::OBJECT_NAME =>
+        FinancialConnections::AccountOwnership,
+        FinancialConnections::Session::OBJECT_NAME => FinancialConnections::Session,
+        FundingInstructions::OBJECT_NAME => FundingInstructions,
+        Identity::VerificationReport::OBJECT_NAME => Identity::VerificationReport,
+        Identity::VerificationSession::OBJECT_NAME => Identity::VerificationSession,
         Invoice::OBJECT_NAME => Invoice,
         InvoiceItem::OBJECT_NAME => InvoiceItem,
         InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
         Issuing::Authorization::OBJECT_NAME => Issuing::Authorization,
         Issuing::Card::OBJECT_NAME => Issuing::Card,
-        Issuing::CardDetails::OBJECT_NAME => Issuing::CardDetails,
         Issuing::Cardholder::OBJECT_NAME => Issuing::Cardholder,
         Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
         Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
         LineItem::OBJECT_NAME => LineItem,
         LoginLink::OBJECT_NAME => LoginLink,
         Mandate::OBJECT_NAME => Mandate,
-        Order::OBJECT_NAME => Order,
-        OrderReturn::OBJECT_NAME => OrderReturn,
         PaymentIntent::OBJECT_NAME => PaymentIntent,
+        PaymentLink::OBJECT_NAME => PaymentLink,
         PaymentMethod::OBJECT_NAME => PaymentMethod,
         Payout::OBJECT_NAME => Payout,
         Person::OBJECT_NAME => Person,
@@ -62,34 +71,51 @@ module Stripe
         Price::OBJECT_NAME => Price,
         Product::OBJECT_NAME => Product,
         PromotionCode::OBJECT_NAME => PromotionCode,
+        Quote::OBJECT_NAME => Quote,
         Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
         Radar::ValueList::OBJECT_NAME => Radar::ValueList,
         Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
-        Recipient::OBJECT_NAME => Recipient,
-        RecipientTransfer::OBJECT_NAME => RecipientTransfer,
         Refund::OBJECT_NAME => Refund,
         Reporting::ReportRun::OBJECT_NAME => Reporting::ReportRun,
         Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
         Reversal::OBJECT_NAME => Reversal,
         Review::OBJECT_NAME => Review,
-        SKU::OBJECT_NAME => SKU,
         SetupAttempt::OBJECT_NAME => SetupAttempt,
         SetupIntent::OBJECT_NAME => SetupIntent,
+        ShippingRate::OBJECT_NAME => ShippingRate,
         Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
         Source::OBJECT_NAME => Source,
         SourceTransaction::OBJECT_NAME => SourceTransaction,
         Subscription::OBJECT_NAME => Subscription,
         SubscriptionItem::OBJECT_NAME => SubscriptionItem,
         SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
+        Tax::Calculation::OBJECT_NAME => Tax::Calculation,
+        Tax::CalculationLineItem::OBJECT_NAME => Tax::CalculationLineItem,
+        Tax::Settings::OBJECT_NAME => Tax::Settings,
+        Tax::Transaction::OBJECT_NAME => Tax::Transaction,
+        Tax::TransactionLineItem::OBJECT_NAME => Tax::TransactionLineItem,
+        TaxCode::OBJECT_NAME => TaxCode,
         TaxId::OBJECT_NAME => TaxId,
         TaxRate::OBJECT_NAME => TaxRate,
+        Terminal::Configuration::OBJECT_NAME => Terminal::Configuration,
         Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,
         Terminal::Location::OBJECT_NAME => Terminal::Location,
         Terminal::Reader::OBJECT_NAME => Terminal::Reader,
-        ThreeDSecure::OBJECT_NAME => ThreeDSecure,
+        TestHelpers::TestClock::OBJECT_NAME => TestHelpers::TestClock,
         Token::OBJECT_NAME => Token,
         Topup::OBJECT_NAME => Topup,
         Transfer::OBJECT_NAME => Transfer,
+        Treasury::CreditReversal::OBJECT_NAME => Treasury::CreditReversal,
+        Treasury::DebitReversal::OBJECT_NAME => Treasury::DebitReversal,
+        Treasury::FinancialAccount::OBJECT_NAME => Treasury::FinancialAccount,
+        Treasury::FinancialAccountFeatures::OBJECT_NAME => Treasury::FinancialAccountFeatures,
+        Treasury::InboundTransfer::OBJECT_NAME => Treasury::InboundTransfer,
+        Treasury::OutboundPayment::OBJECT_NAME => Treasury::OutboundPayment,
+        Treasury::OutboundTransfer::OBJECT_NAME => Treasury::OutboundTransfer,
+        Treasury::ReceivedCredit::OBJECT_NAME => Treasury::ReceivedCredit,
+        Treasury::ReceivedDebit::OBJECT_NAME => Treasury::ReceivedDebit,
+        Treasury::Transaction::OBJECT_NAME => Treasury::Transaction,
+        Treasury::TransactionEntry::OBJECT_NAME => Treasury::TransactionEntry,
         UsageRecord::OBJECT_NAME => UsageRecord,
         UsageRecordSummary::OBJECT_NAME => UsageRecordSummary,
         WebhookEndpoint::OBJECT_NAME => WebhookEndpoint,

data/lib/stripe/resources/account.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a Stripe account. You can retrieve it to see
+  # properties on the account like its current requirements or if the account is
+  # enabled to make live charges or receive payouts.
+  #
+  # For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that
+  # account has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links)
+  # for a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express**
+  # below. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts).
   class Account < APIResource
     extend Gem::Deprecate
     extend Stripe::APIOperations::Create
@@ -12,18 +20,43 @@ module Stripe
 
     OBJECT_NAME = "account"
 
-    custom_method :reject, http_verb: :post
-
     nested_resource_class_methods :capability,
                                   operations: %i[retrieve update list],
                                   resource_plural: "capabilities"
     nested_resource_class_methods :person,
                                   operations: %i[create retrieve update delete list]
 
+    def persons(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def reject(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/reject",
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.persons(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.reject(account, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(account) }),
         params: params,
         opts: opts
       )
@@ -33,7 +66,6 @@ module Stripe
 
     nested_resource_class_methods :external_account,
                                   operations: %i[create retrieve update delete list]
-
     nested_resource_class_methods :login_link, operations: %i[create]
 
     def resource_url
@@ -45,12 +77,8 @@ module Stripe
     end
 
     # @override To make id optional
-    def self.retrieve(id = ARGUMENT_NOT_PROVIDED, opts = {})
-      id = if id.equal?(ARGUMENT_NOT_PROVIDED)
-             nil
-           else
-             Util.check_string_argument!(id)
-           end
+    def self.retrieve(id = nil, opts = {})
+      Util.check_string_argument!(id) if id
 
       # Account used to be a singleton, where this method's signature was
       # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
@@ -64,11 +92,6 @@ module Stripe
       super(id, opts)
     end
 
-    def persons(params = {}, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/persons", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
-    end
-
     # We are not adding a helper for capabilities here as the Account object
     # already has a capabilities property which is a hash and not the sub-list
     # of capabilities.
@@ -136,11 +159,10 @@ module Stripe
         client_id: client_id,
         stripe_user_id: id,
       }
+      opts = @opts.merge(Util.normalize_opts(opts))
       OAuth.deauthorize(params, opts)
     end
 
-    ARGUMENT_NOT_PROVIDED = Object.new
-
     private def serialize_additional_owners(legal_entity, additional_owners)
       original_value =
         legal_entity

data/lib/stripe/resources/account_link.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Account Links are the means by which a Connect platform grants a connected account permission to access
+  # Stripe-hosted applications, such as Connect Onboarding.
+  #
+  # Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding)
   class AccountLink < APIResource
     extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/application_fee_refund.rb

@@ -1,9 +1,15 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # `Application Fee Refund` objects allow you to refund an application fee that
+  # has previously been created but not yet refunded. Funds will be refunded to
+  # the Stripe account from which the fee was originally collected.
+  #
+  # Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)
   class ApplicationFeeRefund < APIResource
-    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
     OBJECT_NAME = "fee_refund"
 

data/lib/stripe/resources/apps/secret.rb

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Apps
+    # Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
+    #
+    # The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
+    #
+    # All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
+    #
+    # A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
+    #
+    # Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
+    class Secret < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "apps.secret"
+
+      def self.delete_where(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.find(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/balance.rb

@@ -2,6 +2,17 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing your Stripe balance. You can retrieve it to see
+  # the balance currently on your Stripe account.
+  #
+  # You can also retrieve the balance history, which contains a list of
+  # [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
+  # (charges, payouts, and so forth).
+  #
+  # The available and pending amounts for each currency are broken down further by
+  # payment source types.
+  #
+  # Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
   class Balance < SingletonAPIResource
     OBJECT_NAME = "balance"
   end

data/lib/stripe/resources/balance_transaction.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Balance transactions represent funds moving through your Stripe account.
+  # They're created for every type of transaction that comes into or flows out of your Stripe account balance.
+  #
+  # Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/bank_account.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # These bank accounts are payment methods on `Customer` objects.
+  #
+  # On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
+  # destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-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/docs/payments/bank-debits-transfers)
   class BankAccount < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module BillingPortal
+    # A portal configuration describes the functionality and behavior of a portal session.
+    class Configuration < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "billing_portal.configuration"
+    end
+  end
+end

data/lib/stripe/resources/billing_portal/session.rb

@@ -3,6 +3,20 @@
 
 module Stripe
   module BillingPortal
+    # The Billing customer portal is a Stripe-hosted UI for subscription and
+    # billing management.
+    #
+    # A portal configuration describes the functionality and features that you
+    # want to provide to your customers through the portal.
+    #
+    # A portal session describes the instantiation of the customer portal for
+    # a particular customer. By visiting the session's URL, the customer
+    # can manage their subscriptions and billing details. For security reasons,
+    # sessions are short-lived and will expire if the customer does not visit the URL.
+    # Create sessions on-demand when customers intend to manage their subscriptions
+    # and billing details.
+    #
+    # Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
     class Session < APIResource
       extend Stripe::APIOperations::Create
 

data/lib/stripe/resources/capability.rb

@@ -1,6 +1,10 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a capability for a Stripe account.
+  #
+  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
   class Capability < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save
@@ -26,7 +30,7 @@ module Stripe
     def self.update(_id, _params = nil, _opts = nil)
       raise NotImplementedError,
             "Capabilities cannot be updated without an account ID. Update a " \
-            "capability using Account.update_capability('account_id', " \
+            "capability using `Account.update_capability('account_id', " \
             "'capability_id', update_params)`"
     end
   end

data/lib/stripe/resources/card.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # You can store multiple cards on a customer in order to charge the customer
+  # later. You can also store multiple debit cards on a recipient in order to
+  # transfer to those cards later.
+  #
+  # Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
   class Card < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
@@ -10,9 +15,7 @@ module Stripe
     OBJECT_NAME = "card"
 
     def resource_url
-      if respond_to?(:recipient) && !recipient.nil? && !recipient.empty?
-        "#{Recipient.resource_url}/#{CGI.escape(recipient)}/cards/#{CGI.escape(id)}"
-      elsif respond_to?(:customer) && !customer.nil? && !customer.empty?
+      if respond_to?(:customer) && !customer.nil? && !customer.empty?
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
       elsif respond_to?(:account) && !account.nil? && !account.empty?
         "#{Account.resource_url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"

data/lib/stripe/resources/cash_balance.rb

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
+  class CashBalance < APIResource
+    OBJECT_NAME = "cash_balance"
+
+    def resource_url
+      if !respond_to?(:customer) || customer.nil?
+        raise NotImplementedError,
+              "Customer Cash Balance cannot be accessed without a customer ID."
+      end
+      "#{Customer.resource_url}/#{CGI.escape(customer)}/cash_balance"
+    end
+
+    def self.retrieve(_id, _opts = {})
+      raise NotImplementedError,
+            "Customer Cash Balance cannot be retrieved without a customer ID. " \
+            "Retrieve a Customer Cash Balance using `Customer.retrieve_cash_balance('cus_123')`"
+    end
+  end
+end

data/lib/stripe/resources/charge.rb

@@ -2,22 +2,42 @@
 # frozen_string_literal: true
 
 module Stripe
+  # The `Charge` object represents a single attempt to move money into your Stripe account.
+  # PaymentIntent confirmation is the most common way to create Charges, but transferring
+  # money to a different Stripe account through Connect also creates Charges.
+  # Some legacy payment flows create Charges directly, which is not recommended for new integrations.
   class Charge < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "charge"
 
-    custom_method :capture, http_verb: :post
-
     def capture(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/capture",
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.capture(charge, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
         params: params,
         opts: opts
       )
     end
+
+    def self.search(params = {}, opts = {})
+      _search("/v1/charges/search", params, opts)
+    end
+
+    def self.search_auto_paging_each(params = {}, opts = {}, &blk)
+      search(params, opts).auto_paging_each(&blk)
+    end
   end
 end

data/lib/stripe/resources/checkout/session.rb

@@ -3,14 +3,61 @@
 
 module Stripe
   module Checkout
+    # A Checkout Session represents your customer's session as they pay for
+    # one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
+    # or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
+    # new Session each time your customer attempts to pay.
+    #
+    # Once payment is successful, the Checkout Session will contain a reference
+    # to the [Customer](https://stripe.com/docs/api/customers), and either the successful
+    # [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
+    # [Subscription](https://stripe.com/docs/api/subscriptions).
+    #
+    # You can create a Checkout Session on your server and redirect to its URL
+    # to begin Checkout.
+    #
+    # Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
     class Session < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List
-      extend Stripe::APIOperations::NestedResource
 
       OBJECT_NAME = "checkout.session"
 
-      nested_resource_class_methods :line_item, operations: %i[list]
+      def expire(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def list_line_items(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.expire(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.list_line_items(session, params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts
+        )
+      end
     end
   end
 end

data/lib/stripe/resources/country_spec.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Stripe needs to collect certain pieces of information about each account
+  # created. These requirements can differ depending on the account's country. The
+  # 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).
   class CountrySpec < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/coupon.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A coupon contains information about a percent-off or amount-off discount you
+  # might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+  # [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
   class Coupon < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/credit_note.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Issue a credit note to adjust an invoice's amount after the invoice is finalized.
+  #
+  # Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
   class CreditNote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,25 +12,40 @@ module Stripe
 
     OBJECT_NAME = "credit_note"
 
-    custom_method :void_credit_note, http_verb: :post, http_path: "void"
-
     def void_credit_note(params = {}, opts = {})
       request_stripe_object(
         method: :post,
-        path: resource_url + "/void",
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_preview_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/credit_notes/preview/lines",
         params: params,
         opts: opts
       )
     end
 
-    def self.preview(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/preview", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+    def self.preview(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: "/v1/credit_notes/preview",
+        params: params,
+        opts: opts
+      )
     end
 
-    def self.list_preview_line_items(params, opts = {})
-      resp, opts = execute_resource_request(:get, resource_url + "/preview/lines", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+    def self.void_credit_note(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
     end
   end
 end

data/lib/stripe/resources/credit_note_line_item.rb

@@ -1,6 +1,8 @@
+# File generated from our OpenAPI spec
 # frozen_string_literal: true
 
 module Stripe
+  # The credit note line item object
   class CreditNoteLineItem < StripeObject
     OBJECT_NAME = "credit_note_line_item"
   end