stripe 19.1.0 → 19.2.0

data/lib/stripe/resources/subscription.rb

@@ -97,6 +97,70 @@ module Stripe
       end
     end
 
+    class BillingSchedule < ::Stripe::StripeObject
+      class AppliesTo < ::Stripe::StripeObject
+        # The billing schedule will apply to the subscription item with the given price ID.
+        attr_reader :price
+        # Controls which subscription items the billing schedule applies to.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillUntil < ::Stripe::StripeObject
+        class Duration < ::Stripe::StripeObject
+          # Specifies billing duration. Either `day`, `week`, `month` or `year`.
+          attr_reader :interval
+          # The multiplier applied to the interval.
+          attr_reader :interval_count
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The timestamp the billing schedule will apply until.
+        attr_reader :computed_timestamp
+        # Specifies the billing period.
+        attr_reader :duration
+        # If specified, the billing schedule will apply until the specified timestamp.
+        attr_reader :timestamp
+        # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { duration: Duration }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Specifies which subscription items the billing schedule applies to.
+      attr_reader :applies_to
+      # Specifies the end of billing period.
+      attr_reader :bill_until
+      # Unique identifier for the billing schedule.
+      attr_reader :key
+
+      def self.inner_class_types
+        @inner_class_types = { applies_to: AppliesTo, bill_until: BillUntil }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class BillingThresholds < ::Stripe::StripeObject
       # Monetary threshold that triggers the subscription to create an invoice
       attr_reader :amount_gte
@@ -531,8 +595,14 @@ module Stripe
     class PendingUpdate < ::Stripe::StripeObject
       # If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.
       attr_reader :billing_cycle_anchor
+      # The pending subscription-level discount that will be applied when the pending update is applied.
+      attr_reader :discount
+      # The discounts that will be applied to the subscription when the pending update is applied. Use `expand[]=discounts` to expand each discount.
+      attr_reader :discounts
       # The point after which the changes reflected by this update will be discarded and no longer applied.
       attr_reader :expires_at
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
       # List of subscription items, each with an attached plan, that will be set if the update is applied.
       attr_reader :subscription_items
       # Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
@@ -613,6 +683,8 @@ module Stripe
     attr_reader :billing_cycle_anchor_config
     # The billing mode of the subscription.
     attr_reader :billing_mode
+    # Billing schedules for this subscription.
+    attr_reader :billing_schedules
     # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
     attr_reader :billing_thresholds
     # A date in the future at which the subscription will automatically get canceled
@@ -706,7 +778,7 @@ 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://docs.stripe.com/metadata).
+    # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, the subscription is largely immutable. You can still update its [metadata](https://docs.stripe.com/metadata) and cancellation_details.
     #
     # 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/invoiceitems/delete). 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.
     #
@@ -720,7 +792,7 @@ 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://docs.stripe.com/metadata).
+    # Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, the subscription is largely immutable. You can still update its [metadata](https://docs.stripe.com/metadata) and cancellation_details.
     #
     # 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/invoiceitems/delete). 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.
     #
@@ -790,7 +862,7 @@ module Stripe
       )
     end
 
-    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice isn't paid by the expiration date, it is voided and the subscription remains paused. You can only resume subscriptions with collection_method set to charge_automatically. send_invoice subscriptions are not supported.
+    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn't generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes active. If the invoice is manually voided, the subscription stays paused. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays paused. Learn more about [resuming subscriptions](https://docs.stripe.com/docs/billing/subscriptions/pause#resume-subscriptions).
     def resume(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -800,7 +872,7 @@ module Stripe
       )
     end
 
-    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice isn't paid by the expiration date, it is voided and the subscription remains paused. You can only resume subscriptions with collection_method set to charge_automatically. send_invoice subscriptions are not supported.
+    # Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn't generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes active. If the invoice is manually voided, the subscription stays paused. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays paused. Learn more about [resuming subscriptions](https://docs.stripe.com/docs/billing/subscriptions/pause#resume-subscriptions).
     def self.resume(subscription, params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -860,6 +932,7 @@ module Stripe
         automatic_tax: AutomaticTax,
         billing_cycle_anchor_config: BillingCycleAnchorConfig,
         billing_mode: BillingMode,
+        billing_schedules: BillingSchedule,
         billing_thresholds: BillingThresholds,
         cancellation_details: CancellationDetails,
         invoice_settings: InvoiceSettings,

data/lib/stripe/resources/subscription_item.rb

@@ -27,6 +27,8 @@ module Stripe
         @field_remappings = {}
       end
     end
+    # The time period the subscription item has been billed for.
+    attr_reader :billed_until
     # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
     attr_reader :billing_thresholds
     # Time at which the object was created. Measured in seconds since the Unix epoch.

data/lib/stripe/resources/subscription_schedule.rb

@@ -248,6 +248,8 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # Controls whether discounts apply to this invoice item. Defaults to true if no value is provided.
+        attr_reader :discountable
         # The stackable discounts that will be applied to the item.
         attr_reader :discounts
         # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

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

@@ -540,6 +540,19 @@ module Stripe
         end
       end
 
+      class VerifoneM425 < ::Stripe::StripeObject
+        # A File ID representing an image to display on the reader
+        attr_reader :splashscreen
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class VerifoneP400 < ::Stripe::StripeObject
         # A File ID representing an image to display on the reader
         attr_reader :splashscreen
@@ -553,6 +566,45 @@ module Stripe
         end
       end
 
+      class VerifoneP630 < ::Stripe::StripeObject
+        # A File ID representing an image to display on the reader
+        attr_reader :splashscreen
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class VerifoneUx700 < ::Stripe::StripeObject
+        # A File ID representing an image to display on the reader
+        attr_reader :splashscreen
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class VerifoneV660p < ::Stripe::StripeObject
+        # A File ID representing an image to display on the reader
+        attr_reader :splashscreen
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Wifi < ::Stripe::StripeObject
         class EnterpriseEapPeap < ::Stripe::StripeObject
           # A File ID representing a PEM file containing the server certificate
@@ -657,8 +709,16 @@ module Stripe
       attr_reader :stripe_s710
       # Attribute for field tipping
       attr_reader :tipping
+      # Attribute for field verifone_m425
+      attr_reader :verifone_m425
       # Attribute for field verifone_p400
       attr_reader :verifone_p400
+      # Attribute for field verifone_p630
+      attr_reader :verifone_p630
+      # Attribute for field verifone_ux700
+      attr_reader :verifone_ux700
+      # Attribute for field verifone_v660p
+      attr_reader :verifone_v660p
       # Attribute for field wifi
       attr_reader :wifi
 
@@ -722,7 +782,11 @@ module Stripe
           stripe_s700: StripeS700,
           stripe_s710: StripeS710,
           tipping: Tipping,
+          verifone_m425: VerifoneM425,
           verifone_p400: VerifoneP400,
+          verifone_p630: VerifoneP630,
+          verifone_ux700: VerifoneUx700,
+          verifone_v660p: VerifoneV660p,
           wifi: Wifi,
         }
       end

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

@@ -18,6 +18,83 @@ module Stripe
       end
 
       class Action < ::Stripe::StripeObject
+        class ApiError < ::Stripe::StripeObject
+          # For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one.
+          attr_reader :advice_code
+          # For card errors, the ID of the failed charge.
+          attr_reader :charge
+          # For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported.
+          attr_reader :code
+          # For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one.
+          attr_reader :decline_code
+          # A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported.
+          attr_reader :doc_url
+          # A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
+          attr_reader :message
+          # For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.
+          attr_reader :network_advice_code
+          # For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.
+          attr_reader :network_decline_code
+          # If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
+          attr_reader :param
+          # A PaymentIntent guides you through the process of collecting a payment from your customer.
+          # We recommend that you create exactly one PaymentIntent for each order or
+          # customer session in your system. You can reference the PaymentIntent later to
+          # see the history of payment attempts for a particular session.
+          #
+          # A PaymentIntent transitions through
+          # [multiple statuses](/payments/paymentintents/lifecycle)
+          # throughout its lifetime as it interfaces with Stripe.js to perform
+          # authentication flows and ultimately creates at most one successful charge.
+          #
+          # Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)
+          attr_reader :payment_intent
+          # PaymentMethod objects represent your customer's payment instruments.
+          # You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to
+          # Customer objects to store instrument details for future payments.
+          #
+          # Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios).
+          attr_reader :payment_method
+          # If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
+          attr_reader :payment_method_type
+          # A URL to the request log entry in your dashboard.
+          attr_reader :request_log_url
+          # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
+          # For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
+          # Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow.
+          #
+          # Create a SetupIntent when you're ready to collect your customer's payment credentials.
+          # Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid.
+          # The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides
+          # you through the setup process.
+          #
+          # Successful SetupIntents result in payment credentials that are optimized for future payments.
+          # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through
+          # [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection
+          # to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).
+          # If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer),
+          # it automatically attaches the resulting payment method to that Customer after successful setup.
+          # We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on
+          # PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.
+          #
+          # By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.
+          #
+          # Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)
+          attr_reader :setup_intent
+          # Attribute for field source
+          attr_reader :source
+          # The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class CollectInputs < ::Stripe::StripeObject
           class Input < ::Stripe::StripeObject
             class CustomText < ::Stripe::StripeObject
@@ -285,6 +362,39 @@ module Stripe
           end
         end
 
+        class PrintContent < ::Stripe::StripeObject
+          class Image < ::Stripe::StripeObject
+            # Creation time of the object (in seconds since the Unix epoch).
+            attr_reader :created_at
+            # The original name of the uploaded file (e.g. `receipt.png`).
+            attr_reader :filename
+            # The size (in bytes) of the uploaded file.
+            attr_reader :size
+            # The format of the uploaded file.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # Metadata of an uploaded file
+          attr_reader :image
+          # The type of content to print. Currently supports `image`.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { image: Image }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
         class ProcessPaymentIntent < ::Stripe::StripeObject
           class ProcessConfig < ::Stripe::StripeObject
             class Tipping < ::Stripe::StripeObject
@@ -448,6 +558,8 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # The reader action failed due to an [API error](https://docs.stripe.com/api/errors). Only present when `status` is `failed` and the underlying failure was an API error. Avoid parsing the `message` field for programmatic logic; use `type` or `code` instead. The `message` field is for display to humans only and may be updated at anytime. Requires [reader version](https://docs.stripe.com/terminal/readers/stripe-reader-s700-s710#reader-software-version) 2.42 or later. Readers on older versions always return null.
+        attr_reader :api_error
         # Represents a reader action to collect customer inputs
         attr_reader :collect_inputs
         # Represents a reader action to collect a payment method
@@ -458,6 +570,8 @@ module Stripe
         attr_reader :failure_code
         # Detailed failure message, only set if status is `failed`.
         attr_reader :failure_message
+        # Represents a reader action to print content
+        attr_reader :print_content
         # Represents a reader action to process a payment intent
         attr_reader :process_payment_intent
         # Represents a reader action to process a setup intent
@@ -473,9 +587,11 @@ module Stripe
 
         def self.inner_class_types
           @inner_class_types = {
+            api_error: ApiError,
             collect_inputs: CollectInputs,
             collect_payment_method: CollectPaymentMethod,
             confirm_payment_intent: ConfirmPaymentIntent,
+            print_content: PrintContent,
             process_payment_intent: ProcessPaymentIntent,
             process_setup_intent: ProcessSetupIntent,
             refund_payment: RefundPayment,

data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb

@@ -12,7 +12,7 @@ module Stripe
         end
 
         class Cancel < ::Stripe::StripeObject
-          # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+          # The identifier that was originally assigned to the meter event. You can only cancel events within 24 hours of Stripe receiving them.
           attr_reader :identifier
 
           def self.inner_class_types
@@ -29,7 +29,7 @@ module Stripe
         attr_reader :created
         # The name of the meter event. Corresponds with the `event_name` field on a meter.
         attr_reader :event_name
-        # The unique id of this meter event adjustment.
+        # The unique ID of this meter event adjustment.
         attr_reader :id
         # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
         attr_reader :livemode
@@ -37,7 +37,7 @@ module Stripe
         attr_reader :object
         # Open Enum. The meter event adjustment’s status.
         attr_reader :status
-        # Open Enum. Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+        # Open Enum. Specifies the type of cancellation. Currently supports canceling a single event.
         attr_reader :type
 
         def self.inner_class_types

data/lib/stripe/resources/v2/billing/meter_event_session.rb

@@ -11,14 +11,14 @@ module Stripe
           "v2.billing.meter_event_session"
         end
 
-        # The authentication token for this session.  Use this token when calling the
+        # The authentication token for this session. Use this token when calling the
         # high-throughput meter event API.
         attr_reader :authentication_token
         # The creation time of this session.
         attr_reader :created
-        # The time at which this session will expire.
+        # The time at which this session expires.
         attr_reader :expires_at
-        # The unique id of this auth session.
+        # The unique ID of this auth session.
         attr_reader :id
         # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
         attr_reader :livemode