stripe 19.2.0 → 19.3.0.pre.alpha.2

data/lib/stripe/resources/v2/billing/pricing_plan_version.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Pricing Plan Version represents a specific configuration of a Pricing Plan at a point in time. Versions are created
+      # automatically when you update a Pricing Plan, allowing you to track changes and manage which version is active for new
+      # subscriptions. Each version has a start date and optionally an end date if it has been superseded.
+      class PricingPlanVersion < APIResource
+        OBJECT_NAME = "v2.billing.pricing_plan_version"
+        def self.object_name
+          "v2.billing.pricing_plan_version"
+        end
+
+        # Time at which the object was created.
+        attr_reader :created
+        # The timestamp when this version became inactive. null if it's the latest version.
+        attr_reader :end_date
+        # Unique identifier for the object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The ID of the PricingPlan this version belongs to.
+        attr_reader :pricing_plan
+        # The timestamp when this version became active.
+        attr_reader :start_date
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/profile.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Billing Profile is a representation of how a bill is paid, separating payment behavior from customer identity.
+      class Profile < APIResource
+        OBJECT_NAME = "v2.billing.profile"
+        def self.object_name
+          "v2.billing.profile"
+        end
+
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # The ID of the customer object.
+        attr_reader :customer
+        # The ID of the payment method object.
+        attr_reader :default_payment_method
+        # A customer-facing name for the billing profile.
+        # Maximum length of 250 characters.
+        attr_reader :display_name
+        # The ID of the billing profile object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # An internal key you can use to search for a particular billing profile.
+        # Maximum length of 200 characters.
+        attr_reader :lookup_key
+        # 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_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The current status of the billing profile.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/rate_card.rb

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Rate Card represents a versioned set of usage-based prices (rates). Each rate is associated with one Metered Item and
+      # defines how much to charge for usage of that item. After you've set up a RateCard, you can subscribe customers to it
+      # by creating a Rate Card Subscription.
+      class RateCard < APIResource
+        OBJECT_NAME = "v2.billing.rate_card"
+        def self.object_name
+          "v2.billing.rate_card"
+        end
+
+        class ServiceCycle < ::Stripe::StripeObject
+          # The interval for assessing service.
+          attr_reader :interval
+          # The length of the interval for assessing service. For example, set this to 3 and `interval` to `"month"`
+          # to specify quarterly service.
+          attr_reader :interval_count
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Whether this RateCard is active. Inactive RateCards cannot be used in new activations or have new rates added.
+        attr_reader :active
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Three-letter ISO currency code, in lowercase. Must be a supported currency.
+        attr_reader :currency
+        # A customer-facing name for the Rate Card.
+        # 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_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # The ID of the Rate Card Version used by all subscriptions when no specific version is specified.
+        attr_reader :live_version
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # An internal key you can use to search for a particular RateCard. Maximum length of 200 characters.
+        attr_reader :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_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The service cycle configuration for this Rate Card. For example, a monthly Rate Card 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_reader :service_cycle
+        # The tax behavior for Stripe Tax — whether the rate card price includes or excludes tax.
+        attr_reader :tax_behavior
+
+        def self.inner_class_types
+          @inner_class_types = { service_cycle: ServiceCycle }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/rate_card_custom_pricing_unit_overage_rate.rb

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A rate card custom pricing unit overage rate defines the conversion rate from a custom pricing unit
+      # to fiat currency when credits are exhausted. This enables automatic overage charges
+      # at a configurable per-unit rate.
+      class RateCardCustomPricingUnitOverageRate < APIResource
+        OBJECT_NAME = "v2.billing.rate_card_custom_pricing_unit_overage_rate"
+        def self.object_name
+          "v2.billing.rate_card_custom_pricing_unit_overage_rate"
+        end
+
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # The ID of the custom pricing unit this overage rate applies to.
+        attr_reader :custom_pricing_unit
+        # Unique identifier for the object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # 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_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # A one-time item represents a product that can be charged as a one-time line item,
+        # used for overage charges when custom pricing unit credits are exhausted.
+        attr_reader :one_time_item
+        # The ID of the Rate Card this overage rate belongs to.
+        attr_reader :rate_card
+        # The ID of the Rate Card Version this overage rate was created on.
+        attr_reader :rate_card_version
+        # The per-unit amount to charge for overages, represented as a decimal string in minor currency units with at most 12 decimal places.
+        attr_reader :unit_amount
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/rate_card_rate.rb

@@ -0,0 +1,131 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Rate Card Rate represents a single usage-based price within a Rate Card. Each rate binds to one Metered Item and
+      # defines the pricing structure for that item, including either a flat unit amount or tiered pricing. Rates support
+      # features like graduated or volume-based tiering, quantity transformations, and custom pricing units.
+      class RateCardRate < APIResource
+        OBJECT_NAME = "v2.billing.rate_card_rate"
+        def self.object_name
+          "v2.billing.rate_card_rate"
+        end
+
+        class CustomPricingUnitAmount < ::Stripe::StripeObject
+          # The Custom Pricing Unit object.
+          attr_reader :custom_pricing_unit_details
+          # The id of the custom pricing unit.
+          attr_reader :id
+          # The unit value for the custom pricing unit, as a string.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class Tier < ::Stripe::StripeObject
+          # Price for the entire tier, represented as a decimal string in minor currency units with at most 12 decimal places.
+          attr_reader :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_reader :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_reader :up_to_decimal
+          # No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+          attr_reader :up_to_inf
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { up_to_decimal: :decimal_string }
+          end
+        end
+
+        class TransformQuantity < ::Stripe::StripeObject
+          # Divide usage by this number.
+          attr_reader :divide_by
+          # After division, round the result up or down.
+          attr_reader :round
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+
+          def self.field_encodings
+            @field_encodings = { divide_by: :int64_string }
+          end
+        end
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # The custom pricing unit that this rate binds to.
+        attr_reader :custom_pricing_unit_amount
+        # Unique identifier for the object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # 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_reader :metadata
+        # A Metered Item represents a billable item whose pricing is based on usage, measured by a meter. You can use rate cards
+        # to specify the pricing and create subscriptions to these items.
+        attr_reader :metered_item
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The ID of the Rate Card it belongs to.
+        attr_reader :rate_card
+        # The ID of the Rate Card Version it was created on.
+        attr_reader :rate_card_version
+        # Defines whether the tiering 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_reader :tiering_mode
+        # Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+        attr_reader :tiers
+        # Apply a transformation to the reported usage or set quantity before computing the amount billed.
+        attr_reader :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_reader :unit_amount
+
+        def self.inner_class_types
+          @inner_class_types = {
+            custom_pricing_unit_amount: CustomPricingUnitAmount,
+            tiers: Tier,
+            transform_quantity: TransformQuantity,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        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

data/lib/stripe/resources/v2/billing/rate_card_subscription.rb

@@ -0,0 +1,97 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Rate Card Subscription represents a customer's subscription to a Rate Card's usage-based pricing. It tracks the
+      # servicing status (whether usage is being measured) and collection status (whether payments are current). Subscriptions
+      # bill according to the service interval defined in the Rate Card and are collected on the associated Billing Cadence.
+      class RateCardSubscription < APIResource
+        OBJECT_NAME = "v2.billing.rate_card_subscription"
+        def self.object_name
+          "v2.billing.rate_card_subscription"
+        end
+
+        class CollectionStatusTransitions < ::Stripe::StripeObject
+          # When the collection status transitioned to awaiting customer action.
+          attr_reader :awaiting_customer_action_at
+          # When the collection status transitioned to current.
+          attr_reader :current_at
+          # When the collection status transitioned to past due.
+          attr_reader :past_due_at
+          # When the collection status transitioned to paused.
+          attr_reader :paused_at
+          # When the collection status transitioned to unpaid.
+          attr_reader :unpaid_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ServicingStatusTransitions < ::Stripe::StripeObject
+          # When the servicing status transitioned to activated.
+          attr_reader :activated_at
+          # When the servicing status transitioned to canceled.
+          attr_reader :canceled_at
+          # When the servicing status transitioned to paused.
+          attr_reader :paused_at
+          # When the servicing is scheduled to transition to activate.
+          attr_reader :will_activate_at
+          # When the servicing is scheduled to cancel.
+          attr_reader :will_cancel_at
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The ID of the Billing Cadence.
+        attr_reader :billing_cadence
+        # The payment status of a Rate Card Subscription.
+        attr_reader :collection_status
+        # The collection status transitions of the Rate Card Subscription.
+        attr_reader :collection_status_transitions
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Unique identifier for the object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # 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_reader :metadata
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The ID of the Rate Card.
+        attr_reader :rate_card
+        # The ID of the Rate Card Version.
+        attr_reader :rate_card_version
+        # The servicing status of a Rate Card Subscription.
+        attr_reader :servicing_status
+        # The servicing status transitions of the Rate Card Subscription.
+        attr_reader :servicing_status_transitions
+        # The ID of the Test Clock, if any.
+        attr_reader :test_clock
+
+        def self.inner_class_types
+          @inner_class_types = {
+            collection_status_transitions: CollectionStatusTransitions,
+            servicing_status_transitions: ServicingStatusTransitions,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/rate_card_version.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Rate Card Version represents a specific configuration of a Rate Card at a point in time. Versions are created automatically
+      # when you add or modify rates on a Rate Card, allowing you to track changes and manage which version is active for new
+      # subscriptions. Each version maintains a record of when it was created.
+      class RateCardVersion < APIResource
+        OBJECT_NAME = "v2.billing.rate_card_version"
+        def self.object_name
+          "v2.billing.rate_card_version"
+        end
+
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Unique identifier for the object.
+        attr_reader :id
+        # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+        attr_reader :livemode
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The ID of the Rate Card that this version belongs to.
+        attr_reader :rate_card_id
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end