stripe 19.4.0 → 19.5.0.pre.alpha.2

data/lib/stripe/params/price_update_params.rb

@@ -93,16 +93,35 @@ module Stripe
         }
       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).
     attr_accessor :currency_options
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
+    # A custom identifier for this price, such as a SKU number or product code, that can be used to reference records from external systems.
+    attr_accessor :external_reference
     # A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
     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.
@@ -114,8 +133,10 @@ module Stripe
       active: nil,
       currency_options: nil,
       expand: nil,
+      external_reference: nil,
       lookup_key: nil,
       metadata: nil,
+      migrate_to: nil,
       nickname: nil,
       tax_behavior: nil,
       transfer_lookup_key: nil
@@ -123,8 +144,10 @@ module Stripe
       @active = active
       @currency_options = currency_options
       @expand = expand
+      @external_reference = external_reference
       @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
+      # If provided, only RedactionJob objects with the given status will be returned.
+      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_catalog/trial_offer_list_params.rb

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ProductCatalog
+    class TrialOfferListParams < ::Stripe::RequestParams
+      class Created < ::Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        attr_accessor :lte
+
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+          @gt = gt
+          @gte = gte
+          @lt = lt
+          @lte = lte
+        end
+      end
+      # Only return trial offers that were created during the given date interval.
+      attr_accessor :created
+      # 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
+      # Only return trial offers that reference these prices (during the trial period).
+      attr_accessor :prices
+      # 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(
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        prices: nil,
+        starting_after: nil
+      )
+        @created = created
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @prices = prices
+        @starting_after = starting_after
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module ProductCatalog
+    class TrialOfferRetrieveParams < ::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/product_create_params.rb

@@ -169,6 +169,33 @@ module Stripe
       end
     end
 
+    class Identifiers < ::Stripe::RequestParams
+      # European Article Number (EAN) consisting of 8 or 13 digits and optional dashes. You may optionally provide a leading 0 for a total of 14 digits. The final digit is a validated check digit.
+      attr_accessor :ean
+      # Global Trade Item Number (GTIN) consisting of 8, 12, 13, or 14 digits and optional dashes. The final digit is a validated check digit.
+      attr_accessor :gtin
+      # International Standard Book Number (ISBN) consisting of 10 or 13 digits and optional dashes. The final digit is a validated check digit. For ISBN-10, the final digit may be a `X`.
+      attr_accessor :isbn
+      # Japanese Article Number (JAN) consisting of 13 digits and optional dashes. The first two digits must either be `45` or `49`. The final digit is a validated check digit.
+      attr_accessor :jan
+      # Manufacturer Part Number (MPN). May include up to 70 alphanumeric characters and dashes.
+      attr_accessor :mpn
+      # National Stock Number (NSN) consisting of 13 digits and optional dashes. The seventh character may also be alphanumeric.
+      attr_accessor :nsn
+      # Universal Product Code (UPC) consisting of 12 digits and optional dashes. The final digit is a validated check digit.
+      attr_accessor :upc
+
+      def initialize(ean: nil, gtin: nil, isbn: nil, jan: nil, mpn: nil, nsn: nil, upc: nil)
+        @ean = ean
+        @gtin = gtin
+        @isbn = isbn
+        @jan = jan
+        @mpn = mpn
+        @nsn = nsn
+        @upc = upc
+      end
+    end
+
     class MarketingFeature < ::Stripe::RequestParams
       # The marketing feature name. Up to 80 characters long.
       attr_accessor :name
@@ -195,6 +222,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.
@@ -205,6 +244,8 @@ module Stripe
     attr_accessor :expand
     # An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
     attr_accessor :id
+    # Other identifiers for this product.
+    attr_accessor :identifiers
     # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
     attr_accessor :images
     # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
@@ -224,6 +265,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.
@@ -237,6 +280,7 @@ module Stripe
       description: nil,
       expand: nil,
       id: nil,
+      identifiers: nil,
       images: nil,
       marketing_features: nil,
       metadata: nil,
@@ -245,6 +289,7 @@ module Stripe
       shippable: nil,
       statement_descriptor: nil,
       tax_code: nil,
+      tax_details: nil,
       type: nil,
       unit_label: nil,
       url: nil
@@ -254,6 +299,7 @@ module Stripe
       @description = description
       @expand = expand
       @id = id
+      @identifiers = identifiers
       @images = images
       @marketing_features = marketing_features
       @metadata = metadata
@@ -262,6 +308,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

@@ -3,6 +3,33 @@
 
 module Stripe
   class ProductUpdateParams < ::Stripe::RequestParams
+    class Identifiers < ::Stripe::RequestParams
+      # European Article Number (EAN) consisting of 8 or 13 digits and optional dashes. You may optionally provide a leading 0 for a total of 14 digits. The final digit is a validated check digit.
+      attr_accessor :ean
+      # Global Trade Item Number (GTIN) consisting of 8, 12, 13, or 14 digits and optional dashes. The final digit is a validated check digit.
+      attr_accessor :gtin
+      # International Standard Book Number (ISBN) consisting of 10 or 13 digits and optional dashes. The final digit is a validated check digit. For ISBN-10, the final digit may be a `X`.
+      attr_accessor :isbn
+      # Japanese Article Number (JAN) consisting of 13 digits and optional dashes. The first two digits must either be `45` or `49`. The final digit is a validated check digit.
+      attr_accessor :jan
+      # Manufacturer Part Number (MPN). May include up to 70 alphanumeric characters and dashes.
+      attr_accessor :mpn
+      # National Stock Number (NSN) consisting of 13 digits and optional dashes. The seventh character may also be alphanumeric.
+      attr_accessor :nsn
+      # Universal Product Code (UPC) consisting of 12 digits and optional dashes. The final digit is a validated check digit.
+      attr_accessor :upc
+
+      def initialize(ean: nil, gtin: nil, isbn: nil, jan: nil, mpn: nil, nsn: nil, upc: nil)
+        @ean = ean
+        @gtin = gtin
+        @isbn = isbn
+        @jan = jan
+        @mpn = mpn
+        @nsn = nsn
+        @upc = upc
+      end
+    end
+
     class MarketingFeature < ::Stripe::RequestParams
       # The marketing feature name. Up to 80 characters long.
       attr_accessor :name
@@ -29,6 +56,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.
@@ -37,6 +76,8 @@ module Stripe
     attr_accessor :description
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
+    # Other identifiers for this product.
+    attr_accessor :identifiers
     # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
     attr_accessor :images
     # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
@@ -56,6 +97,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.
@@ -66,6 +109,7 @@ module Stripe
       default_price: nil,
       description: nil,
       expand: nil,
+      identifiers: nil,
       images: nil,
       marketing_features: nil,
       metadata: nil,
@@ -74,6 +118,7 @@ module Stripe
       shippable: nil,
       statement_descriptor: nil,
       tax_code: nil,
+      tax_details: nil,
       unit_label: nil,
       url: nil
     )
@@ -81,6 +126,7 @@ module Stripe
       @default_price = default_price
       @description = description
       @expand = expand
+      @identifiers = identifiers
       @images = images
       @marketing_features = marketing_features
       @metadata = metadata
@@ -89,6 +135,7 @@ module Stripe
       @shippable = shippable
       @statement_descriptor = statement_descriptor
       @tax_code = tax_code
+      @tax_details = tax_details
       @unit_label = unit_label
       @url = url
     end