stripe 12.5.0 → 15.0.0

data/lib/stripe/services/billing/alert_service.rb

@@ -0,0 +1,187 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertService < StripeService
+      class ListParams < Stripe::RequestParams
+        # Filter results to only include this type of alert.
+        attr_accessor :alert_type
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # Filter results to only include alerts with the given meter.
+        attr_accessor :meter
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          alert_type: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          meter: nil,
+          starting_after: nil
+        )
+          @alert_type = alert_type
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @meter = meter
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class UsageThreshold < Stripe::RequestParams
+          class Filter < Stripe::RequestParams
+            # Limit the scope to this usage alert only to this customer.
+            attr_accessor :customer
+            # What type of filter is being applied to this usage alert.
+            attr_accessor :type
+
+            def initialize(customer: nil, type: nil)
+              @customer = customer
+              @type = type
+            end
+          end
+          # The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
+          attr_accessor :filters
+          # Defines at which value the alert will fire.
+          attr_accessor :gte
+          # The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
+          attr_accessor :meter
+          # Whether the alert should only fire only once, or once per billing cycle.
+          attr_accessor :recurrence
+
+          def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil)
+            @filters = filters
+            @gte = gte
+            @meter = meter
+            @recurrence = recurrence
+          end
+        end
+        # The type of alert to create.
+        attr_accessor :alert_type
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The title of the alert.
+        attr_accessor :title
+        # The configuration of the usage threshold.
+        attr_accessor :usage_threshold
+
+        def initialize(alert_type: nil, expand: nil, title: nil, usage_threshold: nil)
+          @alert_type = alert_type
+          @expand = expand
+          @title = title
+          @usage_threshold = usage_threshold
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ActivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ArchiveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class DeactivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Reactivates this alert, allowing it to trigger again.
+      def activate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def archive(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a billing alert
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/alerts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def deactivate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists billing active and inactive alerts
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/alerts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a billing alert given an ID
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/alerts/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_balance_summary_service.rb

@@ -0,0 +1,67 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceSummaryService < StripeService
+      class RetrieveParams < Stripe::RequestParams
+        class Filter < Stripe::RequestParams
+          class ApplicabilityScope < Stripe::RequestParams
+            class Price < Stripe::RequestParams
+              # The price ID this credit grant should apply to.
+              attr_accessor :id
+
+              def initialize(id: nil)
+                @id = id
+              end
+            end
+            # The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
+            attr_accessor :price_type
+            # A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
+            attr_accessor :prices
+
+            def initialize(price_type: nil, prices: nil)
+              @price_type = price_type
+              @prices = prices
+            end
+          end
+          # The billing credit applicability scope for which to fetch credit balance summary.
+          attr_accessor :applicability_scope
+          # The credit grant for which to fetch credit balance summary.
+          attr_accessor :credit_grant
+          # Specify the type of this filter.
+          attr_accessor :type
+
+          def initialize(applicability_scope: nil, credit_grant: nil, type: nil)
+            @applicability_scope = applicability_scope
+            @credit_grant = credit_grant
+            @type = type
+          end
+        end
+        # The customer for which to fetch credit balance summary.
+        attr_accessor :customer
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The filter criteria for the credit balance summary.
+        attr_accessor :filter
+
+        def initialize(customer: nil, expand: nil, filter: nil)
+          @customer = customer
+          @expand = expand
+          @filter = filter
+        end
+      end
+
+      # Retrieves the credit balance summary for a customer.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_balance_summary",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_balance_transaction_service.rb

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceTransactionService < StripeService
+      class ListParams < Stripe::RequestParams
+        # The credit grant for which to fetch credit balance transactions.
+        attr_accessor :credit_grant
+        # The customer for which to fetch credit balance transactions.
+        attr_accessor :customer
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          credit_grant: nil,
+          customer: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @credit_grant = credit_grant
+          @customer = customer
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Retrieve a list of credit balance transactions.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_balance_transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a credit balance transaction.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/credit_balance_transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_grant_service.rb

@@ -0,0 +1,240 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantService < StripeService
+      class ListParams < Stripe::RequestParams
+        # Only return credit grants for this customer.
+        attr_accessor :customer
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+
+        def initialize(
+          customer: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @customer = customer
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class CreateParams < Stripe::RequestParams
+        class Amount < Stripe::RequestParams
+          class Monetary < Stripe::RequestParams
+            # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
+            attr_accessor :currency
+            # A positive integer representing the amount of the credit grant.
+            attr_accessor :value
+
+            def initialize(currency: nil, value: nil)
+              @currency = currency
+              @value = value
+            end
+          end
+          # The monetary amount.
+          attr_accessor :monetary
+          # Specify the type of this amount. We currently only support `monetary` billing credits.
+          attr_accessor :type
+
+          def initialize(monetary: nil, type: nil)
+            @monetary = monetary
+            @type = type
+          end
+        end
+
+        class ApplicabilityConfig < Stripe::RequestParams
+          class Scope < Stripe::RequestParams
+            class Price < Stripe::RequestParams
+              # The price ID this credit grant should apply to.
+              attr_accessor :id
+
+              def initialize(id: nil)
+                @id = id
+              end
+            end
+            # The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
+            attr_accessor :price_type
+            # A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
+            attr_accessor :prices
+
+            def initialize(price_type: nil, prices: nil)
+              @price_type = price_type
+              @prices = prices
+            end
+          end
+          # Specify the scope of this applicability config.
+          attr_accessor :scope
+
+          def initialize(scope: nil)
+            @scope = scope
+          end
+        end
+        # Amount of this credit grant.
+        attr_accessor :amount
+        # Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
+        attr_accessor :applicability_config
+        # The category of this credit grant.
+        attr_accessor :category
+        # ID of the customer to receive the billing credits.
+        attr_accessor :customer
+        # The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
+        attr_accessor :effective_at
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The time when the billing credits expire. If not specified, the billing credits don't expire.
+        attr_accessor :expires_at
+        # Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
+        attr_accessor :metadata
+        # A descriptive name shown in the Dashboard.
+        attr_accessor :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_accessor :priority
+
+        def initialize(
+          amount: nil,
+          applicability_config: nil,
+          category: nil,
+          customer: nil,
+          effective_at: nil,
+          expand: nil,
+          expires_at: nil,
+          metadata: nil,
+          name: nil,
+          priority: nil
+        )
+          @amount = amount
+          @applicability_config = applicability_config
+          @category = category
+          @customer = customer
+          @effective_at = effective_at
+          @expand = expand
+          @expires_at = expires_at
+          @metadata = metadata
+          @name = name
+          @priority = priority
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class UpdateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.
+        attr_accessor :expires_at
+        # Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
+        attr_accessor :metadata
+
+        def initialize(expand: nil, expires_at: nil, metadata: nil)
+          @expand = expand
+          @expires_at = expires_at
+          @metadata = metadata
+        end
+      end
+
+      class ExpireParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class VoidGrantParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Creates a credit grant.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Expires a credit grant.
+      def expire(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/expire", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of credit grants.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_grants",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a credit grant.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a credit grant.
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Voids a credit grant.
+      def void_grant(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/credit_grants/%<id>s/void", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/meter_event_adjustment_service.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventAdjustmentService < StripeService
+      class CreateParams < Stripe::RequestParams
+        class Cancel < Stripe::RequestParams
+          # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+          attr_accessor :identifier
+
+          def initialize(identifier: nil)
+            @identifier = identifier
+          end
+        end
+        # Specifies which event to cancel.
+        attr_accessor :cancel
+        # The name of the meter event. Corresponds with the `event_name` field on a meter.
+        attr_accessor :event_name
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+        attr_accessor :type
+
+        def initialize(cancel: nil, event_name: nil, expand: nil, type: nil)
+          @cancel = cancel
+          @event_name = event_name
+          @expand = expand
+          @type = type
+        end
+      end
+
+      # Creates a billing meter event adjustment.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/meter_event_adjustments",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/meter_event_service.rb

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventService < StripeService
+      class CreateParams < Stripe::RequestParams
+        # The name of the meter event. Corresponds with the `event_name` field on a meter.
+        attr_accessor :event_name
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations.
+        attr_accessor :identifier
+        # The payload of the event. This must contain the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+        attr_accessor :payload
+        # The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified.
+        attr_accessor :timestamp
+
+        def initialize(event_name: nil, expand: nil, identifier: nil, payload: nil, timestamp: nil)
+          @event_name = event_name
+          @expand = expand
+          @identifier = identifier
+          @payload = payload
+          @timestamp = timestamp
+        end
+      end
+
+      # Creates a billing meter event.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/meter_events",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end