stripe 13.6.0.pre.beta.1 → 14.0.0

data/rbi/stripe/services/billing/credit_grant_service.rbi

@@ -7,22 +7,22 @@ module Stripe
     class CreditGrantService < StripeService
       class ListParams < Stripe::RequestParams
         # Only return credit grants for this customer.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :ending_before
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         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.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :starting_after
         sig {
-          params(customer: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
+          params(customer: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
          }
         def initialize(
           customer: nil,
@@ -45,13 +45,15 @@ module Stripe
             def initialize(currency: nil, value: nil); end
           end
           # The monetary amount.
-          sig { returns(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary) }
+          sig {
+            returns(T.nilable(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary))
+           }
           attr_accessor :monetary
           # Specify the type of this amount. We currently only support `monetary` billing credits.
           sig { returns(String) }
           attr_accessor :type
           sig {
-            params(monetary: ::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary, type: String).void
+            params(monetary: T.nilable(::Stripe::Billing::CreditGrantService::CreateParams::Amount::Monetary), type: String).void
            }
           def initialize(monetary: nil, type: nil); end
         end
@@ -64,16 +66,16 @@ module Stripe
               sig { params(id: String).void }
               def initialize(id: nil); end
             end
-            # The price type that credit grants can apply to. We currently only support the `metered` price type.
-            sig { returns(String) }
+            # The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
+            sig { returns(T.nilable(String)) }
             attr_accessor :price_type
-            # A list of prices that the credit grant can apply to. We currently only support the `metered` prices.
+            # 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`.
             sig {
-              returns(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price])
+              returns(T.nilable(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price]))
              }
             attr_accessor :prices
             sig {
-              params(price_type: String, prices: T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price]).void
+              params(price_type: T.nilable(String), prices: T.nilable(T::Array[::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig::Scope::Price])).void
              }
             def initialize(price_type: nil, prices: nil); end
           end
@@ -100,25 +102,25 @@ module Stripe
         sig { returns(String) }
         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.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :effective_at
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
         # The time when the billing credits expire. If not specified, the billing credits don't expire.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         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.
-        sig { returns(T::Hash[String, String]) }
+        sig { returns(T.nilable(T::Hash[String, String])) }
         attr_accessor :metadata
         # A descriptive name shown in the Dashboard.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         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.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :priority
         sig {
-          params(amount: ::Stripe::Billing::CreditGrantService::CreateParams::Amount, applicability_config: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig, category: String, customer: String, effective_at: Integer, expand: T::Array[String], expires_at: Integer, metadata: T::Hash[String, String], name: String, priority: Integer).void
+          params(amount: ::Stripe::Billing::CreditGrantService::CreateParams::Amount, applicability_config: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig, category: String, customer: String, effective_at: T.nilable(Integer), expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), metadata: T.nilable(T::Hash[String, String]), name: T.nilable(String), priority: T.nilable(Integer)).void
          }
         def initialize(
           amount: nil,
@@ -135,38 +137,38 @@ module Stripe
       end
       class RetrieveParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(expand: T::Array[String]).void }
+        sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
       class UpdateParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
         # The time when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.
-        sig { returns(T.nilable(Integer)) }
+        sig { returns(T.nilable(T.nilable(T.any(String, Integer)))) }
         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.
-        sig { returns(T::Hash[String, String]) }
+        sig { returns(T.nilable(T::Hash[String, String])) }
         attr_accessor :metadata
         sig {
-          params(expand: T::Array[String], expires_at: T.nilable(Integer), metadata: T::Hash[String, String]).void
+          params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(T.nilable(T.any(String, Integer))), metadata: T.nilable(T::Hash[String, String])).void
          }
         def initialize(expand: nil, expires_at: nil, metadata: nil); end
       end
       class ExpireParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(expand: T::Array[String]).void }
+        sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
       class VoidGrantParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(expand: T::Array[String]).void }
+        sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
       # Creates a credit grant.

data/rbi/stripe/services/billing/meter_event_adjustment_service.rbi

@@ -8,25 +8,27 @@ module Stripe
       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.
-          sig { returns(String) }
+          sig { returns(T.nilable(String)) }
           attr_accessor :identifier
-          sig { params(identifier: String).void }
+          sig { params(identifier: T.nilable(String)).void }
           def initialize(identifier: nil); end
         end
         # Specifies which event to cancel.
-        sig { returns(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel) }
+        sig {
+          returns(T.nilable(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel))
+         }
         attr_accessor :cancel
         # The name of the meter event. Corresponds with the `event_name` field on a meter.
         sig { returns(String) }
         attr_accessor :event_name
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         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.
         sig { returns(String) }
         attr_accessor :type
         sig {
-          params(cancel: ::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel, event_name: String, expand: T::Array[String], type: String).void
+          params(cancel: T.nilable(::Stripe::Billing::MeterEventAdjustmentService::CreateParams::Cancel), event_name: String, expand: T.nilable(T::Array[String]), type: String).void
          }
         def initialize(cancel: nil, event_name: nil, expand: nil, type: nil); end
       end

data/rbi/stripe/services/billing/meter_event_service.rbi

@@ -10,19 +10,19 @@ module Stripe
         sig { returns(String) }
         attr_accessor :event_name
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         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).
         sig { returns(T::Hash[String, String]) }
         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.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :timestamp
         sig {
-          params(event_name: String, expand: T::Array[String], identifier: String, payload: T::Hash[String, String], timestamp: Integer).void
+          params(event_name: String, expand: T.nilable(T::Array[String]), identifier: T.nilable(String), payload: T::Hash[String, String], timestamp: T.nilable(Integer)).void
          }
         def initialize(
           event_name: nil,

data/rbi/stripe/services/billing/meter_event_summary_service.rbi

@@ -13,25 +13,25 @@ module Stripe
         sig { returns(Integer) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :ending_before
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         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.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         attr_accessor :limit
         # The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
         sig { returns(Integer) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         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).
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :value_grouping_window
         sig {
-          params(customer: String, end_time: Integer, ending_before: String, expand: T::Array[String], limit: Integer, start_time: Integer, starting_after: String, value_grouping_window: String).void
+          params(customer: String, end_time: Integer, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), start_time: Integer, starting_after: T.nilable(String), value_grouping_window: T.nilable(String)).void
          }
         def initialize(
           customer: nil,

data/rbi/stripe/services/billing/meter_service.rbi

@@ -8,22 +8,22 @@ module Stripe
       attr_reader :event_summaries
       class ListParams < Stripe::RequestParams
         # 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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :ending_before
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         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.
-        sig { returns(Integer) }
+        sig { returns(T.nilable(Integer)) }
         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.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :starting_after
         # Filter results to only include meters with the given status.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :status
         sig {
-          params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String, status: String).void
+          params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), status: T.nilable(String)).void
          }
         def initialize(
           ending_before: nil,
@@ -45,7 +45,7 @@ module Stripe
           def initialize(event_payload_key: nil, type: nil); end
         end
         class DefaultAggregation < Stripe::RequestParams
-          # Specifies how events are aggregated. Allowed values are `count` to count the number of events and `sum` to sum each event's value.
+          # 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.
           sig { returns(String) }
           attr_accessor :formula
           sig { params(formula: String).void }
@@ -59,7 +59,7 @@ module Stripe
           def initialize(event_payload_key: nil); end
         end
         # Fields that specify how to map a meter event to a customer.
-        sig { returns(::Stripe::Billing::MeterService::CreateParams::CustomerMapping) }
+        sig { returns(T.nilable(::Stripe::Billing::MeterService::CreateParams::CustomerMapping)) }
         attr_accessor :customer_mapping
         # The default settings to aggregate a meter's events with.
         sig { returns(::Stripe::Billing::MeterService::CreateParams::DefaultAggregation) }
@@ -71,16 +71,16 @@ module Stripe
         sig { returns(String) }
         attr_accessor :event_name
         # The time window to pre-aggregate meter events for, if any.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :event_time_window
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
         # Fields that specify how to calculate a meter event's value.
-        sig { returns(::Stripe::Billing::MeterService::CreateParams::ValueSettings) }
+        sig { returns(T.nilable(::Stripe::Billing::MeterService::CreateParams::ValueSettings)) }
         attr_accessor :value_settings
         sig {
-          params(customer_mapping: ::Stripe::Billing::MeterService::CreateParams::CustomerMapping, default_aggregation: ::Stripe::Billing::MeterService::CreateParams::DefaultAggregation, display_name: String, event_name: String, event_time_window: String, expand: T::Array[String], value_settings: ::Stripe::Billing::MeterService::CreateParams::ValueSettings).void
+          params(customer_mapping: T.nilable(::Stripe::Billing::MeterService::CreateParams::CustomerMapping), default_aggregation: ::Stripe::Billing::MeterService::CreateParams::DefaultAggregation, display_name: String, event_name: String, event_time_window: T.nilable(String), expand: T.nilable(T::Array[String]), value_settings: T.nilable(::Stripe::Billing::MeterService::CreateParams::ValueSettings)).void
          }
         def initialize(
           customer_mapping: nil,
@@ -94,33 +94,33 @@ module Stripe
       end
       class RetrieveParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(expand: T::Array[String]).void }
+        sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
       class UpdateParams < Stripe::RequestParams
         # The meter’s name. Not visible to the customer.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :display_name
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(display_name: String, expand: T::Array[String]).void }
+        sig { params(display_name: T.nilable(String), expand: T.nilable(T::Array[String])).void }
         def initialize(display_name: nil, expand: nil); end
       end
       class DeactivateParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(expand: T::Array[String]).void }
+        sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
       class ReactivateParams < Stripe::RequestParams
         # Specifies which fields in the response should be expanded.
-        sig { returns(T::Array[String]) }
+        sig { returns(T.nilable(T::Array[String])) }
         attr_accessor :expand
-        sig { params(expand: T::Array[String]).void }
+        sig { params(expand: T.nilable(T::Array[String])).void }
         def initialize(expand: nil); end
       end
       # Creates a billing meter.