orb-billing 1.15.0 → 1.17.0

data/rbi/orb/models/credit_block_retrieve_response.rbi

@@ -18,7 +18,8 @@ module Orb
       attr_accessor :balance
 
       # How this credit block was created: `allocation` (a subscription's recurring
-      # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+      # credit allocation), `top_up` (an automatic balance-threshold top-up),
+      # `commitment` (a subscription commitment true-up rolled forward as credit), or
       # `manual` (a manual credit ledger increment, including credits voided or expired
       # off another block).
       sig do
@@ -76,6 +77,25 @@ module Orb
       end
       attr_writer :credit_allocation
 
+      # The subscription commitment whose true-up rolled forward into this credit block.
+      # Present only when `credit_block_source` is `commitment`.
+      sig do
+        returns(
+          T.nilable(Orb::Models::CreditBlockRetrieveResponse::CreditCommitment)
+        )
+      end
+      attr_reader :credit_commitment
+
+      sig do
+        params(
+          credit_commitment:
+            T.nilable(
+              Orb::Models::CreditBlockRetrieveResponse::CreditCommitment::OrHash
+            )
+        ).void
+      end
+      attr_writer :credit_commitment
+
       # The Credit Block resource models prepaid credits within Orb.
       sig do
         params(
@@ -94,6 +114,10 @@ module Orb
           credit_allocation:
             T.nilable(
               Orb::Models::CreditBlockRetrieveResponse::CreditAllocation::OrHash
+            ),
+          credit_commitment:
+            T.nilable(
+              Orb::Models::CreditBlockRetrieveResponse::CreditCommitment::OrHash
             )
         ).returns(T.attached_class)
       end
@@ -101,7 +125,8 @@ module Orb
         id:,
         balance:,
         # How this credit block was created: `allocation` (a subscription's recurring
-        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
         # `manual` (a manual credit ledger increment, including credits voided or expired
         # off another block).
         credit_block_source:,
@@ -118,7 +143,10 @@ module Orb
         status:,
         # The credit allocation that funded a block. Extends the allocation resource
         # serialized on prices with the catalog-item attribution of the funding price.
-        credit_allocation: nil
+        credit_allocation: nil,
+        # The subscription commitment whose true-up rolled forward into this credit block.
+        # Present only when `credit_block_source` is `commitment`.
+        credit_commitment: nil
       )
       end
 
@@ -140,6 +168,10 @@ module Orb
             credit_allocation:
               T.nilable(
                 Orb::Models::CreditBlockRetrieveResponse::CreditAllocation
+              ),
+            credit_commitment:
+              T.nilable(
+                Orb::Models::CreditBlockRetrieveResponse::CreditCommitment
               )
           }
         )
@@ -148,7 +180,8 @@ module Orb
       end
 
       # How this credit block was created: `allocation` (a subscription's recurring
-      # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+      # credit allocation), `top_up` (an automatic balance-threshold top-up),
+      # `commitment` (a subscription commitment true-up rolled forward as credit), or
       # `manual` (a manual credit ledger increment, including credits voided or expired
       # off another block).
       module CreditBlockSource
@@ -173,6 +206,11 @@ module Orb
             :top_up,
             Orb::Models::CreditBlockRetrieveResponse::CreditBlockSource::TaggedSymbol
           )
+        COMMITMENT =
+          T.let(
+            :commitment,
+            Orb::Models::CreditBlockRetrieveResponse::CreditBlockSource::TaggedSymbol
+          )
         MANUAL =
           T.let(
             :manual,
@@ -616,6 +654,45 @@ module Orb
           end
         end
       end
+
+      class CreditCommitment < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Models::CreditBlockRetrieveResponse::CreditCommitment,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The ID of the subscription commitment this block was rolled forward from.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The subscription the commitment belongs to.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :subscription_id
+
+        # The subscription commitment whose true-up rolled forward into this credit block.
+        # Present only when `credit_block_source` is `commitment`.
+        sig do
+          params(id: String, subscription_id: T.nilable(String)).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID of the subscription commitment this block was rolled forward from.
+          id:,
+          # The subscription the commitment belongs to.
+          subscription_id: nil
+        )
+        end
+
+        sig do
+          override.returns({ id: String, subscription_id: T.nilable(String) })
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi

@@ -19,7 +19,8 @@ module Orb
         attr_accessor :balance
 
         # How this credit block was created: `allocation` (a subscription's recurring
-        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
         # `manual` (a manual credit ledger increment, including credits voided or expired
         # off another block).
         sig do
@@ -85,6 +86,27 @@ module Orb
         end
         attr_writer :credit_allocation
 
+        # The subscription commitment whose true-up rolled forward into this credit block.
+        # Present only when `credit_block_source` is `commitment`.
+        sig do
+          returns(
+            T.nilable(
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment
+            )
+          )
+        end
+        attr_reader :credit_commitment
+
+        sig do
+          params(
+            credit_commitment:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment::OrHash
+              )
+          ).void
+        end
+        attr_writer :credit_commitment
+
         sig do
           params(
             id: String,
@@ -105,6 +127,10 @@ module Orb
             credit_allocation:
               T.nilable(
                 Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation::OrHash
+              ),
+            credit_commitment:
+              T.nilable(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment::OrHash
               )
           ).returns(T.attached_class)
         end
@@ -112,7 +138,8 @@ module Orb
           id:,
           balance:,
           # How this credit block was created: `allocation` (a subscription's recurring
-          # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+          # credit allocation), `top_up` (an automatic balance-threshold top-up),
+          # `commitment` (a subscription commitment true-up rolled forward as credit), or
           # `manual` (a manual credit ledger increment, including credits voided or expired
           # off another block).
           credit_block_source:,
@@ -129,7 +156,10 @@ module Orb
           status:,
           # The credit allocation that funded a block. Extends the allocation resource
           # serialized on prices with the catalog-item attribution of the funding price.
-          credit_allocation: nil
+          credit_allocation: nil,
+          # The subscription commitment whose true-up rolled forward into this credit block.
+          # Present only when `credit_block_source` is `commitment`.
+          credit_commitment: nil
         )
         end
 
@@ -154,6 +184,10 @@ module Orb
               credit_allocation:
                 T.nilable(
                   Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation
+                ),
+              credit_commitment:
+                T.nilable(
+                  Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment
                 )
             }
           )
@@ -162,7 +196,8 @@ module Orb
         end
 
         # How this credit block was created: `allocation` (a subscription's recurring
-        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
         # `manual` (a manual credit ledger increment, including credits voided or expired
         # off another block).
         module CreditBlockSource
@@ -187,6 +222,11 @@ module Orb
               :top_up,
               Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
             )
+          COMMITMENT =
+            T.let(
+              :commitment,
+              Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource::TaggedSymbol
+            )
           MANUAL =
             T.let(
               :manual,
@@ -614,6 +654,45 @@ module Orb
             end
           end
         end
+
+        class CreditCommitment < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The ID of the subscription commitment this block was rolled forward from.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The subscription the commitment belongs to.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :subscription_id
+
+          # The subscription commitment whose true-up rolled forward into this credit block.
+          # Present only when `credit_block_source` is `commitment`.
+          sig do
+            params(id: String, subscription_id: T.nilable(String)).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The ID of the subscription commitment this block was rolled forward from.
+            id:,
+            # The subscription the commitment belongs to.
+            subscription_id: nil
+          )
+          end
+
+          sig do
+            override.returns({ id: String, subscription_id: T.nilable(String) })
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/orb/models/customers/credit_list_response.rbi

@@ -19,7 +19,8 @@ module Orb
         attr_accessor :balance
 
         # How this credit block was created: `allocation` (a subscription's recurring
-        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
         # `manual` (a manual credit ledger increment, including credits voided or expired
         # off another block).
         sig do
@@ -81,6 +82,27 @@ module Orb
         end
         attr_writer :credit_allocation
 
+        # The subscription commitment whose true-up rolled forward into this credit block.
+        # Present only when `credit_block_source` is `commitment`.
+        sig do
+          returns(
+            T.nilable(
+              Orb::Models::Customers::CreditListResponse::CreditCommitment
+            )
+          )
+        end
+        attr_reader :credit_commitment
+
+        sig do
+          params(
+            credit_commitment:
+              T.nilable(
+                Orb::Models::Customers::CreditListResponse::CreditCommitment::OrHash
+              )
+          ).void
+        end
+        attr_writer :credit_commitment
+
         sig do
           params(
             id: String,
@@ -101,6 +123,10 @@ module Orb
             credit_allocation:
               T.nilable(
                 Orb::Models::Customers::CreditListResponse::CreditAllocation::OrHash
+              ),
+            credit_commitment:
+              T.nilable(
+                Orb::Models::Customers::CreditListResponse::CreditCommitment::OrHash
               )
           ).returns(T.attached_class)
         end
@@ -108,7 +134,8 @@ module Orb
           id:,
           balance:,
           # How this credit block was created: `allocation` (a subscription's recurring
-          # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+          # credit allocation), `top_up` (an automatic balance-threshold top-up),
+          # `commitment` (a subscription commitment true-up rolled forward as credit), or
           # `manual` (a manual credit ledger increment, including credits voided or expired
           # off another block).
           credit_block_source:,
@@ -125,7 +152,10 @@ module Orb
           status:,
           # The credit allocation that funded a block. Extends the allocation resource
           # serialized on prices with the catalog-item attribution of the funding price.
-          credit_allocation: nil
+          credit_allocation: nil,
+          # The subscription commitment whose true-up rolled forward into this credit block.
+          # Present only when `credit_block_source` is `commitment`.
+          credit_commitment: nil
         )
         end
 
@@ -148,6 +178,10 @@ module Orb
               credit_allocation:
                 T.nilable(
                   Orb::Models::Customers::CreditListResponse::CreditAllocation
+                ),
+              credit_commitment:
+                T.nilable(
+                  Orb::Models::Customers::CreditListResponse::CreditCommitment
                 )
             }
           )
@@ -156,7 +190,8 @@ module Orb
         end
 
         # How this credit block was created: `allocation` (a subscription's recurring
-        # credit allocation), `top_up` (an automatic balance-threshold top-up), or
+        # credit allocation), `top_up` (an automatic balance-threshold top-up),
+        # `commitment` (a subscription commitment true-up rolled forward as credit), or
         # `manual` (a manual credit ledger increment, including credits voided or expired
         # off another block).
         module CreditBlockSource
@@ -181,6 +216,11 @@ module Orb
               :top_up,
               Orb::Models::Customers::CreditListResponse::CreditBlockSource::TaggedSymbol
             )
+          COMMITMENT =
+            T.let(
+              :commitment,
+              Orb::Models::Customers::CreditListResponse::CreditBlockSource::TaggedSymbol
+            )
           MANUAL =
             T.let(
               :manual,
@@ -605,6 +645,45 @@ module Orb
             end
           end
         end
+
+        class CreditCommitment < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Models::Customers::CreditListResponse::CreditCommitment,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The ID of the subscription commitment this block was rolled forward from.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The subscription the commitment belongs to.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :subscription_id
+
+          # The subscription commitment whose true-up rolled forward into this credit block.
+          # Present only when `credit_block_source` is `commitment`.
+          sig do
+            params(id: String, subscription_id: T.nilable(String)).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The ID of the subscription commitment this block was rolled forward from.
+            id:,
+            # The subscription the commitment belongs to.
+            subscription_id: nil
+          )
+          end
+
+          sig do
+            override.returns({ id: String, subscription_id: T.nilable(String) })
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/orb/models/event_ingest_response.rbi

@@ -15,8 +15,6 @@ module Orb
       end
       attr_accessor :validation_failed
 
-      # Optional debug information (only present when debug=true is passed to the
-      # endpoint). Contains ingested and duplicate event idempotency keys.
       sig { returns(T.nilable(Orb::Models::EventIngestResponse::Debug)) }
       attr_reader :debug
 
@@ -40,8 +38,6 @@ module Orb
         # Contains all failing validation events. In the case of a 200, this array will
         # always be empty. This field will always be present.
         validation_failed:,
-        # Optional debug information (only present when debug=true is passed to the
-        # endpoint). Contains ingested and duplicate event idempotency keys.
         debug: nil
       )
       end
@@ -115,8 +111,6 @@ module Orb
         sig { returns(T::Array[String]) }
         attr_accessor :ingested
 
-        # Optional debug information (only present when debug=true is passed to the
-        # endpoint). Contains ingested and duplicate event idempotency keys.
         sig do
           params(
             duplicate: T::Array[String],

data/sig/orb/models/billable_metric.rbs

@@ -7,6 +7,7 @@ module Orb
         item: Orb::Item,
         metadata: ::Hash[Symbol, String],
         name: String,
+        sql: String,
         status: Orb::Models::BillableMetric::status,
         parameter_definitions: ::Array[::Hash[Symbol, top]]?
       }
@@ -22,6 +23,8 @@ module Orb
 
       attr_accessor name: String
 
+      attr_accessor sql: String
+
       attr_accessor status: Orb::Models::BillableMetric::status
 
       attr_accessor parameter_definitions: ::Array[::Hash[Symbol, top]]?
@@ -32,6 +35,7 @@ module Orb
         item: Orb::Item,
         metadata: ::Hash[Symbol, String],
         name: String,
+        sql: String,
         status: Orb::Models::BillableMetric::status,
         ?parameter_definitions: ::Array[::Hash[Symbol, top]]?
       ) -> void
@@ -42,6 +46,7 @@ module Orb
         item: Orb::Item,
         metadata: ::Hash[Symbol, String],
         name: String,
+        sql: String,
         status: Orb::Models::BillableMetric::status,
         parameter_definitions: ::Array[::Hash[Symbol, top]]?
       }

data/sig/orb/models/credit_block_list_invoices_response.rbs

@@ -33,7 +33,8 @@ module Orb
           metadata: ::Hash[Symbol, String],
           per_unit_cost_basis: String?,
           status: Orb::Models::CreditBlockListInvoicesResponse::Block::status,
-          credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?
+          credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?,
+          credit_commitment: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditCommitment?
         }
 
       class Block < Orb::Internal::Type::BaseModel
@@ -59,6 +60,8 @@ module Orb
 
         attr_accessor credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?
 
+        attr_accessor credit_commitment: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditCommitment?
+
         def initialize: (
           id: String,
           balance: Float,
@@ -70,7 +73,8 @@ module Orb
           metadata: ::Hash[Symbol, String],
           per_unit_cost_basis: String?,
           status: Orb::Models::CreditBlockListInvoicesResponse::Block::status,
-          ?credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?
+          ?credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?,
+          ?credit_commitment: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditCommitment?
         ) -> void
 
         def to_hash: -> {
@@ -84,16 +88,18 @@ module Orb
           metadata: ::Hash[Symbol, String],
           per_unit_cost_basis: String?,
           status: Orb::Models::CreditBlockListInvoicesResponse::Block::status,
-          credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?
+          credit_allocation: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?,
+          credit_commitment: Orb::Models::CreditBlockListInvoicesResponse::Block::CreditCommitment?
         }
 
-        type credit_block_source = :allocation | :top_up | :manual
+        type credit_block_source = :allocation | :top_up | :commitment | :manual
 
         module CreditBlockSource
           extend Orb::Internal::Type::Enum
 
           ALLOCATION: :allocation
           TOP_UP: :top_up
+          COMMITMENT: :commitment
           MANUAL: :manual
 
           def self?.values: -> ::Array[Orb::Models::CreditBlockListInvoicesResponse::Block::credit_block_source]
@@ -261,6 +267,18 @@ module Orb
             end
           end
         end
+
+        type credit_commitment = { id: String, subscription_id: String? }
+
+        class CreditCommitment < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor subscription_id: String?
+
+          def initialize: (id: String, ?subscription_id: String?) -> void
+
+          def to_hash: -> { id: String, subscription_id: String? }
+        end
       end
 
       type invoice =

data/sig/orb/models/credit_block_retrieve_response.rbs

@@ -12,7 +12,8 @@ module Orb
         metadata: ::Hash[Symbol, String],
         per_unit_cost_basis: String?,
         status: Orb::Models::CreditBlockRetrieveResponse::status,
-        credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?
+        credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?,
+        credit_commitment: Orb::Models::CreditBlockRetrieveResponse::CreditCommitment?
       }
 
     class CreditBlockRetrieveResponse < Orb::Internal::Type::BaseModel
@@ -38,6 +39,8 @@ module Orb
 
       attr_accessor credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?
 
+      attr_accessor credit_commitment: Orb::Models::CreditBlockRetrieveResponse::CreditCommitment?
+
       def initialize: (
         id: String,
         balance: Float,
@@ -49,7 +52,8 @@ module Orb
         metadata: ::Hash[Symbol, String],
         per_unit_cost_basis: String?,
         status: Orb::Models::CreditBlockRetrieveResponse::status,
-        ?credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?
+        ?credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?,
+        ?credit_commitment: Orb::Models::CreditBlockRetrieveResponse::CreditCommitment?
       ) -> void
 
       def to_hash: -> {
@@ -63,16 +67,18 @@ module Orb
         metadata: ::Hash[Symbol, String],
         per_unit_cost_basis: String?,
         status: Orb::Models::CreditBlockRetrieveResponse::status,
-        credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?
+        credit_allocation: Orb::Models::CreditBlockRetrieveResponse::CreditAllocation?,
+        credit_commitment: Orb::Models::CreditBlockRetrieveResponse::CreditCommitment?
       }
 
-      type credit_block_source = :allocation | :top_up | :manual
+      type credit_block_source = :allocation | :top_up | :commitment | :manual
 
       module CreditBlockSource
         extend Orb::Internal::Type::Enum
 
         ALLOCATION: :allocation
         TOP_UP: :top_up
+        COMMITMENT: :commitment
         MANUAL: :manual
 
         def self?.values: -> ::Array[Orb::Models::CreditBlockRetrieveResponse::credit_block_source]
@@ -240,6 +246,18 @@ module Orb
           end
         end
       end
+
+      type credit_commitment = { id: String, subscription_id: String? }
+
+      class CreditCommitment < Orb::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor subscription_id: String?
+
+        def initialize: (id: String, ?subscription_id: String?) -> void
+
+        def to_hash: -> { id: String, subscription_id: String? }
+      end
     end
   end
 end