stripe 5.55.0 → 18.2.0.pre.beta.1

data/lib/stripe/params/billing/alert_list_params.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertListParams < ::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
+  end
+end

data/lib/stripe/params/billing/alert_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/analytics/meter_usage_retrieve_params.rb

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    module Analytics
+      class MeterUsageRetrieveParams < ::Stripe::RequestParams
+        class Meter < ::Stripe::RequestParams
+          # Key-value pairs used to filter usage events by meter dimension values. Each value is an array that can include multiple values for the key. If specified, usage is filtered for matching usage events.
+          attr_accessor :dimension_filters
+          # List of meter dimension keys to group by. If specified, usage events will be grouped by the given meter dimension key's values.
+          attr_accessor :dimension_group_by_keys
+          # Meter id to query usage for.
+          attr_accessor :meter
+          # Key-value pairs used to filter usage events by high cardinality tenant dimension values. Each value is an array that can include multiple values for the key. If specified, usage is filtered for matching usage events.
+          attr_accessor :tenant_filters
+
+          def initialize(
+            dimension_filters: nil,
+            dimension_group_by_keys: nil,
+            meter: nil,
+            tenant_filters: nil
+          )
+            @dimension_filters = dimension_filters
+            @dimension_group_by_keys = dimension_group_by_keys
+            @meter = meter
+            @tenant_filters = tenant_filters
+          end
+        end
+        # The customer id to fetch meter usage data for.
+        attr_accessor :customer
+        # The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
+        attr_accessor :ends_at
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.
+        attr_accessor :meters
+        # The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
+        attr_accessor :starts_at
+        # The timezone to use for the start and end times. Defaults to UTC if not specified.
+        attr_accessor :timezone
+        # Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.
+        attr_accessor :value_grouping_window
+
+        def initialize(
+          customer: nil,
+          ends_at: nil,
+          expand: nil,
+          meters: nil,
+          starts_at: nil,
+          timezone: nil,
+          value_grouping_window: nil
+        )
+          @customer = customer
+          @ends_at = ends_at
+          @expand = expand
+          @meters = meters
+          @starts_at = starts_at
+          @timezone = timezone
+          @value_grouping_window = value_grouping_window
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_balance_summary_retrieve_params.rb

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceSummaryRetrieveParams < ::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 whose credit balance summary you're retrieving.
+      attr_accessor :customer
+      # The account representing the customer whose credit balance summary you're retrieving.
+      attr_accessor :customer_account
+      # 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, customer_account: nil, expand: nil, filter: nil)
+        @customer = customer
+        @customer_account = customer_account
+        @expand = expand
+        @filter = filter
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_balance_transaction_list_params.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceTransactionListParams < ::Stripe::RequestParams
+      # The credit grant for which to fetch credit balance transactions.
+      attr_accessor :credit_grant
+      # The customer whose credit balance transactions you're retrieving.
+      attr_accessor :customer
+      # The account representing the customer whose credit balance transactions you're retrieving.
+      attr_accessor :customer_account
+      # 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,
+        customer_account: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil
+      )
+        @credit_grant = credit_grant
+        @customer = customer
+        @customer_account = customer_account
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_balance_transaction_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceTransactionRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_grant_create_params.rb

@@ -0,0 +1,107 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantCreateParams < ::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
+        # 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. It defaults to `paid` if not specified.
+      attr_accessor :category
+      # ID of the customer receiving the billing credits.
+      attr_accessor :customer
+      # ID of the account representing the customer receiving the billing credits.
+      attr_accessor :customer_account
+      # 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,
+        customer_account: 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
+        @customer_account = customer_account
+        @effective_at = effective_at
+        @expand = expand
+        @expires_at = expires_at
+        @metadata = metadata
+        @name = name
+        @priority = priority
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_grant_expire_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantExpireParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_grant_list_params.rb

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantListParams < ::Stripe::RequestParams
+      # Only return credit grants for this customer.
+      attr_accessor :customer
+      # Only return credit grants for this account representing the customer.
+      attr_accessor :customer_account
+      # 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,
+        customer_account: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil
+      )
+        @customer = customer
+        @customer_account = customer_account
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_grant_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantRetrieveParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/credit_grant_update_params.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantUpdateParams < ::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
+  end
+end

data/lib/stripe/params/billing/credit_grant_void_grant_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditGrantVoidGrantParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/meter_create_params.rb

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterCreateParams < ::Stripe::RequestParams
+      class CustomerMapping < ::Stripe::RequestParams
+        # The key in the meter event payload to use for mapping the event to a customer.
+        attr_accessor :event_payload_key
+        # The method for mapping a meter event to a customer. Must be `by_id`.
+        attr_accessor :type
+
+        def initialize(event_payload_key: nil, type: nil)
+          @event_payload_key = event_payload_key
+          @type = type
+        end
+      end
+
+      class DefaultAggregation < ::Stripe::RequestParams
+        # Specifies how events are aggregated. Allowed values are `count` to count the number of events, `sum` to sum each event's value and `last` to take the last event's value in the window.
+        attr_accessor :formula
+
+        def initialize(formula: nil)
+          @formula = formula
+        end
+      end
+
+      class ValueSettings < ::Stripe::RequestParams
+        # The key in the usage event payload to use as the value for this meter. For example, if the event payload contains usage on a `bytes_used` field, then set the event_payload_key to "bytes_used".
+        attr_accessor :event_payload_key
+
+        def initialize(event_payload_key: nil)
+          @event_payload_key = event_payload_key
+        end
+      end
+      # Fields that specify how to map a meter event to a customer.
+      attr_accessor :customer_mapping
+      # The default settings to aggregate a meter's events with.
+      attr_accessor :default_aggregation
+      # The meter’s name. Not visible to the customer.
+      attr_accessor :display_name
+      # The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
+      attr_accessor :event_name
+      # The time window which meter events have been pre-aggregated for, if any.
+      attr_accessor :event_time_window
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Fields that specify how to calculate a meter event's value.
+      attr_accessor :value_settings
+
+      def initialize(
+        customer_mapping: nil,
+        default_aggregation: nil,
+        display_name: nil,
+        event_name: nil,
+        event_time_window: nil,
+        expand: nil,
+        value_settings: nil
+      )
+        @customer_mapping = customer_mapping
+        @default_aggregation = default_aggregation
+        @display_name = display_name
+        @event_name = event_name
+        @event_time_window = event_time_window
+        @expand = expand
+        @value_settings = value_settings
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/meter_deactivate_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterDeactivateParams < ::Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/billing/meter_event_adjustment_create_params.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventAdjustmentCreateParams < ::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
+  end
+end

data/lib/stripe/params/billing/meter_event_create_params.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventCreateParams < ::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/meters/configure#meter-configuration-attributes).
+      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
+  end
+end

data/lib/stripe/params/billing/meter_event_summary_list_params.rb

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterEventSummaryListParams < ::Stripe::RequestParams
+      # The customer for which to fetch event summaries.
+      attr_accessor :customer
+      # The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
+      attr_accessor :end_time
+      # 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
+      # The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
+      attr_accessor :start_time
+      # 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
+      # Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. For hourly granularity, start and end times must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). For daily granularity, start and end times must align with UTC day boundaries (00:00 UTC).
+      attr_accessor :value_grouping_window
+
+      def initialize(
+        customer: nil,
+        end_time: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        start_time: nil,
+        starting_after: nil,
+        value_grouping_window: nil
+      )
+        @customer = customer
+        @end_time = end_time
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @start_time = start_time
+        @starting_after = starting_after
+        @value_grouping_window = value_grouping_window
+      end
+    end
+  end
+end