stripe 18.3.0 → 18.4.0.pre.alpha.1

data/lib/stripe/params/plan_create_params.rb

@@ -4,6 +4,17 @@
 module Stripe
   class PlanCreateParams < ::Stripe::RequestParams
     class Product < ::Stripe::RequestParams
+      class TaxDetails < ::Stripe::RequestParams
+        # A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
+        attr_accessor :performance_location
+        # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+        attr_accessor :tax_code
+
+        def initialize(performance_location: nil, tax_code: nil)
+          @performance_location = performance_location
+          @tax_code = tax_code
+        end
+      end
       # Whether the product is currently available for purchase. Defaults to `true`.
       attr_accessor :active
       # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
@@ -18,6 +29,8 @@ module Stripe
       attr_accessor :statement_descriptor
       # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
       attr_accessor :tax_code
+      # Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
+      attr_accessor :tax_details
       # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
       attr_accessor :unit_label
 
@@ -28,6 +41,7 @@ module Stripe
         name: nil,
         statement_descriptor: nil,
         tax_code: nil,
+        tax_details: nil,
         unit_label: nil
       )
         @active = active
@@ -36,6 +50,7 @@ module Stripe
         @name = name
         @statement_descriptor = statement_descriptor
         @tax_code = tax_code
+        @tax_details = tax_details
         @unit_label = unit_label
       end
     end

data/lib/stripe/params/price_create_params.rb

@@ -93,6 +93,17 @@ module Stripe
     end
 
     class ProductData < ::Stripe::RequestParams
+      class TaxDetails < ::Stripe::RequestParams
+        # A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
+        attr_accessor :performance_location
+        # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+        attr_accessor :tax_code
+
+        def initialize(performance_location: nil, tax_code: nil)
+          @performance_location = performance_location
+          @tax_code = tax_code
+        end
+      end
       # Whether the product is currently available for purchase. Defaults to `true`.
       attr_accessor :active
       # The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.
@@ -107,6 +118,8 @@ module Stripe
       attr_accessor :statement_descriptor
       # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
       attr_accessor :tax_code
+      # Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
+      attr_accessor :tax_details
       # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
       attr_accessor :unit_label
 
@@ -117,6 +130,7 @@ module Stripe
         name: nil,
         statement_descriptor: nil,
         tax_code: nil,
+        tax_details: nil,
         unit_label: nil
       )
         @active = active
@@ -125,6 +139,7 @@ module Stripe
         @name = name
         @statement_descriptor = statement_descriptor
         @tax_code = tax_code
+        @tax_details = tax_details
         @unit_label = unit_label
       end
     end

data/lib/stripe/params/price_update_params.rb

@@ -73,6 +73,21 @@ module Stripe
         @unit_amount_decimal = unit_amount_decimal
       end
     end
+
+    class MigrateTo < ::Stripe::RequestParams
+      # The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+      attr_accessor :behavior
+      # The time after which subscriptions should start using the new price.
+      attr_accessor :effective_after
+      # The ID of the price object.
+      attr_accessor :price
+
+      def initialize(behavior: nil, effective_after: nil, price: nil)
+        @behavior = behavior
+        @effective_after = effective_after
+        @price = price
+      end
+    end
     # Whether the price can be used for new purchases. Defaults to `true`.
     attr_accessor :active
     # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
@@ -83,6 +98,8 @@ module Stripe
     attr_accessor :lookup_key
     # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
     attr_accessor :metadata
+    # If specified, subscriptions using this price will be updated to use the new referenced price.
+    attr_accessor :migrate_to
     # A brief description of the price, hidden from customers.
     attr_accessor :nickname
     # Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
@@ -96,6 +113,7 @@ module Stripe
       expand: nil,
       lookup_key: nil,
       metadata: nil,
+      migrate_to: nil,
       nickname: nil,
       tax_behavior: nil,
       transfer_lookup_key: nil
@@ -105,6 +123,7 @@ module Stripe
       @expand = expand
       @lookup_key = lookup_key
       @metadata = metadata
+      @migrate_to = migrate_to
       @nickname = nickname
       @tax_behavior = tax_behavior
       @transfer_lookup_key = transfer_lookup_key

data/lib/stripe/params/privacy/redaction_job_cancel_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobCancelParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_create_params.rb

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobCreateParams < ::Stripe::RequestParams
+      class Objects < ::Stripe::RequestParams
+        # Attribute for param field charges
+        attr_accessor :charges
+        # Attribute for param field checkout_sessions
+        attr_accessor :checkout_sessions
+        # Attribute for param field customers
+        attr_accessor :customers
+        # Attribute for param field identity_verification_sessions
+        attr_accessor :identity_verification_sessions
+        # Attribute for param field invoices
+        attr_accessor :invoices
+        # Attribute for param field issuing_cardholders
+        attr_accessor :issuing_cardholders
+        # Attribute for param field issuing_cards
+        attr_accessor :issuing_cards
+        # Attribute for param field payment_intents
+        attr_accessor :payment_intents
+        # Attribute for param field radar_value_list_items
+        attr_accessor :radar_value_list_items
+        # Attribute for param field setup_intents
+        attr_accessor :setup_intents
+
+        def initialize(
+          charges: nil,
+          checkout_sessions: nil,
+          customers: nil,
+          identity_verification_sessions: nil,
+          invoices: nil,
+          issuing_cardholders: nil,
+          issuing_cards: nil,
+          payment_intents: nil,
+          radar_value_list_items: nil,
+          setup_intents: nil
+        )
+          @charges = charges
+          @checkout_sessions = checkout_sessions
+          @customers = customers
+          @identity_verification_sessions = identity_verification_sessions
+          @invoices = invoices
+          @issuing_cardholders = issuing_cardholders
+          @issuing_cards = issuing_cards
+          @payment_intents = payment_intents
+          @radar_value_list_items = radar_value_list_items
+          @setup_intents = setup_intents
+        end
+      end
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The objects to redact. These root objects and their related ones will be validated for redaction.
+      attr_accessor :objects
+      # Determines the validation behavior of the job. Default is `error`.
+      attr_accessor :validation_behavior
+
+      def initialize(expand: nil, objects: nil, validation_behavior: nil)
+        @expand = expand
+        @objects = objects
+        @validation_behavior = validation_behavior
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_list_params.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobListParams < ::Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+      # Attribute for param field status
+      attr_accessor :status
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+        @status = status
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_run_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobRunParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_update_params.rb

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobUpdateParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Determines the validation behavior of the job. Default is `error`.
+      attr_accessor :validation_behavior
+
+      def initialize(expand: nil, validation_behavior: nil)
+        @expand = expand
+        @validation_behavior = validation_behavior
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_validate_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobValidateParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/privacy/redaction_job_validation_error_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Privacy
+    class RedactionJobValidationErrorListParams < ::Stripe::RequestParams
+      # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      attr_accessor :starting_after
+
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/product_catalog/trial_offer_create_params.rb

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ProductCatalog
+    class TrialOfferCreateParams < ::Stripe::RequestParams
+      class Duration < ::Stripe::RequestParams
+        class Relative < ::Stripe::RequestParams
+          # The number of recurring price's interval to apply for the trial period.
+          attr_accessor :iterations
+
+          def initialize(iterations: nil)
+            @iterations = iterations
+          end
+        end
+        # The relative duration of the trial period computed as the number of recurring price intervals.
+        attr_accessor :relative
+        # Specifies how the trial offer duration is determined.
+        attr_accessor :type
+
+        def initialize(relative: nil, type: nil)
+          @relative = relative
+          @type = type
+        end
+      end
+
+      class EndBehavior < ::Stripe::RequestParams
+        class Transition < ::Stripe::RequestParams
+          # The price to transition the recurring item to when the trial offer ends.
+          attr_accessor :price
+
+          def initialize(price: nil)
+            @price = price
+          end
+        end
+        # The transition to apply when the trial offer ends.
+        attr_accessor :transition
+
+        def initialize(transition: nil)
+          @transition = transition
+        end
+      end
+      # Duration of one service period of the trial.
+      attr_accessor :duration
+      # Define behavior that occurs at the end of the trial.
+      attr_accessor :end_behavior
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # A brief, user-friendly name for the trial offer-for identification purposes.
+      attr_accessor :name
+      # Price configuration during the trial period (amount, billing scheme, etc).
+      attr_accessor :price
+
+      def initialize(duration: nil, end_behavior: nil, expand: nil, name: nil, price: nil)
+        @duration = duration
+        @end_behavior = end_behavior
+        @expand = expand
+        @name = name
+        @price = price
+      end
+    end
+  end
+end

data/lib/stripe/params/product_create_params.rb

@@ -168,6 +168,18 @@ module Stripe
         @width = width
       end
     end
+
+    class TaxDetails < ::Stripe::RequestParams
+      # A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
+      attr_accessor :performance_location
+      # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+      attr_accessor :tax_code
+
+      def initialize(performance_location: nil, tax_code: nil)
+        @performance_location = performance_location
+        @tax_code = tax_code
+      end
+    end
     # Whether the product is currently available for purchase. Defaults to `true`.
     attr_accessor :active
     # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object. This Price will be set as the default price for this product.
@@ -197,6 +209,8 @@ module Stripe
     attr_accessor :statement_descriptor
     # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
     attr_accessor :tax_code
+    # Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
+    attr_accessor :tax_details
     # The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
     attr_accessor :type
     # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
@@ -218,6 +232,7 @@ module Stripe
       shippable: nil,
       statement_descriptor: nil,
       tax_code: nil,
+      tax_details: nil,
       type: nil,
       unit_label: nil,
       url: nil
@@ -235,6 +250,7 @@ module Stripe
       @shippable = shippable
       @statement_descriptor = statement_descriptor
       @tax_code = tax_code
+      @tax_details = tax_details
       @type = type
       @unit_label = unit_label
       @url = url

data/lib/stripe/params/product_update_params.rb

@@ -29,6 +29,18 @@ module Stripe
         @width = width
       end
     end
+
+    class TaxDetails < ::Stripe::RequestParams
+      # A tax location ID. Depending on the [tax code](/tax/tax-for-tickets/reference/tax-location-performance), this is required, optional, or not supported.
+      attr_accessor :performance_location
+      # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
+      attr_accessor :tax_code
+
+      def initialize(performance_location: nil, tax_code: nil)
+        @performance_location = performance_location
+        @tax_code = tax_code
+      end
+    end
     # Whether the product is available for purchase.
     attr_accessor :active
     # The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.
@@ -56,6 +68,8 @@ module Stripe
     attr_accessor :statement_descriptor
     # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
     attr_accessor :tax_code
+    # Tax details for this product, including the [tax code](/tax/tax-codes) and an optional performance location.
+    attr_accessor :tax_details
     # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
     attr_accessor :unit_label
     # A URL of a publicly-accessible webpage for this product.
@@ -74,6 +88,7 @@ module Stripe
       shippable: nil,
       statement_descriptor: nil,
       tax_code: nil,
+      tax_details: nil,
       unit_label: nil,
       url: nil
     )
@@ -89,6 +104,7 @@ module Stripe
       @shippable = shippable
       @statement_descriptor = statement_descriptor
       @tax_code = tax_code
+      @tax_details = tax_details
       @unit_label = unit_label
       @url = url
     end