stripe 19.2.0 → 19.3.0.pre.alpha.2

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

@@ -0,0 +1,49 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardCreateParams < ::Stripe::RequestParams
+        # The currency of this RateCard.
+        attr_accessor :currency
+        # A customer-facing name for the RateCard.
+        # 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
+        # An internal key you can use to search for a particular RateCard. 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 RateCard with a rate of 1 USD for the first 10 "workloads"
+        # and 2 USD thereafter means "1 USD 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"`
+        # to specify quarterly service.
+        attr_accessor :service_interval_count
+        # The tax behavior for Stripe Tax — whether the rate card price includes or excludes tax.
+        attr_accessor :tax_behavior
+
+        def initialize(
+          currency: nil,
+          display_name: nil,
+          lookup_key: nil,
+          metadata: nil,
+          service_interval: nil,
+          service_interval_count: nil,
+          tax_behavior: nil
+        )
+          @currency = currency
+          @display_name = display_name
+          @lookup_key = lookup_key
+          @metadata = metadata
+          @service_interval = service_interval
+          @service_interval_count = service_interval_count
+          @tax_behavior = tax_behavior
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardListParams < ::Stripe::RequestParams
+        # Optionally filter to active/inactive RateCards.
+        attr_accessor :active
+        # 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(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/rate_card_modify_rates_params.rb

@@ -0,0 +1,177 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardModifyRatesParams < ::Stripe::RequestParams
+        class RatesToCreate < ::Stripe::RequestParams
+          class MeteredItemData < ::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
+            # Description that customers 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 metered item.
+            # Must be unique among metered items.
+            # Maximum length of 200 characters.
+            attr_accessor :lookup_key
+            # 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
+            # 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,
+              lookup_key: nil,
+              meter: nil,
+              meter_segment_conditions: nil,
+              unit_label: nil
+            )
+              @display_name = display_name
+              @lookup_key = lookup_key
+              @meter = meter
+              @meter_segment_conditions = meter_segment_conditions
+              @unit_label = unit_label
+            end
+          end
+
+          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 is 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
+
+            def self.field_encodings
+              @field_encodings = { up_to_decimal: :decimal_string }
+            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
+
+            def self.field_encodings
+              @field_encodings = { divide_by: :int64_string }
+            end
+          end
+          # 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 Metered Item that this rate binds to. Cannot be set if `metered_item_data` is provided, and must be set if it isn't.
+          attr_accessor :metered_item
+          # The data to create a metered item that binds to this rate. Cannot be set if `metered_item` is provided, and must be set if it isn't.
+          attr_accessor :metered_item_data
+          # Defines whether the tiered price is 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(
+            metadata: nil,
+            metered_item: nil,
+            metered_item_data: nil,
+            tiering_mode: nil,
+            tiers: nil,
+            transform_quantity: nil,
+            unit_amount: nil
+          )
+            @metadata = metadata
+            @metered_item = metered_item
+            @metered_item_data = metered_item_data
+            @tiering_mode = tiering_mode
+            @tiers = tiers
+            @transform_quantity = transform_quantity
+            @unit_amount = unit_amount
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              tiers: {
+                kind: :array,
+                element: { kind: :object, fields: { up_to_decimal: :decimal_string } },
+              },
+              transform_quantity: { kind: :object, fields: { divide_by: :int64_string } },
+            }
+          end
+        end
+
+        class RatesToDelete < ::Stripe::RequestParams
+          # The ID of the RateCard rate to delete.
+          attr_accessor :id
+
+          def initialize(id: nil)
+            @id = id
+          end
+        end
+        # The list of RateCard rates to create or update. Maximum of 100 rates.
+        attr_accessor :rates_to_create
+        # The list of RateCard rates to delete. Maximum of 100 rates.
+        attr_accessor :rates_to_delete
+
+        def initialize(rates_to_create: nil, rates_to_delete: nil)
+          @rates_to_create = rates_to_create
+          @rates_to_delete = rates_to_delete
+        end
+
+        def self.field_encodings
+          @field_encodings = {
+            rates_to_create: {
+              kind: :array,
+              element: {
+                kind: :object,
+                fields: {
+                  tiers: {
+                    kind: :array,
+                    element: { kind: :object, fields: { up_to_decimal: :decimal_string } },
+                  },
+                  transform_quantity: { kind: :object, fields: { divide_by: :int64_string } },
+                },
+              },
+            },
+          }
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionCreateParams < ::Stripe::RequestParams
+        # The ID of the Billing Cadence.
+        attr_accessor :billing_cadence
+        # 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 ID of the Rate Card.
+        attr_accessor :rate_card
+        # The ID of the Rate Card Version. If not specified, defaults to the "live_version" of the Rate Card at the time of creation.
+        attr_accessor :rate_card_version
+
+        def initialize(billing_cadence: nil, metadata: nil, rate_card: nil, rate_card_version: nil)
+          @billing_cadence = billing_cadence
+          @metadata = metadata
+          @rate_card = rate_card
+          @rate_card_version = rate_card_version
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionListParams < ::Stripe::RequestParams
+        class Payer < ::Stripe::RequestParams
+          # The ID of the Customer object. If provided, only the Rate Card Subscriptions that are subscribed on the Billing 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
+        # Optionally filter by a BillingCadence. Mutually exclusive with `payers`, `rate_card`, and `rate_card_version`.
+        attr_accessor :billing_cadence
+        # The page size limit. Defaults to 20.
+        attr_accessor :limit
+        # Optionally filter by the payer associated with Billing Cadences which the Rate Card Subscriptions are subscribed to.
+        # Mutually exclusive with `billing_cadence`, `rate_card`, and `rate_card_version`.
+        attr_accessor :payer
+        # Optionally filter by a RateCard. Mutually exclusive with `billing_cadence`, `payers`, and `rate_card_version`.
+        attr_accessor :rate_card
+        # Optionally filter by a RateCard version. Mutually exclusive with `billing_cadence`, `payers`, and `rate_card`.
+        attr_accessor :rate_card_version
+        # Optionally filter by servicing status.
+        attr_accessor :servicing_status
+
+        def initialize(
+          billing_cadence: nil,
+          limit: nil,
+          payer: nil,
+          rate_card: nil,
+          rate_card_version: nil,
+          servicing_status: nil
+        )
+          @billing_cadence = billing_cadence
+          @limit = limit
+          @payer = payer
+          @rate_card = rate_card
+          @rate_card_version = rate_card_version
+          @servicing_status = servicing_status
+        end
+      end
+    end
+  end
+end

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

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

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

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

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardUpdateParams < ::Stripe::RequestParams
+        # Sets whether the RateCard is active. Inactive RateCards cannot be used in new activations or have new rates added.
+        attr_accessor :active
+        # A customer-facing name for the RateCard.
+        # 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 RateCard activations use. Providing `live_version = "latest"` sets the
+        # RateCard's `live_version` to its latest version.
+        attr_accessor :live_version
+        # An internal key you can use to search for a particular RateCard. 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
+
+        def initialize(
+          active: nil,
+          display_name: nil,
+          live_version: nil,
+          lookup_key: nil,
+          metadata: nil
+        )
+          @active = active
+          @display_name = display_name
+          @live_version = live_version
+          @lookup_key = lookup_key
+          @metadata = metadata
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_cards/custom_pricing_unit_overage_rate_create_params.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class CustomPricingUnitOverageRateCreateParams < ::Stripe::RequestParams
+          # The ID of the custom pricing unit this overage rate applies to.
+          attr_accessor :custom_pricing_unit
+          # 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 ID of the one-time item to use for overage line items.
+          attr_accessor :one_time_item
+          # The per-unit amount to charge for overages, represented as a decimal string in minor currency units with at most 12 decimal places.
+          attr_accessor :unit_amount
+
+          def initialize(
+            custom_pricing_unit: nil,
+            metadata: nil,
+            one_time_item: nil,
+            unit_amount: nil
+          )
+            @custom_pricing_unit = custom_pricing_unit
+            @metadata = metadata
+            @one_time_item = one_time_item
+            @unit_amount = unit_amount
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_cards/custom_pricing_unit_overage_rate_delete_params.rb

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

data/lib/stripe/params/v2/billing/rate_cards/custom_pricing_unit_overage_rate_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class CustomPricingUnitOverageRateListParams < ::Stripe::RequestParams
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+          # Optionally filter by a RateCard version. If not specified, defaults to the latest version.
+          attr_accessor :rate_card_version
+
+          def initialize(limit: nil, rate_card_version: nil)
+            @limit = limit
+            @rate_card_version = rate_card_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_cards/custom_pricing_unit_overage_rate_retrieve_params.rb

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

data/lib/stripe/params/v2/billing/rate_cards/rate_create_params.rb

@@ -0,0 +1,109 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class RateCreateParams < ::Stripe::RequestParams
+          class CustomPricingUnitAmount < ::Stripe::RequestParams
+            # The id of the custom pricing unit.
+            attr_accessor :id
+            # The unit value for the custom pricing unit, as a string.
+            attr_accessor :value
+
+            def initialize(id: nil, value: nil)
+              @id = id
+              @value = value
+            end
+          end
+
+          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 is 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
+
+            def self.field_encodings
+              @field_encodings = { up_to_decimal: :decimal_string }
+            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
+
+            def self.field_encodings
+              @field_encodings = { divide_by: :int64_string }
+            end
+          end
+          # The custom pricing unit that this rate binds to. One of `unit_amount`, `tiers`, or `custom_pricing_unit_amount` is required.
+          attr_accessor :custom_pricing_unit_amount
+          # 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 Metered Item that this rate binds to.
+          attr_accessor :metered_item
+          # Defines whether the tiered price is 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. One of `unit_amount`, `tiers`, or `custom_pricing_unit_amount` is required.
+          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. One of `unit_amount`, `tiers`, or `custom_pricing_unit_amount` is required.
+          attr_accessor :unit_amount
+
+          def initialize(
+            custom_pricing_unit_amount: nil,
+            metadata: nil,
+            metered_item: nil,
+            tiering_mode: nil,
+            tiers: nil,
+            transform_quantity: nil,
+            unit_amount: nil
+          )
+            @custom_pricing_unit_amount = custom_pricing_unit_amount
+            @metadata = metadata
+            @metered_item = metered_item
+            @tiering_mode = tiering_mode
+            @tiers = tiers
+            @transform_quantity = transform_quantity
+            @unit_amount = unit_amount
+          end
+
+          def self.field_encodings
+            @field_encodings = {
+              tiers: {
+                kind: :array,
+                element: { kind: :object, fields: { up_to_decimal: :decimal_string } },
+              },
+              transform_quantity: { kind: :object, fields: { divide_by: :int64_string } },
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_cards/rate_delete_params.rb

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

data/lib/stripe/params/v2/billing/rate_cards/rate_list_params.rb

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class RateListParams < ::Stripe::RequestParams
+          # Optionally set the maximum number of results per page. Defaults to 20.
+          attr_accessor :limit
+          # Optionally filter by a Metered Item.
+          attr_accessor :metered_item
+          # Optionally filter by a RateCard version. If not specified, defaults to the latest version.
+          attr_accessor :rate_card_version
+
+          def initialize(limit: nil, metered_item: nil, rate_card_version: nil)
+            @limit = limit
+            @metered_item = metered_item
+            @rate_card_version = rate_card_version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/rate_cards/rate_retrieve_params.rb

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