stripe 17.0.0 → 17.1.0.pre.alpha.1

data/lib/stripe/params/v2/billing/intent_create_params.rb

@@ -0,0 +1,355 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class IntentCreateParams < ::Stripe::RequestParams
+        class Action < ::Stripe::RequestParams
+          class Apply < ::Stripe::RequestParams
+            class InvoiceDiscountRule < ::Stripe::RequestParams
+              class PercentOff < ::Stripe::RequestParams
+                class MaximumApplications < ::Stripe::RequestParams
+                  # The type of maximum applications configuration.
+                  attr_accessor :type
+
+                  def initialize(type: nil)
+                    @type = type
+                  end
+                end
+                # The maximum number of times this discount can be applied for this cadence.
+                attr_accessor :maximum_applications
+                # Percent that will be taken off of the amount. For example, percent_off of 50.0 will make $100 amount $50 instead.
+                attr_accessor :percent_off
+
+                def initialize(maximum_applications: nil, percent_off: nil)
+                  @maximum_applications = maximum_applications
+                  @percent_off = percent_off
+                end
+              end
+              # The entity that the discount rule applies to, for example, the cadence.
+              attr_accessor :applies_to
+              # Type of the discount rule.
+              attr_accessor :type
+              # Configuration for percentage off discount.
+              attr_accessor :percent_off
+
+              def initialize(applies_to: nil, type: nil, percent_off: nil)
+                @applies_to = applies_to
+                @type = type
+                @percent_off = percent_off
+              end
+            end
+            # Type of the apply action details.
+            attr_accessor :type
+            # Details for applying a discount rule to future invoices.
+            attr_accessor :invoice_discount_rule
+
+            def initialize(type: nil, invoice_discount_rule: nil)
+              @type = type
+              @invoice_discount_rule = invoice_discount_rule
+            end
+          end
+
+          class Deactivate < ::Stripe::RequestParams
+            class BillingDetails < ::Stripe::RequestParams
+              # This controls the proration adjustment for the partial servicing period.
+              attr_accessor :proration_behavior
+
+              def initialize(proration_behavior: nil)
+                @proration_behavior = proration_behavior
+              end
+            end
+
+            class EffectiveAt < ::Stripe::RequestParams
+              # The timestamp at which the deactivate action will take effect. Only present if type is timestamp.
+              attr_accessor :timestamp
+              # When the deactivate action will take effect.
+              attr_accessor :type
+
+              def initialize(timestamp: nil, type: nil)
+                @timestamp = timestamp
+                @type = type
+              end
+            end
+
+            class PricingPlanSubscriptionDetails < ::Stripe::RequestParams
+              # ID of the pricing plan subscription to deactivate.
+              attr_accessor :pricing_plan_subscription
+
+              def initialize(pricing_plan_subscription: nil)
+                @pricing_plan_subscription = pricing_plan_subscription
+              end
+            end
+            # Configuration for the billing details.
+            attr_accessor :billing_details
+            # When the deactivate action will take effect. If not specified, the default behavior is on_reserve.
+            attr_accessor :effective_at
+            # Details for deactivating a pricing plan subscription.
+            attr_accessor :pricing_plan_subscription_details
+            # Type of the action details.
+            attr_accessor :type
+
+            def initialize(
+              billing_details: nil,
+              effective_at: nil,
+              pricing_plan_subscription_details: nil,
+              type: nil
+            )
+              @billing_details = billing_details
+              @effective_at = effective_at
+              @pricing_plan_subscription_details = pricing_plan_subscription_details
+              @type = type
+            end
+          end
+
+          class Modify < ::Stripe::RequestParams
+            class BillingDetails < ::Stripe::RequestParams
+              # This controls the proration adjustment for the partial servicing period.
+              attr_accessor :proration_behavior
+
+              def initialize(proration_behavior: nil)
+                @proration_behavior = proration_behavior
+              end
+            end
+
+            class EffectiveAt < ::Stripe::RequestParams
+              # The timestamp at which the modify action will take effect. Only present if type is timestamp.
+              attr_accessor :timestamp
+              # When the modify action will take effect.
+              attr_accessor :type
+
+              def initialize(timestamp: nil, type: nil)
+                @timestamp = timestamp
+                @type = type
+              end
+            end
+
+            class PricingPlanSubscriptionDetails < ::Stripe::RequestParams
+              class ComponentConfiguration < ::Stripe::RequestParams
+                # Quantity of the component to be used.
+                attr_accessor :quantity
+                # Lookup key for the pricing plan component.
+                attr_accessor :lookup_key
+                # ID of the pricing plan component.
+                attr_accessor :pricing_plan_component
+
+                def initialize(quantity: nil, lookup_key: nil, pricing_plan_component: nil)
+                  @quantity = quantity
+                  @lookup_key = lookup_key
+                  @pricing_plan_component = pricing_plan_component
+                end
+              end
+              # New configurations for the components of the pricing plan.
+              attr_accessor :component_configurations
+              # The ID of the new Pricing Plan, if changing plans.
+              attr_accessor :new_pricing_plan
+              # The ID of the new Pricing Plan Version to use.
+              attr_accessor :new_pricing_plan_version
+              # The ID of the Pricing Plan Subscription to modify.
+              attr_accessor :pricing_plan_subscription
+
+              def initialize(
+                component_configurations: nil,
+                new_pricing_plan: nil,
+                new_pricing_plan_version: nil,
+                pricing_plan_subscription: nil
+              )
+                @component_configurations = component_configurations
+                @new_pricing_plan = new_pricing_plan
+                @new_pricing_plan_version = new_pricing_plan_version
+                @pricing_plan_subscription = pricing_plan_subscription
+              end
+            end
+            # Configuration for the billing details.
+            attr_accessor :billing_details
+            # When the modify action will take effect. If not specified, the default behavior is on_reserve.
+            attr_accessor :effective_at
+            # Details for modifying a pricing plan subscription.
+            attr_accessor :pricing_plan_subscription_details
+            # Type of the action details.
+            attr_accessor :type
+
+            def initialize(
+              billing_details: nil,
+              effective_at: nil,
+              pricing_plan_subscription_details: nil,
+              type: nil
+            )
+              @billing_details = billing_details
+              @effective_at = effective_at
+              @pricing_plan_subscription_details = pricing_plan_subscription_details
+              @type = type
+            end
+          end
+
+          class Remove < ::Stripe::RequestParams
+            # Type of the remove action.
+            attr_accessor :type
+            # The ID of the discount rule to remove for future invoices.
+            attr_accessor :invoice_discount_rule
+
+            def initialize(type: nil, invoice_discount_rule: nil)
+              @type = type
+              @invoice_discount_rule = invoice_discount_rule
+            end
+          end
+
+          class Subscribe < ::Stripe::RequestParams
+            class BillingDetails < ::Stripe::RequestParams
+              # This controls the proration adjustment for the partial servicing period.
+              attr_accessor :proration_behavior
+
+              def initialize(proration_behavior: nil)
+                @proration_behavior = proration_behavior
+              end
+            end
+
+            class EffectiveAt < ::Stripe::RequestParams
+              # The timestamp at which the subscribe action will take effect. Only present if type is timestamp.
+              attr_accessor :timestamp
+              # When the subscribe action will take effect.
+              attr_accessor :type
+
+              def initialize(timestamp: nil, type: nil)
+                @timestamp = timestamp
+                @type = type
+              end
+            end
+
+            class PricingPlanSubscriptionDetails < ::Stripe::RequestParams
+              class ComponentConfiguration < ::Stripe::RequestParams
+                # Quantity of the component to be used.
+                attr_accessor :quantity
+                # Lookup key for the pricing plan component.
+                attr_accessor :lookup_key
+                # ID of the pricing plan component.
+                attr_accessor :pricing_plan_component
+
+                def initialize(quantity: nil, lookup_key: nil, pricing_plan_component: nil)
+                  @quantity = quantity
+                  @lookup_key = lookup_key
+                  @pricing_plan_component = pricing_plan_component
+                end
+              end
+              # Configurations for the components of the pricing plan.
+              attr_accessor :component_configurations
+              # Set of [key-value pairs](/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.
+              attr_accessor :metadata
+              # ID of the Pricing Plan to subscribe to.
+              attr_accessor :pricing_plan
+              # Version of the Pricing Plan to use.
+              attr_accessor :pricing_plan_version
+
+              def initialize(
+                component_configurations: nil,
+                metadata: nil,
+                pricing_plan: nil,
+                pricing_plan_version: nil
+              )
+                @component_configurations = component_configurations
+                @metadata = metadata
+                @pricing_plan = pricing_plan
+                @pricing_plan_version = pricing_plan_version
+              end
+            end
+
+            class V1SubscriptionDetails < ::Stripe::RequestParams
+              class Item < ::Stripe::RequestParams
+                # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+                attr_accessor :metadata
+                # The ID of the price object.
+                attr_accessor :price
+                # Quantity for this item. If not provided, will default to 1.
+                attr_accessor :quantity
+
+                def initialize(metadata: nil, price: nil, quantity: nil)
+                  @metadata = metadata
+                  @price = price
+                  @quantity = quantity
+                end
+              end
+              # The subscription’s description, meant to be displayable to the customer.
+              # Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
+              attr_accessor :description
+              # A list of up to 20 subscription items, each with an attached price.
+              attr_accessor :items
+              # Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+              attr_accessor :metadata
+
+              def initialize(description: nil, items: nil, metadata: nil)
+                @description = description
+                @items = items
+                @metadata = metadata
+              end
+            end
+            # Configuration for the billing details. If not specified, see the default behavior for individual attributes.
+            attr_accessor :billing_details
+            # When the subscribe action will take effect. If not specified, the default behavior is on_reserve.
+            attr_accessor :effective_at
+            # Type of the action details.
+            attr_accessor :type
+            # Details for subscribing to a pricing plan.
+            attr_accessor :pricing_plan_subscription_details
+            # Details for subscribing to a v1 subscription.
+            attr_accessor :v1_subscription_details
+
+            def initialize(
+              billing_details: nil,
+              effective_at: nil,
+              type: nil,
+              pricing_plan_subscription_details: nil,
+              v1_subscription_details: nil
+            )
+              @billing_details = billing_details
+              @effective_at = effective_at
+              @type = type
+              @pricing_plan_subscription_details = pricing_plan_subscription_details
+              @v1_subscription_details = v1_subscription_details
+            end
+          end
+          # Type of the Billing Intent action.
+          attr_accessor :type
+          # Details for an apply action.
+          attr_accessor :apply
+          # Details for a deactivate action.
+          attr_accessor :deactivate
+          # Details for a modify action.
+          attr_accessor :modify
+          # Details for a remove action.
+          attr_accessor :remove
+          # Details for a subscribe action.
+          attr_accessor :subscribe
+
+          def initialize(
+            type: nil,
+            apply: nil,
+            deactivate: nil,
+            modify: nil,
+            remove: nil,
+            subscribe: nil
+          )
+            @type = type
+            @apply = apply
+            @deactivate = deactivate
+            @modify = modify
+            @remove = remove
+            @subscribe = subscribe
+          end
+        end
+        # Actions to be performed by this Billing Intent.
+        attr_accessor :actions
+        # Three-letter ISO currency code, in lowercase. Must be a supported currency.
+        attr_accessor :currency
+        # ID of an existing Cadence to use.
+        attr_accessor :cadence
+
+        def initialize(actions: nil, currency: nil, cadence: nil)
+          @actions = actions
+          @currency = currency
+          @cadence = cadence
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/intent_list_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class IntentListParams < ::Stripe::RequestParams
+        # Optionally set the maximum number of results per page. Defaults to 10.
+        attr_accessor :limit
+
+        def initialize(limit: nil)
+          @limit = limit
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/intent_release_reservation_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class IntentReleaseReservationParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/intent_reserve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class IntentReserveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/intent_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class IntentRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/intents/action_list_params.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module Intents
+        class ActionListParams < ::Stripe::RequestParams
+          # Optionally set the maximum number of results per page. Defaults to 10.
+          attr_accessor :limit
+
+          def initialize(limit: nil)
+            @limit = limit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/intents/action_retrieve_params.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module Intents
+        class ActionRetrieveParams < ::Stripe::RequestParams; end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/license_fee_create_params.rb

@@ -0,0 +1,103 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicenseFeeCreateParams < ::Stripe::RequestParams
+        class Tier < ::Stripe::RequestParams
+          # Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
+          attr_accessor :flat_amount
+          # Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at
+          # most 12 decimal places.
+          attr_accessor :unit_amount
+          # Up to and including this quantity will be contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+          # be set.
+          attr_accessor :up_to_decimal
+          # No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+          attr_accessor :up_to_inf
+
+          def initialize(flat_amount: nil, unit_amount: nil, up_to_decimal: nil, up_to_inf: nil)
+            @flat_amount = flat_amount
+            @unit_amount = unit_amount
+            @up_to_decimal = up_to_decimal
+            @up_to_inf = up_to_inf
+          end
+        end
+
+        class TransformQuantity < ::Stripe::RequestParams
+          # Divide usage by this number.
+          attr_accessor :divide_by
+          # After division, round the result up or down.
+          attr_accessor :round
+
+          def initialize(divide_by: nil, round: nil)
+            @divide_by = divide_by
+            @round = round
+          end
+        end
+        # Three-letter ISO currency code, in lowercase. Must be a supported currency.
+        attr_accessor :currency
+        # A customer-facing name for the License Fee.
+        # This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # The Licensed Item that this License Fee binds to.
+        attr_accessor :licensed_item
+        # An internal key you can use to search for a particular license fee. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of [key-value pairs](/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.
+        attr_accessor :metadata
+        # The interval for assessing service. For example, a monthly license fee with a rate of $1 for the first 10 "workloads"
+        # and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but
+        # distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees,
+        # while the billing interval in Cadence deals with the rate the customer is billed.
+        attr_accessor :service_interval
+        # The length of the interval for assessing service. For example, set this to 3 and `service_interval` to `"month"` in
+        # order to specify quarterly service.
+        attr_accessor :service_interval_count
+        # The Stripe Tax tax behavior - whether the license fee is inclusive or exclusive of tax.
+        attr_accessor :tax_behavior
+        # Defines whether the tiered price should be graduated or volume-based. In volume-based tiering, the maximum
+        # quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity
+        # grows into new tiers. Can only be set if `tiers` is set.
+        attr_accessor :tiering_mode
+        # Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+        attr_accessor :tiers
+        # Apply a transformation to the reported usage or set quantity before computing the amount billed.
+        attr_accessor :transform_quantity
+        # The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal
+        # places. Cannot be set if `tiers` is provided.
+        attr_accessor :unit_amount
+
+        def initialize(
+          currency: nil,
+          display_name: nil,
+          licensed_item: nil,
+          lookup_key: nil,
+          metadata: nil,
+          service_interval: nil,
+          service_interval_count: nil,
+          tax_behavior: nil,
+          tiering_mode: nil,
+          tiers: nil,
+          transform_quantity: nil,
+          unit_amount: nil
+        )
+          @currency = currency
+          @display_name = display_name
+          @licensed_item = licensed_item
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @service_interval = service_interval
+          @service_interval_count = service_interval_count
+          @tax_behavior = tax_behavior
+          @tiering_mode = tiering_mode
+          @tiers = tiers
+          @transform_quantity = transform_quantity
+          @unit_amount = unit_amount
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/license_fee_list_params.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicenseFeeListParams < ::Stripe::RequestParams
+        # Filter by licensed item.
+        attr_accessor :licensed_item
+        # Optionally set the maximum number of results per page. Defaults to 20.
+        attr_accessor :limit
+        # Filter by lookup keys.
+        # You can specify up to 10 lookup keys.
+        attr_accessor :lookup_keys
+
+        def initialize(licensed_item: nil, limit: nil, lookup_keys: nil)
+          @licensed_item = licensed_item
+          @limit = limit
+          @lookup_keys = lookup_keys
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/license_fee_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicenseFeeRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/license_fee_subscription_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicenseFeeSubscriptionRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/license_fee_update_params.rb

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicenseFeeUpdateParams < ::Stripe::RequestParams
+        class Tier < ::Stripe::RequestParams
+          # Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
+          attr_accessor :flat_amount
+          # Per-unit price for units included in this tier, represented as a decimal string in minor currency units with at
+          # most 12 decimal places.
+          attr_accessor :unit_amount
+          # Up to and including this quantity will be contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+          # be set.
+          attr_accessor :up_to_decimal
+          # No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+          attr_accessor :up_to_inf
+
+          def initialize(flat_amount: nil, unit_amount: nil, up_to_decimal: nil, up_to_inf: nil)
+            @flat_amount = flat_amount
+            @unit_amount = unit_amount
+            @up_to_decimal = up_to_decimal
+            @up_to_inf = up_to_inf
+          end
+        end
+
+        class TransformQuantity < ::Stripe::RequestParams
+          # Divide usage by this number.
+          attr_accessor :divide_by
+          # After division, round the result up or down.
+          attr_accessor :round
+
+          def initialize(divide_by: nil, round: nil)
+            @divide_by = divide_by
+            @round = round
+          end
+        end
+        # A customer-facing name for the License Fee.
+        # This name is used in Stripe-hosted products like the Customer Portal and Checkout. It does not show up on Invoices.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # Changes the version that new license fee will use. Providing `live_version = "latest"` will set the
+        # license fee's `live_version` to its latest version.
+        attr_accessor :live_version
+        # An internal key you can use to search for a particular license fee. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of [key-value pairs](/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.
+        attr_accessor :metadata
+        # Defines whether the tiered price should be graduated or volume-based. In volume-based tiering, the maximum
+        # quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity
+        # grows into new tiers. Can only be set if `tiers` is set.
+        attr_accessor :tiering_mode
+        # Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+        attr_accessor :tiers
+        # Apply a transformation to the reported usage or set quantity before computing the amount billed.
+        attr_accessor :transform_quantity
+        # The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal
+        # places. Cannot be set if `tiers` is provided.
+        attr_accessor :unit_amount
+
+        def initialize(
+          display_name: nil,
+          live_version: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tiering_mode: nil,
+          tiers: nil,
+          transform_quantity: nil,
+          unit_amount: nil
+        )
+          @display_name = display_name
+          @live_version = live_version
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tiering_mode = tiering_mode
+          @tiers = tiers
+          @transform_quantity = transform_quantity
+          @unit_amount = unit_amount
+        end
+      end
+    end
+  end
+end