stripe 13.4.1 → 13.5.0.pre.beta.1

data/lib/stripe/resources/billing/credit_grant.rb

@@ -16,6 +16,226 @@ module Stripe
         "billing.credit_grant"
       end
 
+      class Amount < Stripe::StripeObject
+        class Monetary < Stripe::StripeObject
+          # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+          attr_reader :currency
+          # A positive integer representing the amount.
+          attr_reader :value
+        end
+        # The monetary amount.
+        attr_reader :monetary
+        # The type of this amount. We currently only support `monetary` billing credits.
+        attr_reader :type
+      end
+
+      class ApplicabilityConfig < Stripe::StripeObject
+        class Scope < Stripe::StripeObject
+          class Price < Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+          end
+          # The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
+          attr_reader :price_type
+          # The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
+          attr_reader :prices
+        end
+        # Attribute for field scope
+        attr_reader :scope
+      end
+
+      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.
+            attr_accessor :price_type
+            # A list of prices that the credit grant can apply to. We currently only support the `metered` prices.
+            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.
+        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
+
+        def initialize(
+          amount: nil,
+          applicability_config: nil,
+          category: nil,
+          customer: nil,
+          effective_at: nil,
+          expand: nil,
+          expires_at: nil,
+          metadata: nil,
+          name: 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
+        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
+      # Attribute for field amount
+      attr_reader :amount
+      # Attribute for field applicability_config
+      attr_reader :applicability_config
+      # The category of this credit grant. This is for tracking purposes and isn't displayed to the customer.
+      attr_reader :category
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # ID of the customer receiving the billing credits.
+      attr_reader :customer
+      # The time when the billing credits become effective-when they're eligible for use.
+      attr_reader :effective_at
+      # The time when the billing credits expire. If not present, the billing credits don't expire.
+      attr_reader :expires_at
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
+      # A descriptive name shown in dashboard.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # ID of the test clock this credit grant belongs to.
+      attr_reader :test_clock
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # The time when this credit grant was voided. If not present, the credit grant hasn't been voided.
+      attr_reader :voided_at
+
       # Creates a credit grant.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/billing/meter.rb

@@ -21,6 +21,184 @@ module Stripe
                                     operations: %i[list],
                                     resource_plural: "event_summaries"
 
+      class CustomerMapping < Stripe::StripeObject
+        # The key in the meter event payload to use for mapping the event to a customer.
+        attr_reader :event_payload_key
+        # The method for mapping a meter event to a customer.
+        attr_reader :type
+      end
+
+      class DefaultAggregation < Stripe::StripeObject
+        # Specifies how events are aggregated.
+        attr_reader :formula
+      end
+
+      class StatusTransitions < Stripe::StripeObject
+        # The time the meter was deactivated, if any. Measured in seconds since Unix epoch.
+        attr_reader :deactivated_at
+      end
+
+      class ValueSettings < Stripe::StripeObject
+        # The key in the meter event payload to use as the value for this meter.
+        attr_reader :event_payload_key
+      end
+
+      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.
+        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
+        # Filter results to only include meters with the given status.
+        attr_accessor :status
+
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class CreateParams < 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 and `sum` to sum each event's value.
+          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 to pre-aggregate meter events 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
+
+      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
+        # The meter’s name. Not visible to the customer.
+        attr_accessor :display_name
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(display_name: nil, expand: nil)
+          @display_name = display_name
+          @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
+
+      class ReactivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Attribute for field customer_mapping
+      attr_reader :customer_mapping
+      # Attribute for field default_aggregation
+      attr_reader :default_aggregation
+      # The meter's name.
+      attr_reader :display_name
+      # The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events.
+      attr_reader :event_name
+      # The time window to pre-aggregate meter events for, if any.
+      attr_reader :event_time_window
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The meter's status.
+      attr_reader :status
+      # Attribute for field status_transitions
+      attr_reader :status_transitions
+      # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+      attr_reader :updated
+      # Attribute for field value_settings
+      attr_reader :value_settings
+
       # Creates a billing meter.
       def self.create(params = {}, opts = {})
         request_stripe_object(method: :post, path: "/v1/billing/meters", params: params, opts: opts)

data/lib/stripe/resources/billing/meter_error_report.rb

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterErrorReport < APIResource
+      OBJECT_NAME = "billing.meter_error_report"
+      def self.object_name
+        "billing.meter_error_report"
+      end
+
+      class Reason < Stripe::StripeObject
+        class ErrorType < Stripe::StripeObject
+          class SampleError < Stripe::StripeObject
+            class ApiRequest < Stripe::StripeObject
+              # Unique identifier for the object.
+              attr_reader :id
+              # idempotency_key of the request
+              attr_reader :idempotency_key
+            end
+            # Attribute for field api_request
+            attr_reader :api_request
+            # message of the error
+            attr_reader :error_message
+          end
+          # Attribute for field sample_errors
+          attr_reader :sample_errors
+        end
+        # The number of errors generated
+        attr_reader :error_count
+        # More information about errors
+        attr_reader :error_types
+      end
+
+      class RelatedObject < Stripe::StripeObject
+        # Unique identifier for the object.
+        attr_reader :id
+        # The type of meter error related object. Should be 'meter'
+        attr_reader :object
+        # The url of the meter object
+        attr_reader :url
+      end
+      # Unique identifier for the object.
+      attr_reader :id
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Attribute for field reason
+      attr_reader :reason
+      # The related objects about the error
+      attr_reader :related_object
+      # Summary of invalid events
+      attr_reader :summary
+      # Time when validation ended. Measured in seconds since the Unix epoch
+      attr_reader :validation_end
+      # Time when validation started. Measured in seconds since the Unix epoch
+      attr_reader :validation_start
+    end
+  end
+end

data/lib/stripe/resources/billing/meter_event.rb

@@ -12,6 +12,41 @@ module Stripe
         "billing.meter_event"
       end
 
+      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
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # A unique identifier for the event.
+      attr_reader :identifier
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The payload of the event. This contains 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://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+      attr_reader :payload
+      # The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
+      attr_reader :timestamp
+
       # Creates a billing meter event.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/billing/meter_event_adjustment.rb

@@ -12,6 +12,49 @@ module Stripe
         "billing.meter_event_adjustment"
       end
 
+      class Cancel < Stripe::StripeObject
+        # Unique identifier for the event.
+        attr_reader :identifier
+      end
+
+      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
+      # Specifies which event to cancel.
+      attr_reader :cancel
+      # The name of the meter event. Corresponds with the `event_name` field on a meter.
+      attr_reader :event_name
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The meter event adjustment's status.
+      attr_reader :status
+      # Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+      attr_reader :type
+
       # Creates a billing meter event adjustment.
       def self.create(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/billing/meter_event_summary.rb

@@ -5,11 +5,28 @@ module Stripe
   module Billing
     # A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much
     # usage was accrued by a customer for that period.
+    #
+    # Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.
     class MeterEventSummary < APIResource
       OBJECT_NAME = "billing.meter_event_summary"
       def self.object_name
         "billing.meter_event_summary"
       end
+
+      # Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`.
+      attr_reader :aggregated_value
+      # End timestamp for this event summary (exclusive). Must be aligned with minute boundaries.
+      attr_reader :end_time
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # The meter associated with this event summary.
+      attr_reader :meter
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries.
+      attr_reader :start_time
     end
   end
 end