stripe 19.2.0 → 19.3.0.pre.alpha.2

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

@@ -0,0 +1,140 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A License Fee represents a versioned recurring charge for a Licensed Item, typically used for seat-based or quantity-based
+      # pricing. Each License Fee defines the pricing structure (flat unit amount or tiered pricing) and service interval. After
+      # creating a License Fee, you can subscribe customers to it by creating a License Fee Subscription.
+      class LicenseFee < APIResource
+        OBJECT_NAME = "v2.billing.license_fee"
+        def self.object_name
+          "v2.billing.license_fee"
+        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
+
+        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
+        # Whether this License Fee is active. Inactive License Fees cannot be used in new activations or be modified.
+        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 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_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # A Licensed Item represents a billable item whose pricing is based on license fees. You can use license fees
+        # to specify the pricing and create subscriptions to these items.
+        attr_reader :licensed_item
+        # The ID of the License Fee 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 License Fee. 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 License Fee.
+        attr_reader :service_cycle
+        # The tax behavior for Stripe Tax — whether the license fee price includes or excludes tax.
+        attr_reader :tax_behavior
+        # 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 = {
+            service_cycle: ServiceCycle,
+            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/license_fee_version.rb

@@ -0,0 +1,101 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A License Fee Version represents a specific configuration of a License Fee at a point in time. Versions are created
+      # automatically when you update the pricing structure of a License Fee, allowing you to track changes and manage which
+      # version is active for new subscriptions. Each version maintains the pricing details including unit amounts and tiers.
+      class LicenseFeeVersion < APIResource
+        OBJECT_NAME = "v2.billing.license_fee_version"
+        def self.object_name
+          "v2.billing.license_fee_version"
+        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
+        # Unique identifier for the object.
+        attr_reader :id
+        # The ID of the parent License Fee.
+        attr_reader :license_fee_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
+        # 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 = { 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/licensed_item.rb

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Licensed Item represents a billable item whose pricing is based on license fees. You can use license fees
+      # to specify the pricing and create subscriptions to these items.
+      class LicensedItem < APIResource
+        OBJECT_NAME = "v2.billing.licensed_item"
+        def self.object_name
+          "v2.billing.licensed_item"
+        end
+
+        class TaxDetails < ::Stripe::StripeObject
+          # Product tax code (PTC).
+          attr_reader :tax_code
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Description that customers see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_reader :display_name
+        # 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
+        # An internal key you can use to search for a particular licensed item.
+        # 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
+        # Stripe Tax details.
+        attr_reader :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_reader :unit_label
+
+        def self.inner_class_types
+          @inner_class_types = { tax_details: TaxDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # 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.
+      class MeteredItem < APIResource
+        OBJECT_NAME = "v2.billing.metered_item"
+        def self.object_name
+          "v2.billing.metered_item"
+        end
+
+        class MeterSegmentCondition < ::Stripe::StripeObject
+          # A Meter dimension.
+          attr_reader :dimension
+          # To count usage towards this metered item, the dimension must have this value.
+          attr_reader :value
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class TaxDetails < ::Stripe::StripeObject
+          # Product tax code (PTC).
+          attr_reader :tax_code
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Description that customers see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # Optional array of Meter dimensions to group event dimension keys for invoice line items.
+        attr_reader :invoice_presentation_dimensions
+        # 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 metered item.
+        # 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
+        # ID of the Meter that measures usage for this Metered Item.
+        attr_reader :meter
+        # Optional array of Meter segments to filter event dimension keys for billing.
+        attr_reader :meter_segment_conditions
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # Stripe Tax details.
+        attr_reader :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_reader :unit_label
+
+        def self.inner_class_types
+          @inner_class_types = {
+            meter_segment_conditions: MeterSegmentCondition,
+            tax_details: TaxDetails,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # 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.
+      class OneTimeItem < APIResource
+        OBJECT_NAME = "v2.billing.one_time_item"
+        def self.object_name
+          "v2.billing.one_time_item"
+        end
+
+        class TaxDetails < ::Stripe::StripeObject
+          # Product tax code (PTC).
+          attr_reader :tax_code
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Description that customers see in the invoice line item.
+        # Maximum length of 250 characters.
+        attr_reader :display_name
+        # 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
+        # An internal key you can use to search for a particular one-time item.
+        # 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
+        # Stripe Tax details.
+        attr_reader :tax_details
+        # The unit to use when displaying prices for this one-time item. For example, set this field
+        # to "credit" for the display to show "(price) per credit".
+        # Maximum length of 100 characters.
+        attr_reader :unit_label
+
+        def self.inner_class_types
+          @inner_class_types = { tax_details: TaxDetails }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Pricing Plan represents a bundled collection of billing components that define how customers are charged. Each plan
+      # can include multiple components such as Rate Cards for usage-based pricing, License Fees for recurring charges, and Service
+      # Actions for recurring credit grants. After creating a Pricing Plan, you can subscribe customers to it by creating a Pricing Plan Subscription.
+      class PricingPlan < APIResource
+        OBJECT_NAME = "v2.billing.pricing_plan"
+        def self.object_name
+          "v2.billing.pricing_plan"
+        end
+
+        # Whether the PricingPlan is active.
+        attr_reader :active
+        # Time at which the object was created.
+        attr_reader :created
+        # The currency of the PricingPlan.
+        attr_reader :currency
+        # A description of the pricing plan. Maximum length of 500 characters.
+        attr_reader :description
+        # Display name of the PricingPlan.
+        attr_reader :display_name
+        # Unique identifier for the object.
+        attr_reader :id
+        # The ID of the live version of the PricingPlan.
+        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 PricingPlan. 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 tax behavior for Stripe Tax — whether the pricing plan price includes or excludes tax.
+        attr_reader :tax_behavior
+
+        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/pricing_plan_component.rb

@@ -0,0 +1,97 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      # A Pricing Plan Component represents an individual billing element within a Pricing Plan. Components can be Rate Cards
+      # for usage-based charges, License Fees for recurring fixed charges, or Service Actions for recurring credit grants. Each component
+      # is associated with a specific version of the Pricing Plan and defines one aspect of how customers are billed.
+      class PricingPlanComponent < APIResource
+        OBJECT_NAME = "v2.billing.pricing_plan_component"
+        def self.object_name
+          "v2.billing.pricing_plan_component"
+        end
+
+        class LicenseFee < ::Stripe::StripeObject
+          # The ID of the License Fee.
+          attr_reader :id
+          # The ID of the License Fee Version. If not specified, defaults to 'latest'.
+          attr_reader :version
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class RateCard < ::Stripe::StripeObject
+          # The ID of the Rate Card.
+          attr_reader :id
+          # The ID of the Rate Card Version. If not specified, defaults to 'latest'.
+          attr_reader :version
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class ServiceAction < ::Stripe::StripeObject
+          # The ID of the service action.
+          attr_reader :id
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time at which the object was created.
+        attr_reader :created
+        # Unique identifier for the object.
+        attr_reader :id
+        # Details if this component is a License Fee.
+        attr_reader :license_fee
+        # 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 PricingPlanComponent.
+        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 ID of the Pricing Plan this component belongs to.
+        attr_reader :pricing_plan
+        # The ID of the Pricing Plan Version this component belongs to.
+        attr_reader :pricing_plan_version
+        # Details if this component is a Rate Card.
+        attr_reader :rate_card
+        # Details if this component is a Service Action.
+        attr_reader :service_action
+        # The type of the PricingPlanComponent.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {
+            license_fee: LicenseFee,
+            rate_card: RateCard,
+            service_action: ServiceAction,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end