stripe 16.1.0.pre.beta.1 → 17.1.0.pre.alpha.1

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

data/lib/stripe/params/v2/billing/license_fees/version_list_params.rb

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

data/lib/stripe/params/v2/billing/license_fees/version_retrieve_params.rb

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

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

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicensedItemCreateParams < ::Stripe::RequestParams
+        class TaxDetails < ::Stripe::RequestParams
+          # Product tax code (PTC).
+          attr_accessor :tax_code
+
+          def initialize(tax_code: nil)
+            @tax_code = tax_code
+          end
+        end
+        # Description that customers will see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular billable item.
+        # Must be unique among billable items.
+        # 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
+        # Stripe Tax details.
+        attr_accessor :tax_details
+        # The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field
+        # to "seat" for Checkout to display "(price) per seat", or "environment" to display "(price) per environment".
+        # Maximum length of 100 characters.
+        attr_accessor :unit_label
+
+        def initialize(
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_details: nil,
+          unit_label: nil
+        )
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_details = tax_details
+          @unit_label = unit_label
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicensedItemListParams < ::Stripe::RequestParams
+        # 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(limit: nil, lookup_keys: nil)
+          @limit = limit
+          @lookup_keys = lookup_keys
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class LicensedItemUpdateParams < ::Stripe::RequestParams
+        class TaxDetails < ::Stripe::RequestParams
+          # Product tax code (PTC).
+          attr_accessor :tax_code
+
+          def initialize(tax_code: nil)
+            @tax_code = tax_code
+          end
+        end
+        # Description that customers will see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular billable item.
+        # Maximum length of 200 characters.
+        # To remove the lookup_key from the object, set it to null in the request.
+        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
+        # Stripe Tax details.
+        attr_accessor :tax_details
+        # The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field
+        # to "seat" for Checkout to display "(price) per seat", or "environment" to display "(price) per environment".
+        # Maximum length of 100 characters.
+        attr_accessor :unit_label
+
+        def initialize(
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_details: nil,
+          unit_label: nil
+        )
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_details = tax_details
+          @unit_label = unit_label
+        end
+      end
+    end
+  end
+end

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

@@ -4,8 +4,8 @@
 module Stripe
   module V2
     module Billing
-      class MeterEventAdjustmentCreateParams < Stripe::RequestParams
-        class Cancel < Stripe::RequestParams
+      class MeterEventAdjustmentCreateParams < ::Stripe::RequestParams
+        class Cancel < ::Stripe::RequestParams
           # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
           attr_accessor :identifier
 

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

@@ -4,7 +4,7 @@
 module Stripe
   module V2
     module Billing
-      class MeterEventCreateParams < Stripe::RequestParams
+      class MeterEventCreateParams < ::Stripe::RequestParams
         # The name of the meter event. Corresponds with the `event_name` field on a meter.
         attr_accessor :event_name
         # A unique identifier for the event. If not provided, one will be generated.

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

@@ -4,7 +4,7 @@
 module Stripe
   module V2
     module Billing
-      class MeterEventSessionCreateParams < Stripe::RequestParams; end
+      class MeterEventSessionCreateParams < ::Stripe::RequestParams; end
     end
   end
 end

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

@@ -4,8 +4,8 @@
 module Stripe
   module V2
     module Billing
-      class MeterEventStreamCreateParams < Stripe::RequestParams
-        class Event < Stripe::RequestParams
+      class MeterEventStreamCreateParams < ::Stripe::RequestParams
+        class Event < ::Stripe::RequestParams
           # The name of the meter event. Corresponds with the `event_name` field on a meter.
           attr_accessor :event_name
           # A unique identifier for the event. If not provided, one will be generated.

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

@@ -0,0 +1,73 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeteredItemCreateParams < ::Stripe::RequestParams
+        class MeterSegmentCondition < ::Stripe::RequestParams
+          # A Meter dimension.
+          attr_accessor :dimension
+          # To count usage towards this metered item, the dimension must have this value.
+          attr_accessor :value
+
+          def initialize(dimension: nil, value: nil)
+            @dimension = dimension
+            @value = value
+          end
+        end
+
+        class TaxDetails < ::Stripe::RequestParams
+          # Product tax code (PTC).
+          attr_accessor :tax_code
+
+          def initialize(tax_code: nil)
+            @tax_code = tax_code
+          end
+        end
+        # Description that customers will see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # Optional array of Meter dimensions to group event dimension keys for invoice line items.
+        attr_accessor :invoice_presentation_dimensions
+        # An internal key you can use to search for a particular billable item.
+        # Must be unique among billable items.
+        # 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
+        # ID of the Meter that measures usage for this Metered Item.
+        attr_accessor :meter
+        # Optional array of Meter segments to filter event dimension keys for billing.
+        attr_accessor :meter_segment_conditions
+        # Stripe Tax details.
+        attr_accessor :tax_details
+        # The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field
+        # to "CPU-hour" for Checkout to display "(price) per CPU-hour", or "1 million events" to display "(price) per 1
+        # million events".
+        # Maximum length of 100 characters.
+        attr_accessor :unit_label
+
+        def initialize(
+          display_name: nil,
+          invoice_presentation_dimensions: nil,
+          lookup_key: nil,
+          metadata: nil,
+          meter: nil,
+          meter_segment_conditions: nil,
+          tax_details: nil,
+          unit_label: nil
+        )
+          @display_name = display_name
+          @invoice_presentation_dimensions = invoice_presentation_dimensions
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @meter = meter
+          @meter_segment_conditions = meter_segment_conditions
+          @tax_details = tax_details
+          @unit_label = unit_label
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeteredItemListParams < ::Stripe::RequestParams
+        # 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(limit: nil, lookup_keys: nil)
+          @limit = limit
+          @lookup_keys = lookup_keys
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeteredItemUpdateParams < ::Stripe::RequestParams
+        class TaxDetails < ::Stripe::RequestParams
+          # Product tax code (PTC).
+          attr_accessor :tax_code
+
+          def initialize(tax_code: nil)
+            @tax_code = tax_code
+          end
+        end
+        # Description that customers will see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular billable item.
+        # Maximum length of 200 characters.
+        # To remove the lookup_key from the object, set it to null in the request.
+        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
+        # Stripe Tax details.
+        attr_accessor :tax_details
+        # The unit to use when displaying prices for this billable item in places like Checkout. For example, set this field
+        # to "CPU-hour" for Checkout to display "(price) per CPU-hour", or "1 million events" to display "(price) per 1
+        # million events".
+        # Maximum length of 100 characters.
+        # To remove the unit_label from the object, set it to null in the request.
+        attr_accessor :unit_label
+
+        def initialize(
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_details: nil,
+          unit_label: nil
+        )
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_details = tax_details
+          @unit_label = unit_label
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanCreateParams < ::Stripe::RequestParams
+        # The currency of the PricingPlan.
+        attr_accessor :currency
+        # Description of pricing plan subscription.
+        attr_accessor :description
+        # Display name of the PricingPlan. Maximum 250 characters.
+        attr_accessor :display_name
+        # An internal key you can use to search for a particular PricingPlan. 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 Stripe Tax tax behavior - whether the PricingPlan is inclusive or exclusive of tax.
+        attr_accessor :tax_behavior
+
+        def initialize(
+          currency: nil,
+          description: nil,
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          tax_behavior: nil
+        )
+          @currency = currency
+          @description = description
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @tax_behavior = tax_behavior
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionListParams < ::Stripe::RequestParams
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Customer object. If provided, only Pricing Plan Subscriptions that are subscribed on the cadences with the specified payer will be returned.
+          attr_accessor :customer
+          # A string identifying the type of the payer. Currently the only supported value is `customer`.
+          attr_accessor :type
+
+          def initialize(customer: nil, type: nil)
+            @customer = customer
+            @type = type
+          end
+        end
+        # Filter by Billing Cadence ID. Mutually exclusive with `payer`, `pricing_plan`, and `pricing_plan_version`.
+        attr_accessor :billing_cadence
+        # Optionally set the maximum number of results per page. Defaults to 20.
+        attr_accessor :limit
+        # Filter by payer. Mutually exclusive with `billing_cadence`, `pricing_plan`, and `pricing_plan_version`.
+        attr_accessor :payer
+        # Filter by PricingPlan ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan_version`.
+        attr_accessor :pricing_plan
+        # Filter by Pricing Plan Version ID. Mutually exlcusive with `billing_cadence`, `payer`, and `pricing_plan`.
+        attr_accessor :pricing_plan_version
+        # Filter by servicing status.
+        attr_accessor :servicing_status
+
+        def initialize(
+          billing_cadence: nil,
+          limit: nil,
+          payer: nil,
+          pricing_plan: nil,
+          pricing_plan_version: nil,
+          servicing_status: nil
+        )
+          @billing_cadence = billing_cadence
+          @limit = limit
+          @payer = payer
+          @pricing_plan = pricing_plan
+          @pricing_plan_version = pricing_plan_version
+          @servicing_status = servicing_status
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/pricing_plan_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 PricingPlanSubscriptionRetrieveParams < ::Stripe::RequestParams; end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanSubscriptionUpdateParams < ::Stripe::RequestParams
+        # When set to true, the `servicing_status_transition.will_cancel_at` field will be cleared.
+        attr_accessor :clear_cancel_at
+        # 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
+
+        def initialize(clear_cancel_at: nil, metadata: nil)
+          @clear_cancel_at = clear_cancel_at
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class PricingPlanUpdateParams < ::Stripe::RequestParams
+        # Whether the PricingPlan is active.
+        attr_accessor :active
+        # Description of pricing plan subscription.
+        attr_accessor :description
+        # Display name of the PricingPlan. Maximum 250 characters.
+        attr_accessor :display_name
+        # The ID of the live version of the PricingPlan.
+        attr_accessor :live_version
+        # An internal key you can use to search for a particular PricingPlan. Maximum length of 200 characters.
+        attr_accessor :lookup_key
+        # Set of key-value pairs that you can attach to an object.
+        attr_accessor :metadata
+
+        def initialize(
+          active: nil,
+          description: nil,
+          display_name: nil,
+          live_version: nil,
+          lookup_key: nil,
+          metadata: nil
+        )
+          @active = active
+          @description = description
+          @display_name = display_name
+          @live_version = live_version
+          @lookup_key = lookup_key
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end