stripe 15.5.0 → 16.0.0

data/lib/stripe/params/product_create_params.rb

@@ -0,0 +1,243 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductCreateParams < Stripe::RequestParams
+    class DefaultPriceData < Stripe::RequestParams
+      class CurrencyOptions < Stripe::RequestParams
+        class CustomUnitAmount < Stripe::RequestParams
+          # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
+          attr_accessor :enabled
+          # The maximum unit amount the customer can specify for this item.
+          attr_accessor :maximum
+          # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+          attr_accessor :minimum
+          # The starting unit amount which can be updated by the customer.
+          attr_accessor :preset
+
+          def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil)
+            @enabled = enabled
+            @maximum = maximum
+            @minimum = minimum
+            @preset = preset
+          end
+        end
+
+        class Tier < Stripe::RequestParams
+          # The flat billing amount for an entire tier, regardless of the number of units in the tier.
+          attr_accessor :flat_amount
+          # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
+          attr_accessor :flat_amount_decimal
+          # The per unit billing amount for each individual unit for which this tier applies.
+          attr_accessor :unit_amount
+          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+          attr_accessor :unit_amount_decimal
+          # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
+          attr_accessor :up_to
+
+          def initialize(
+            flat_amount: nil,
+            flat_amount_decimal: nil,
+            unit_amount: nil,
+            unit_amount_decimal: nil,
+            up_to: nil
+          )
+            @flat_amount = flat_amount
+            @flat_amount_decimal = flat_amount_decimal
+            @unit_amount = unit_amount
+            @unit_amount_decimal = unit_amount_decimal
+            @up_to = up_to
+          end
+        end
+        # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+        attr_accessor :custom_unit_amount
+        # Only required if a [default tax behavior](https://stripe.com/docs/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.
+        attr_accessor :tax_behavior
+        # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
+        attr_accessor :tiers
+        # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
+        attr_accessor :unit_amount
+        # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+        attr_accessor :unit_amount_decimal
+
+        def initialize(
+          custom_unit_amount: nil,
+          tax_behavior: nil,
+          tiers: nil,
+          unit_amount: nil,
+          unit_amount_decimal: nil
+        )
+          @custom_unit_amount = custom_unit_amount
+          @tax_behavior = tax_behavior
+          @tiers = tiers
+          @unit_amount = unit_amount
+          @unit_amount_decimal = unit_amount_decimal
+        end
+      end
+
+      class CustomUnitAmount < Stripe::RequestParams
+        # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
+        attr_accessor :enabled
+        # The maximum unit amount the customer can specify for this item.
+        attr_accessor :maximum
+        # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+        attr_accessor :minimum
+        # The starting unit amount which can be updated by the customer.
+        attr_accessor :preset
+
+        def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil)
+          @enabled = enabled
+          @maximum = maximum
+          @minimum = minimum
+          @preset = preset
+        end
+      end
+
+      class Recurring < Stripe::RequestParams
+        # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
+        attr_accessor :interval
+        # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
+        attr_accessor :interval_count
+
+        def initialize(interval: nil, interval_count: nil)
+          @interval = interval
+          @interval_count = interval_count
+        end
+      end
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_accessor :currency
+      # 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
+      # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+      attr_accessor :custom_unit_amount
+      # Set of [key-value pairs](https://stripe.com/docs/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
+      # The recurring components of a price such as `interval` and `interval_count`.
+      attr_accessor :recurring
+      # Only required if a [default tax behavior](https://stripe.com/docs/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.
+      attr_accessor :tax_behavior
+      # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.
+      attr_accessor :unit_amount
+      # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+      attr_accessor :unit_amount_decimal
+
+      def initialize(
+        currency: nil,
+        currency_options: nil,
+        custom_unit_amount: nil,
+        metadata: nil,
+        recurring: nil,
+        tax_behavior: nil,
+        unit_amount: nil,
+        unit_amount_decimal: nil
+      )
+        @currency = currency
+        @currency_options = currency_options
+        @custom_unit_amount = custom_unit_amount
+        @metadata = metadata
+        @recurring = recurring
+        @tax_behavior = tax_behavior
+        @unit_amount = unit_amount
+        @unit_amount_decimal = unit_amount_decimal
+      end
+    end
+
+    class MarketingFeature < Stripe::RequestParams
+      # The marketing feature name. Up to 80 characters long.
+      attr_accessor :name
+
+      def initialize(name: nil)
+        @name = name
+      end
+    end
+
+    class PackageDimensions < Stripe::RequestParams
+      # Height, in inches. Maximum precision is 2 decimal places.
+      attr_accessor :height
+      # Length, in inches. Maximum precision is 2 decimal places.
+      attr_accessor :length
+      # Weight, in ounces. Maximum precision is 2 decimal places.
+      attr_accessor :weight
+      # Width, in inches. Maximum precision is 2 decimal places.
+      attr_accessor :width
+
+      def initialize(height: nil, length: nil, weight: nil, width: nil)
+        @height = height
+        @length = length
+        @weight = weight
+        @width = width
+      end
+    end
+    # Whether the product is currently available for purchase. Defaults to `true`.
+    attr_accessor :active
+    # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
+    attr_accessor :default_price_data
+    # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    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
+    # 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://stripe.com/docs/payments/checkout/pricing-table).
+    attr_accessor :marketing_features
+    # Set of [key-value pairs](https://stripe.com/docs/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
+    # The product's name, meant to be displayable to the customer.
+    attr_accessor :name
+    # The dimensions of this product for shipping purposes.
+    attr_accessor :package_dimensions
+    # Whether this product is shipped (i.e., physical goods).
+    attr_accessor :shippable
+    # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
+    #
+    # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
+    #  It must contain at least one letter. Only used for subscription payments.
+    attr_accessor :statement_descriptor
+    # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+    attr_accessor :tax_code
+    # 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.
+    attr_accessor :unit_label
+    # A URL of a publicly-accessible webpage for this product.
+    attr_accessor :url
+
+    def initialize(
+      active: nil,
+      default_price_data: nil,
+      description: nil,
+      expand: nil,
+      id: nil,
+      images: nil,
+      marketing_features: nil,
+      metadata: nil,
+      name: nil,
+      package_dimensions: nil,
+      shippable: nil,
+      statement_descriptor: nil,
+      tax_code: nil,
+      type: nil,
+      unit_label: nil,
+      url: nil
+    )
+      @active = active
+      @default_price_data = default_price_data
+      @description = description
+      @expand = expand
+      @id = id
+      @images = images
+      @marketing_features = marketing_features
+      @metadata = metadata
+      @name = name
+      @package_dimensions = package_dimensions
+      @shippable = shippable
+      @statement_descriptor = statement_descriptor
+      @tax_code = tax_code
+      @type = type
+      @unit_label = unit_label
+      @url = url
+    end
+  end
+end

data/lib/stripe/params/product_delete_params.rb

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductDeleteParams < Stripe::RequestParams; end
+end

data/lib/stripe/params/product_feature_create_params.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductFeatureCreateParams < Stripe::RequestParams
+    # The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product.
+    attr_accessor :entitlement_feature
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(entitlement_feature: nil, expand: nil)
+      @entitlement_feature = entitlement_feature
+      @expand = expand
+    end
+  end
+end

data/lib/stripe/params/product_feature_delete_params.rb

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductFeatureDeleteParams < Stripe::RequestParams; end
+end

data/lib/stripe/params/product_feature_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductFeatureListParams < 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

data/lib/stripe/params/product_feature_retrieve_params.rb

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

data/lib/stripe/params/product_list_params.rb

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductListParams < 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 products that are active or inactive (e.g., pass `false` to list all inactive products).
+    attr_accessor :active
+    # Only return products 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
+    # Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).
+    attr_accessor :ids
+    # 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 products that can be shipped (i.e., physical, not digital products).
+    attr_accessor :shippable
+    # 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
+    # Only return products of this type.
+    attr_accessor :type
+    # Only return products with the given url.
+    attr_accessor :url
+
+    def initialize(
+      active: nil,
+      created: nil,
+      ending_before: nil,
+      expand: nil,
+      ids: nil,
+      limit: nil,
+      shippable: nil,
+      starting_after: nil,
+      type: nil,
+      url: nil
+    )
+      @active = active
+      @created = created
+      @ending_before = ending_before
+      @expand = expand
+      @ids = ids
+      @limit = limit
+      @shippable = shippable
+      @starting_after = starting_after
+      @type = type
+      @url = url
+    end
+  end
+end

data/lib/stripe/params/product_retrieve_params.rb

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

data/lib/stripe/params/product_search_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductSearchParams < Stripe::RequestParams
+    # 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 pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+    attr_accessor :page
+    # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).
+    attr_accessor :query
+
+    def initialize(expand: nil, limit: nil, page: nil, query: nil)
+      @expand = expand
+      @limit = limit
+      @page = page
+      @query = query
+    end
+  end
+end

data/lib/stripe/params/product_update_params.rb

@@ -0,0 +1,96 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ProductUpdateParams < Stripe::RequestParams
+    class MarketingFeature < Stripe::RequestParams
+      # The marketing feature name. Up to 80 characters long.
+      attr_accessor :name
+
+      def initialize(name: nil)
+        @name = name
+      end
+    end
+
+    class PackageDimensions < Stripe::RequestParams
+      # Height, in inches. Maximum precision is 2 decimal places.
+      attr_accessor :height
+      # Length, in inches. Maximum precision is 2 decimal places.
+      attr_accessor :length
+      # Weight, in ounces. Maximum precision is 2 decimal places.
+      attr_accessor :weight
+      # Width, in inches. Maximum precision is 2 decimal places.
+      attr_accessor :width
+
+      def initialize(height: nil, length: nil, weight: nil, width: nil)
+        @height = height
+        @length = length
+        @weight = weight
+        @width = width
+      end
+    end
+    # Whether the product is available for purchase.
+    attr_accessor :active
+    # The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
+    attr_accessor :default_price
+    # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+    attr_accessor :description
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # 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://stripe.com/docs/payments/checkout/pricing-table).
+    attr_accessor :marketing_features
+    # Set of [key-value pairs](https://stripe.com/docs/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
+    # The product's name, meant to be displayable to the customer.
+    attr_accessor :name
+    # The dimensions of this product for shipping purposes.
+    attr_accessor :package_dimensions
+    # Whether this product is shipped (i.e., physical goods).
+    attr_accessor :shippable
+    # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
+    #
+    # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
+    #  It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
+    attr_accessor :statement_descriptor
+    # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+    attr_accessor :tax_code
+    # 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.
+    attr_accessor :url
+
+    def initialize(
+      active: nil,
+      default_price: nil,
+      description: nil,
+      expand: nil,
+      images: nil,
+      marketing_features: nil,
+      metadata: nil,
+      name: nil,
+      package_dimensions: nil,
+      shippable: nil,
+      statement_descriptor: nil,
+      tax_code: nil,
+      unit_label: nil,
+      url: nil
+    )
+      @active = active
+      @default_price = default_price
+      @description = description
+      @expand = expand
+      @images = images
+      @marketing_features = marketing_features
+      @metadata = metadata
+      @name = name
+      @package_dimensions = package_dimensions
+      @shippable = shippable
+      @statement_descriptor = statement_descriptor
+      @tax_code = tax_code
+      @unit_label = unit_label
+      @url = url
+    end
+  end
+end

data/lib/stripe/params/promotion_code_create_params.rb

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PromotionCodeCreateParams < Stripe::RequestParams
+    class Promotion < Stripe::RequestParams
+      # If promotion `type` is `coupon`, the coupon for this promotion code.
+      attr_accessor :coupon
+      # Specifies the type of promotion.
+      attr_accessor :type
+
+      def initialize(coupon: nil, type: nil)
+        @coupon = coupon
+        @type = type
+      end
+    end
+
+    class Restrictions < Stripe::RequestParams
+      class CurrencyOptions < Stripe::RequestParams
+        # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
+        attr_accessor :minimum_amount
+
+        def initialize(minimum_amount: nil)
+          @minimum_amount = minimum_amount
+        end
+      end
+      # Promotion codes 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
+      # A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
+      attr_accessor :first_time_transaction
+      # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
+      attr_accessor :minimum_amount
+      # Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount
+      attr_accessor :minimum_amount_currency
+
+      def initialize(
+        currency_options: nil,
+        first_time_transaction: nil,
+        minimum_amount: nil,
+        minimum_amount_currency: nil
+      )
+        @currency_options = currency_options
+        @first_time_transaction = first_time_transaction
+        @minimum_amount = minimum_amount
+        @minimum_amount_currency = minimum_amount_currency
+      end
+    end
+    # Whether the promotion code is currently active.
+    attr_accessor :active
+    # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
+    #
+    # If left blank, we will generate one automatically.
+    attr_accessor :code
+    # The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
+    attr_accessor :customer
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # The timestamp at which this promotion code will expire. If the coupon has specified a `redeems_by`, then this value cannot be after the coupon's `redeems_by`.
+    attr_accessor :expires_at
+    # A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`.
+    attr_accessor :max_redemptions
+    # Set of [key-value pairs](https://stripe.com/docs/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
+    # The promotion referenced by this promotion code.
+    attr_accessor :promotion
+    # Settings that restrict the redemption of the promotion code.
+    attr_accessor :restrictions
+
+    def initialize(
+      active: nil,
+      code: nil,
+      customer: nil,
+      expand: nil,
+      expires_at: nil,
+      max_redemptions: nil,
+      metadata: nil,
+      promotion: nil,
+      restrictions: nil
+    )
+      @active = active
+      @code = code
+      @customer = customer
+      @expand = expand
+      @expires_at = expires_at
+      @max_redemptions = max_redemptions
+      @metadata = metadata
+      @promotion = promotion
+      @restrictions = restrictions
+    end
+  end
+end

data/lib/stripe/params/promotion_code_list_params.rb

@@ -0,0 +1,64 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PromotionCodeListParams < 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
+    # Filter promotion codes by whether they are active.
+    attr_accessor :active
+    # Only return promotion codes that have this case-insensitive code.
+    attr_accessor :code
+    # Only return promotion codes for this coupon.
+    attr_accessor :coupon
+    # A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
+    attr_accessor :created
+    # Only return promotion codes that are restricted to this customer.
+    attr_accessor :customer
+    # 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(
+      active: nil,
+      code: nil,
+      coupon: nil,
+      created: nil,
+      customer: nil,
+      ending_before: nil,
+      expand: nil,
+      limit: nil,
+      starting_after: nil
+    )
+      @active = active
+      @code = code
+      @coupon = coupon
+      @created = created
+      @customer = customer
+      @ending_before = ending_before
+      @expand = expand
+      @limit = limit
+      @starting_after = starting_after
+    end
+  end
+end