stripe 17.2.0.pre.beta.1 → 17.3.0.pre.alpha.1

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

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      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
+        # 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
+        # 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
+
+        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,61 @@
+# 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
+
+        # 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 this rate card's most recently created version.
+        attr_reader :latest_version
+        # The ID of the Rate Card Version that will be used by all subscriptions when no specific version is specified.
+        attr_reader :live_version
+        # 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 interval for assessing service. For example, a monthly Rate Card with a rate of $1 for the first 10 "workloads"
+        # and $2 thereafter means "$1 per workload up to 10 workloads during a month of service." This is similar to but
+        # distinct from billing interval; the service interval deals with the rate at which the customer accumulates fees,
+        # while the billing interval in Cadence deals with the rate the customer is billed.
+        attr_reader :service_interval
+        # The length of the interval for assessing service. For example, set this to 3 and `service_interval` to `"month"` in
+        # order to specify quarterly service.
+        attr_reader :service_interval_count
+        # The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of tax.
+        attr_reader :tax_behavior
+        # 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
+
+        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,110 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      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 will be 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
+        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
+        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
+        # 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 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_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
+        # 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
+
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      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
+        # 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
+        # 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
+
+        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,34 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      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
+        # 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
+        # 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
+
+        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/service_action.rb

@@ -0,0 +1,244 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class ServiceAction < APIResource
+        OBJECT_NAME = "v2.billing.service_action"
+        def self.object_name
+          "v2.billing.service_action"
+        end
+
+        class CreditGrant < ::Stripe::StripeObject
+          class Amount < ::Stripe::StripeObject
+            class CustomPricingUnit < ::Stripe::StripeObject
+              # The Custom Pricing Unit object.
+              attr_reader :custom_pricing_unit_details
+              # The id of the custom pricing unit.
+              attr_reader :id
+              # The value of the credit grant, decimal value represented as a string.
+              attr_reader :value
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The type of the credit grant amount. We currently support `monetary` and `custom_pricing_unit` billing credits.
+            attr_reader :type
+            # The custom pricing unit amount of the credit grant. Required if `type` is `custom_pricing_unit`.
+            attr_reader :custom_pricing_unit
+            # The monetary amount of the credit grant. Required if `type` is `monetary`.
+            attr_reader :monetary
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit: CustomPricingUnit }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ApplicabilityConfig < ::Stripe::StripeObject
+            class Scope < ::Stripe::StripeObject
+              # The billable items to apply the credit grant to.
+              attr_reader :billable_items
+              # The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billable_items`.
+              attr_reader :price_type
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The applicability scope of the credit grant.
+            attr_reader :scope
+
+            def self.inner_class_types
+              @inner_class_types = { scope: Scope }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ExpiryConfig < ::Stripe::StripeObject
+            # The type of the expiry configuration. We currently support `end_of_service_period`.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The amount of the credit grant.
+          attr_reader :amount
+          # Defines the scope where the credit grant is applicable.
+          attr_reader :applicability_config
+          # The category of the credit grant.
+          attr_reader :category
+          # The expiry configuration for the credit grant.
+          attr_reader :expiry_config
+          # A descriptive name shown in dashboard.
+          attr_reader :name
+          # The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
+          attr_reader :priority
+
+          def self.inner_class_types
+            @inner_class_types = {
+              amount: Amount,
+              applicability_config: ApplicabilityConfig,
+              expiry_config: ExpiryConfig,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class CreditGrantPerTenant < ::Stripe::StripeObject
+          class Amount < ::Stripe::StripeObject
+            class CustomPricingUnit < ::Stripe::StripeObject
+              # The Custom Pricing Unit object.
+              attr_reader :custom_pricing_unit_details
+              # The id of the custom pricing unit.
+              attr_reader :id
+              # The value of the credit grant, decimal value represented as a string.
+              attr_reader :value
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The type of the credit grant amount. We currently support `monetary` and `custom_pricing_unit` billing credits.
+            attr_reader :type
+            # The custom pricing unit amount of the credit grant. Required if `type` is `custom_pricing_unit`.
+            attr_reader :custom_pricing_unit
+            # The monetary amount of the credit grant. Required if `type` is `monetary`.
+            attr_reader :monetary
+
+            def self.inner_class_types
+              @inner_class_types = { custom_pricing_unit: CustomPricingUnit }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ApplicabilityConfig < ::Stripe::StripeObject
+            class Scope < ::Stripe::StripeObject
+              # The billable items to apply the credit grant to.
+              attr_reader :billable_items
+              # The price type that credit grants can apply to. We currently only support the `metered` price type. This will apply to metered prices and rate cards. Cannot be used in combination with `billable_items`.
+              attr_reader :price_type
+
+              def self.inner_class_types
+                @inner_class_types = {}
+              end
+
+              def self.field_remappings
+                @field_remappings = {}
+              end
+            end
+            # The applicability scope of the credit grant.
+            attr_reader :scope
+
+            def self.inner_class_types
+              @inner_class_types = { scope: Scope }
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class ExpiryConfig < ::Stripe::StripeObject
+            # The type of the expiry configuration. We currently support `end_of_service_period`.
+            attr_reader :type
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The amount of the credit grant.
+          attr_reader :amount
+          # Defines the scope where the credit grant is applicable.
+          attr_reader :applicability_config
+          # The category of the credit grant.
+          attr_reader :category
+          # The expiry configuration for the credit grant.
+          attr_reader :expiry_config
+          # Customer-facing name for the credit grant.
+          attr_reader :name
+          # The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
+          attr_reader :priority
+
+          def self.inner_class_types
+            @inner_class_types = {
+              amount: Amount,
+              applicability_config: ApplicabilityConfig,
+              expiry_config: ExpiryConfig,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Timestamp of when the object was created.
+        attr_reader :created
+        # Unique identifier for the object.
+        attr_reader :id
+        # An internal key you can use to search for this service action.
+        attr_reader :lookup_key
+        # String representing the object's type. Objects of the same type share the same value of the object field.
+        attr_reader :object
+        # The interval for assessing service.
+        attr_reader :service_interval
+        # The length of the interval for assessing service.
+        attr_reader :service_interval_count
+        # The type of the service action.
+        attr_reader :type
+        # 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
+        # Details for the credit grant. Provided only if `type` is "credit_grant".
+        attr_reader :credit_grant
+        # Details for the credit grant per tenant. Provided only if `type` is "credit_grant_per_tenant".
+        attr_reader :credit_grant_per_tenant
+
+        def self.inner_class_types
+          @inner_class_types = {
+            credit_grant: CreditGrant,
+            credit_grant_per_tenant: CreditGrantPerTenant,
+          }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+    end
+  end
+end