stripe 15.5.0 → 15.6.0.pre.alpha.2

data/lib/stripe/services/v2/billing/rate_card_service.rb

@@ -0,0 +1,151 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardService < StripeService
+        attr_reader :rates, :versions
+
+        def initialize(requestor)
+          super
+          @rates = Stripe::V2::Billing::RateCards::RateService.new(@requestor)
+          @versions = Stripe::V2::Billing::RateCards::VersionService.new(@requestor)
+        end
+
+        class ListParams < 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
+
+        class CreateParams < 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 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_accessor :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_accessor :service_interval_count
+          # The Stripe Tax tax behavior - whether the rates are inclusive or exclusive of 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
+
+        class RetrieveParams < Stripe::RequestParams; end
+
+        class UpdateParams < 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 will use. Providing `live_version = "latest"` will set 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
+
+        # Create a Rate Card object.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/rate_cards",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List all Rate Card objects.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/rate_cards",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve the latest version of a Rate Card object.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/rate_cards/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update a Rate Card object.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/rate_cards/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/rate_card_subscription_service.rb

@@ -0,0 +1,144 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class RateCardSubscriptionService < StripeService
+        class ListParams < 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, if not provided the default is 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
+
+        class CreateParams < 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
+
+        class RetrieveParams < Stripe::RequestParams; end
+
+        class UpdateParams < 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
+
+        class CancelParams < Stripe::RequestParams; end
+
+        # Cancel an existing, active Rate Card Subscription.
+        def cancel(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/rate_card_subscriptions/%<id>s/cancel", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Create a Rate Card Subscription to bill a Rate Card on a specified Billing Cadence.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/rate_card_subscriptions",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # List all Rate Card Subscription objects.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/billing/rate_card_subscriptions",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieve a Rate Card Subscription by ID.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/billing/rate_card_subscriptions/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update fields on an existing, active Rate Card Subscription.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/billing/rate_card_subscriptions/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/rate_cards/rate_service.rb

@@ -0,0 +1,161 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class RateService < StripeService
+          class ListParams < 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
+
+          class CreateParams < 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 will be contained in the tier. Only one of `up_to_decimal` and `up_to_inf` may
+              # be set.
+              attr_accessor :up_to_decimal
+              # No upper bound to this tier. Only one of `up_to_decimal` and `up_to_inf` may be set.
+              attr_accessor :up_to_inf
+
+              def initialize(flat_amount: nil, unit_amount: nil, up_to_decimal: nil, up_to_inf: nil)
+                @flat_amount = flat_amount
+                @unit_amount = unit_amount
+                @up_to_decimal = up_to_decimal
+                @up_to_inf = up_to_inf
+              end
+            end
+
+            class TransformQuantity < Stripe::RequestParams
+              # Divide usage by this number.
+              attr_accessor :divide_by
+              # After division, round the result up or down.
+              attr_accessor :round
+
+              def initialize(divide_by: nil, round: nil)
+                @divide_by = divide_by
+                @round = round
+              end
+            end
+            # The custom pricing unit that this rate binds to.
+            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
+            # The ID of the price object to take price information from. The price must have the same interval as the rate card.
+            # Updates to the Price will not be reflected in the Rate Card or its rates.
+            attr_accessor :price
+            # Defines whether the tiered price should be graduated or volume-based. In volume-based tiering, the maximum
+            # quantity within a period determines the per-unit price. In graduated tiering, the pricing changes as the quantity
+            # grows into new tiers. Can only be set if `tiers` is set.
+            attr_accessor :tiering_mode
+            # Each element represents a pricing tier. Cannot be set if `unit_amount` is provided.
+            attr_accessor :tiers
+            # Apply a transformation to the reported usage or set quantity before computing the amount billed.
+            attr_accessor :transform_quantity
+            # The per-unit amount to be charged, represented as a decimal string in minor currency units with at most 12 decimal
+            # places. Cannot be set if `tiers` is provided.
+            attr_accessor :unit_amount
+
+            def initialize(
+              custom_pricing_unit_amount: nil,
+              metadata: nil,
+              metered_item: nil,
+              price: 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
+              @price = price
+              @tiering_mode = tiering_mode
+              @tiers = tiers
+              @transform_quantity = transform_quantity
+              @unit_amount = unit_amount
+            end
+          end
+
+          class DeleteParams < Stripe::RequestParams; end
+          class RetrieveParams < Stripe::RequestParams; end
+
+          # Set the Rate for a Metered Item on the latest version of a Rate Card object. This will create a new Rate Card version
+          # if the Metered Item already has a rate on the Rate Card.
+          def create(rate_card_id, params = {}, opts = {})
+            request(
+              method: :post,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates", { rate_card_id: CGI.escape(rate_card_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Remove an existing Rate from a Rate Card. This will create a new Rate Card Version without that Rate.
+          def delete(rate_card_id, id, params = {}, opts = {})
+            request(
+              method: :delete,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # List all Rates associated with a Rate Card for a specific version (defaults to latest). Rates remain active for all subsequent versions until a new rate is created for the same Metered Item.
+          def list(rate_card_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates", { rate_card_id: CGI.escape(rate_card_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a Rate object.
+          def retrieve(rate_card_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/rates/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/rate_cards/version_service.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      module RateCards
+        class VersionService < StripeService
+          class ListParams < Stripe::RequestParams
+            # Optionally set the maximum number of results per page. Defaults to 20.
+            attr_accessor :limit
+
+            def initialize(limit: nil)
+              @limit = limit
+            end
+          end
+
+          class RetrieveParams < Stripe::RequestParams; end
+
+          # List the versions of a Rate Card object. Results are sorted in reverse chronological order (most recent first).
+          def list(rate_card_id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/versions", { rate_card_id: CGI.escape(rate_card_id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+
+          # Retrieve a specific version of a Rate Card object.
+          def retrieve(rate_card_id, id, params = {}, opts = {})
+            request(
+              method: :get,
+              path: format("/v2/billing/rate_cards/%<rate_card_id>s/versions/%<id>s", { rate_card_id: CGI.escape(rate_card_id), id: CGI.escape(id) }),
+              params: params,
+              opts: opts,
+              base_address: :api
+            )
+          end
+        end
+      end
+    end
+  end
+end