stripe 10.4.0 → 10.5.0

data/lib/stripe/resources/subscription.rb

@@ -13,6 +13,11 @@ module Stripe
 
     OBJECT_NAME = "subscription"
 
+    # Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
+    #
+    # Note, however, that any pending invoice items that you've created will still be charged for 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 will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
+    #
+    # By default, upon subscription cancellation, Stripe will stop 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 = {})
       request_stripe_object(
         method: :delete,
@@ -22,6 +27,7 @@ module Stripe
       )
     end
 
+    # Removes the currently applied discount on a subscription.
     def delete_discount(params = {}, opts = {})
       request_stripe_object(
         method: :delete,
@@ -31,6 +37,7 @@ module Stripe
       )
     end
 
+    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
     def resume(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -40,6 +47,11 @@ module Stripe
       )
     end
 
+    # Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
+    #
+    # Note, however, that any pending invoice items that you've created will still be charged for 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 will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
+    #
+    # By default, upon subscription cancellation, Stripe will stop 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 = {})
       request_stripe_object(
         method: :delete,
@@ -49,6 +61,7 @@ module Stripe
       )
     end
 
+    # Removes the currently applied discount on a subscription.
     def self.delete_discount(subscription_exposed_id, params = {}, opts = {})
       request_stripe_object(
         method: :delete,
@@ -58,6 +71,7 @@ module Stripe
       )
     end
 
+    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If a resumption invoice is generated, it must be paid or marked uncollectible before the subscription will be unpaused. If payment succeeds the subscription will become active, and if payment fails the subscription will be past_due. The resumption invoice will void automatically if not paid by the expiration date.
     def self.resume(subscription, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/subscription_schedule.rb

@@ -12,6 +12,7 @@ module Stripe
 
     OBJECT_NAME = "subscription_schedule"
 
+    # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -21,6 +22,7 @@ module Stripe
       )
     end
 
+    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
     def release(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -30,6 +32,7 @@ module Stripe
       )
     end
 
+    # Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active.
     def self.cancel(schedule, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -39,6 +42,7 @@ module Stripe
       )
     end
 
+    # Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property.
     def self.release(schedule, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/tax/calculation.rb

@@ -11,6 +11,7 @@ module Stripe
 
       OBJECT_NAME = "tax.calculation"
 
+      # Retrieves the line items of a persisted tax calculation as a collection.
       def list_line_items(params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -20,6 +21,7 @@ module Stripe
         )
       end
 
+      # Retrieves the line items of a persisted tax calculation as a collection.
       def self.list_line_items(calculation, params = {}, opts = {})
         request_stripe_object(
           method: :get,

data/lib/stripe/resources/tax/transaction.rb

@@ -9,6 +9,7 @@ module Stripe
     class Transaction < APIResource
       OBJECT_NAME = "tax.transaction"
 
+      # Retrieves the line items of a committed standalone transaction as a collection.
       def list_line_items(params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -18,6 +19,7 @@ module Stripe
         )
       end
 
+      # Creates a Tax Transaction from a calculation.
       def self.create_from_calculation(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -27,6 +29,7 @@ module Stripe
         )
       end
 
+      # Partially or fully reverses a previously created Transaction.
       def self.create_reversal(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -36,6 +39,7 @@ module Stripe
         )
       end
 
+      # Retrieves the line items of a committed standalone transaction as a collection.
       def self.list_line_items(transaction, params = {}, opts = {})
         request_stripe_object(
           method: :get,

data/lib/stripe/resources/terminal/reader.rb

@@ -14,6 +14,7 @@ module Stripe
 
       OBJECT_NAME = "terminal.reader"
 
+      # Cancels the current reader action.
       def cancel_action(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -23,6 +24,7 @@ module Stripe
         )
       end
 
+      # Initiates a payment flow on a Reader.
       def process_payment_intent(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -32,6 +34,7 @@ module Stripe
         )
       end
 
+      # Initiates a setup intent flow on a Reader.
       def process_setup_intent(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -41,6 +44,7 @@ module Stripe
         )
       end
 
+      # Initiates a refund on a Reader
       def refund_payment(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -50,6 +54,7 @@ module Stripe
         )
       end
 
+      # Sets reader display to show cart details.
       def set_reader_display(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -59,6 +64,7 @@ module Stripe
         )
       end
 
+      # Cancels the current reader action.
       def self.cancel_action(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -68,6 +74,7 @@ module Stripe
         )
       end
 
+      # Initiates a payment flow on a Reader.
       def self.process_payment_intent(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -77,6 +84,7 @@ module Stripe
         )
       end
 
+      # Initiates a setup intent flow on a Reader.
       def self.process_setup_intent(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -86,6 +94,7 @@ module Stripe
         )
       end
 
+      # Initiates a refund on a Reader
       def self.refund_payment(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -95,6 +104,7 @@ module Stripe
         )
       end
 
+      # Sets reader display to show cart details.
       def self.set_reader_display(reader, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -111,6 +121,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = Reader
 
+        # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
         def self.present_payment_method(reader, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -120,6 +131,7 @@ module Stripe
           )
         end
 
+        # Presents a payment method on a simulated reader. Can be used to simulate accepting a payment, saving a card or refunding a transaction.
         def present_payment_method(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

data/lib/stripe/resources/test_helpers/test_clock.rb

@@ -13,6 +13,7 @@ module Stripe
 
       OBJECT_NAME = "test_helpers.test_clock"
 
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
       def advance(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -22,6 +23,7 @@ module Stripe
         )
       end
 
+      # Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
       def self.advance(test_clock, params = {}, opts = {})
         request_stripe_object(
           method: :post,

data/lib/stripe/resources/topup.rb

@@ -14,6 +14,7 @@ module Stripe
 
     OBJECT_NAME = "topup"
 
+    # Cancels a top-up. Only pending top-ups can be canceled.
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -23,6 +24,7 @@ module Stripe
       )
     end
 
+    # Cancels a top-up. Only pending top-ups can be canceled.
     def self.cancel(topup, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/treasury/financial_account.rb

@@ -12,6 +12,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.financial_account"
 
+      # Retrieves Features information associated with the FinancialAccount.
       def retrieve_features(params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -21,6 +22,7 @@ module Stripe
         )
       end
 
+      # Updates the Features associated with a FinancialAccount.
       def update_features(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -30,6 +32,7 @@ module Stripe
         )
       end
 
+      # Retrieves Features information associated with the FinancialAccount.
       def self.retrieve_features(financial_account, params = {}, opts = {})
         request_stripe_object(
           method: :get,
@@ -39,6 +42,7 @@ module Stripe
         )
       end
 
+      # Updates the Features associated with a FinancialAccount.
       def self.update_features(financial_account, params = {}, opts = {})
         request_stripe_object(
           method: :post,

data/lib/stripe/resources/treasury/inbound_transfer.rb

@@ -10,6 +10,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.inbound_transfer"
 
+      # Cancels an InboundTransfer.
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -19,6 +20,7 @@ module Stripe
         )
       end
 
+      # Cancels an InboundTransfer.
       def self.cancel(inbound_transfer, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -35,6 +37,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = InboundTransfer
 
+        # Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
         def self.fail(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -44,6 +47,7 @@ module Stripe
           )
         end
 
+        # Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
         def self.return_inbound_transfer(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -53,6 +57,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
         def self.succeed(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -62,6 +67,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created InboundTransfer to the failed status. The InboundTransfer must already be in the processing state.
         def fail(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -71,6 +77,7 @@ module Stripe
           )
         end
 
+        # Marks the test mode InboundTransfer object as returned and links the InboundTransfer to a ReceivedDebit. The InboundTransfer must already be in the succeeded state.
         def return_inbound_transfer(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -80,6 +87,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created InboundTransfer to the succeeded status. The InboundTransfer must already be in the processing state.
         def succeed(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

data/lib/stripe/resources/treasury/outbound_payment.rb

@@ -12,6 +12,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.outbound_payment"
 
+      # Cancel an OutboundPayment.
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -21,6 +22,7 @@ module Stripe
         )
       end
 
+      # Cancel an OutboundPayment.
       def self.cancel(id, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -37,6 +39,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = OutboundPayment
 
+        # Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
         def self.fail(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -46,6 +49,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
         def self.post(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -55,6 +59,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
         def self.return_outbound_payment(id, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -64,6 +69,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the failed status. The OutboundPayment must already be in the processing state.
         def fail(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -73,6 +79,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the posted status. The OutboundPayment must already be in the processing state.
         def post(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -82,6 +89,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundPayment to the returned status. The OutboundPayment must already be in the processing state.
         def return_outbound_payment(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

data/lib/stripe/resources/treasury/outbound_transfer.rb

@@ -12,6 +12,7 @@ module Stripe
 
       OBJECT_NAME = "treasury.outbound_transfer"
 
+      # An OutboundTransfer can be canceled if the funds have not yet been paid out.
       def cancel(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -21,6 +22,7 @@ module Stripe
         )
       end
 
+      # An OutboundTransfer can be canceled if the funds have not yet been paid out.
       def self.cancel(outbound_transfer, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -37,6 +39,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = OutboundTransfer
 
+        # Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
         def self.fail(outbound_transfer, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -46,6 +49,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
         def self.post(outbound_transfer, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -55,6 +59,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
         def self.return_outbound_transfer(outbound_transfer, params = {}, opts = {})
           request_stripe_object(
             method: :post,
@@ -64,6 +69,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the failed status. The OutboundTransfer must already be in the processing state.
         def fail(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -73,6 +79,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the posted status. The OutboundTransfer must already be in the processing state.
         def post(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,
@@ -82,6 +89,7 @@ module Stripe
           )
         end
 
+        # Transitions a test mode created OutboundTransfer to the returned status. The OutboundTransfer must already be in the processing state.
         def return_outbound_transfer(params = {}, opts = {})
           @resource.request_stripe_object(
             method: :post,

data/lib/stripe/resources/treasury/received_credit.rb

@@ -16,6 +16,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = ReceivedCredit
 
+        # Use this endpoint to simulate a test mode ReceivedCredit initiated by a third party. In live mode, you can't directly create ReceivedCredits initiated by third parties.
         def self.create(params = {}, opts = {})
           request_stripe_object(
             method: :post,

data/lib/stripe/resources/treasury/received_debit.rb

@@ -16,6 +16,7 @@ module Stripe
       class TestHelpers < APIResourceTestHelpers
         RESOURCE_CLASS = ReceivedDebit
 
+        # Use this endpoint to simulate a test mode ReceivedDebit initiated by a third party. In live mode, you can't directly create ReceivedDebits initiated by third parties.
         def self.create(params = {}, opts = {})
           request_stripe_object(
             method: :post,

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "10.4.0"
+  VERSION = "10.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 10.4.0
+  version: 10.5.0
 platform: ruby
 authors:
 - Stripe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies: []
 description: Stripe is the easiest way to accept payments online.  See https://stripe.com
   for details.