orb-billing 1.29.0 → 1.31.0

data/rbi/orb/resources/customers/credits/top_ups.rbi

@@ -58,7 +58,13 @@ module Orb
           )
           end
 
-          # List top-ups
+          # This endpoint returns a list of a customer's active top-ups; a top-up that has
+          # been deactivated is not included. While a top-up is active, the customer's
+          # balance is increased by the top-up amount whenever it falls to the top-up's
+          # threshold.
+          #
+          # The response also includes pagination_metadata, which lets the caller retrieve
+          # the next page of results if they exist.
           sig do
             params(
               customer_id: String,
@@ -163,7 +169,13 @@ module Orb
           )
           end
 
-          # List top-ups by external ID
+          # This endpoint returns a list of a customer's active top-ups; a top-up that has
+          # been deactivated is not included. While a top-up is active, the customer's
+          # balance is increased by the top-up amount whenever it falls to the top-up's
+          # threshold.
+          #
+          # The response also includes pagination_metadata, which lets the caller retrieve
+          # the next page of results if they exist.
           sig do
             params(
               external_customer_id: String,

data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi

@@ -4,7 +4,10 @@ module Orb
   module Resources
     class DimensionalPriceGroups
       class ExternalDimensionalPriceGroupID
-        # Fetch dimensional price group by external ID
+        # This endpoint returns a dimensional price group identified by the external ID
+        # you assigned it, rather than by its Orb ID. A dimensional price group partitions
+        # the result of a billable metric by a set of dimensions, and the prices in the
+        # group specify which partition their usage is derived from.
         sig do
           params(
             external_dimensional_price_group_id: String,

data/rbi/orb/resources/dimensional_price_groups.rbi

@@ -42,7 +42,10 @@ module Orb
       )
       end
 
-      # Fetch dimensional price group
+      # This endpoint returns a dimensional price group identified by its ID. A
+      # dimensional price group partitions the result of a billable metric by a set of
+      # dimensions, and the prices in the group specify which partition their usage is
+      # derived from.
       sig do
         params(
           dimensional_price_group_id: String,
@@ -78,7 +81,13 @@ module Orb
       )
       end
 
-      # List dimensional price groups
+      # This endpoint returns a list of all dimensional price groups for an account. A
+      # dimensional price group partitions the result of a billable metric by a set of
+      # dimensions, and the prices in the group specify which partition their usage is
+      # derived from.
+      #
+      # The response also includes pagination_metadata, which lets the caller retrieve
+      # the next page of results if they exist.
       sig do
         params(
           cursor: T.nilable(String),

data/rbi/orb/resources/items.rbi

@@ -69,7 +69,9 @@ module Orb
       )
       end
 
-      # Archive item
+      # This endpoint archives an item, and cascades to archive every price for that
+      # item that is still active. An item that is already archived cannot be archived
+      # again.
       sig do
         params(
           item_id: String,

data/rbi/orb/resources/plans/migrations.rbi

@@ -8,7 +8,9 @@ module Orb
       # subscription. You can see more about how to configure prices in the
       # [Price resource](/reference/price).
       class Migrations
-        # Fetch migration
+        # This endpoint returns a migration for a plan, identified by its ID. A migration
+        # moves a plan's subscriptions onto a new version of that plan; the response
+        # reports the effective time it is scheduled for and its current status.
         sig do
           params(
             migration_id: String,

data/rbi/orb/resources/prices.rbi

@@ -55,6 +55,7 @@ module Orb
               Orb::NewFloatingPackageWithAllocationPrice::OrHash,
               Orb::NewFloatingUnitWithPercentPrice::OrHash,
               Orb::NewFloatingMatrixWithAllocationPrice::OrHash,
+              Orb::PriceCreateParams::Body::TieredMatrixWithAllocation::OrHash,
               Orb::PriceCreateParams::Body::MatrixWithThresholdDiscounts::OrHash,
               Orb::NewFloatingTieredWithProrationPrice::OrHash,
               Orb::NewFloatingUnitWithProrationPrice::OrHash,

data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs

@@ -480,6 +480,7 @@ module Orb
             | Orb::NewPlanPackageWithAllocationPrice
             | Orb::NewPlanUnitWithPercentPrice
             | Orb::NewPlanMatrixWithAllocationPrice
+            | Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation
             | Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts
             | Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration
             | Orb::NewPlanUnitWithProrationPrice
@@ -872,6 +873,193 @@ module Orb
               end
             end
 
+            type tiered_matrix_with_allocation =
+              {
+                cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::cadence,
+                item_id: String,
+                model_type: :tiered_matrix_with_allocation,
+                name: String,
+                tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+                billable_metric_id: String?,
+                billed_in_advance: bool?,
+                billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                conversion_rate: Float?,
+                conversion_rate_config: Orb::Models::conversion_rate_config?,
+                currency: String?,
+                dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+                external_price_id: String?,
+                fixed_price_quantity: Float?,
+                invoice_grouping_key: String?,
+                invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                license_type_id: String?,
+                metadata: ::Hash[Symbol, String?]?,
+                reference_id: String?
+              }
+
+            class TieredMatrixWithAllocation < Orb::Internal::Type::BaseModel
+              attr_accessor cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::cadence
+
+              attr_accessor item_id: String
+
+              attr_accessor model_type: :tiered_matrix_with_allocation
+
+              attr_accessor name: String
+
+              attr_accessor tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig
+
+              attr_accessor billable_metric_id: String?
+
+              attr_accessor billed_in_advance: bool?
+
+              attr_accessor billing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+              attr_accessor conversion_rate: Float?
+
+              attr_accessor conversion_rate_config: Orb::Models::conversion_rate_config?
+
+              attr_accessor currency: String?
+
+              attr_accessor dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?
+
+              attr_accessor external_price_id: String?
+
+              attr_accessor fixed_price_quantity: Float?
+
+              attr_accessor invoice_grouping_key: String?
+
+              attr_accessor invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+              attr_accessor license_type_id: String?
+
+              attr_accessor metadata: ::Hash[Symbol, String?]?
+
+              attr_accessor reference_id: String?
+
+              def initialize: (
+                cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::cadence,
+                item_id: String,
+                name: String,
+                tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+                ?billable_metric_id: String?,
+                ?billed_in_advance: bool?,
+                ?billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                ?conversion_rate: Float?,
+                ?conversion_rate_config: Orb::Models::conversion_rate_config?,
+                ?currency: String?,
+                ?dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+                ?external_price_id: String?,
+                ?fixed_price_quantity: Float?,
+                ?invoice_grouping_key: String?,
+                ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                ?license_type_id: String?,
+                ?metadata: ::Hash[Symbol, String?]?,
+                ?reference_id: String?,
+                ?model_type: :tiered_matrix_with_allocation
+              ) -> void
+
+              def to_hash: -> {
+                cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::cadence,
+                item_id: String,
+                model_type: :tiered_matrix_with_allocation,
+                name: String,
+                tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+                billable_metric_id: String?,
+                billed_in_advance: bool?,
+                billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                conversion_rate: Float?,
+                conversion_rate_config: Orb::Models::conversion_rate_config?,
+                currency: String?,
+                dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+                external_price_id: String?,
+                fixed_price_quantity: Float?,
+                invoice_grouping_key: String?,
+                invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                license_type_id: String?,
+                metadata: ::Hash[Symbol, String?]?,
+                reference_id: String?
+              }
+
+              type cadence =
+                :annual
+                | :semi_annual
+                | :monthly
+                | :quarterly
+                | :one_time
+                | :custom
+
+              module Cadence
+                extend Orb::Internal::Type::Enum
+
+                ANNUAL: :annual
+                SEMI_ANNUAL: :semi_annual
+                MONTHLY: :monthly
+                QUARTERLY: :quarterly
+                ONE_TIME: :one_time
+                CUSTOM: :custom
+
+                def self?.values: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::cadence]
+              end
+
+              type tiered_matrix_with_allocation_config =
+                {
+                  allocation: String,
+                  default_unit_amount: String,
+                  dimensions: ::Array[String],
+                  tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+                }
+
+              class TieredMatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
+                attr_accessor allocation: String
+
+                attr_accessor default_unit_amount: String
+
+                attr_accessor dimensions: ::Array[String]
+
+                attr_accessor tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+
+                def initialize: (
+                  allocation: String,
+                  default_unit_amount: String,
+                  dimensions: ::Array[String],
+                  tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+                ) -> void
+
+                def to_hash: -> {
+                  allocation: String,
+                  default_unit_amount: String,
+                  dimensions: ::Array[String],
+                  tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+                }
+
+                type tier =
+                  {
+                    dimension_values: ::Array[String],
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  }
+
+                class Tier < Orb::Internal::Type::BaseModel
+                  attr_accessor dimension_values: ::Array[String]
+
+                  attr_accessor tier_lower_bound: String
+
+                  attr_accessor unit_amount: String
+
+                  def initialize: (
+                    dimension_values: ::Array[String],
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  ) -> void
+
+                  def to_hash: -> {
+                    dimension_values: ::Array[String],
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  }
+                end
+              end
+            end
+
             type matrix_with_threshold_discounts =
               {
                 cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::MatrixWithThresholdDiscounts::cadence,
@@ -2725,6 +2913,7 @@ module Orb
             | Orb::NewPlanPackageWithAllocationPrice
             | Orb::NewPlanUnitWithPercentPrice
             | Orb::NewPlanMatrixWithAllocationPrice
+            | Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation
             | Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts
             | Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredWithProration
             | Orb::NewPlanUnitWithProrationPrice
@@ -3117,6 +3306,193 @@ module Orb
               end
             end
 
+            type tiered_matrix_with_allocation =
+              {
+                cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::cadence,
+                item_id: String,
+                model_type: :tiered_matrix_with_allocation,
+                name: String,
+                tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+                billable_metric_id: String?,
+                billed_in_advance: bool?,
+                billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                conversion_rate: Float?,
+                conversion_rate_config: Orb::Models::conversion_rate_config?,
+                currency: String?,
+                dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+                external_price_id: String?,
+                fixed_price_quantity: Float?,
+                invoice_grouping_key: String?,
+                invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                license_type_id: String?,
+                metadata: ::Hash[Symbol, String?]?,
+                reference_id: String?
+              }
+
+            class TieredMatrixWithAllocation < Orb::Internal::Type::BaseModel
+              attr_accessor cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::cadence
+
+              attr_accessor item_id: String
+
+              attr_accessor model_type: :tiered_matrix_with_allocation
+
+              attr_accessor name: String
+
+              attr_accessor tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig
+
+              attr_accessor billable_metric_id: String?
+
+              attr_accessor billed_in_advance: bool?
+
+              attr_accessor billing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+              attr_accessor conversion_rate: Float?
+
+              attr_accessor conversion_rate_config: Orb::Models::conversion_rate_config?
+
+              attr_accessor currency: String?
+
+              attr_accessor dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?
+
+              attr_accessor external_price_id: String?
+
+              attr_accessor fixed_price_quantity: Float?
+
+              attr_accessor invoice_grouping_key: String?
+
+              attr_accessor invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?
+
+              attr_accessor license_type_id: String?
+
+              attr_accessor metadata: ::Hash[Symbol, String?]?
+
+              attr_accessor reference_id: String?
+
+              def initialize: (
+                cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::cadence,
+                item_id: String,
+                name: String,
+                tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+                ?billable_metric_id: String?,
+                ?billed_in_advance: bool?,
+                ?billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                ?conversion_rate: Float?,
+                ?conversion_rate_config: Orb::Models::conversion_rate_config?,
+                ?currency: String?,
+                ?dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+                ?external_price_id: String?,
+                ?fixed_price_quantity: Float?,
+                ?invoice_grouping_key: String?,
+                ?invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                ?license_type_id: String?,
+                ?metadata: ::Hash[Symbol, String?]?,
+                ?reference_id: String?,
+                ?model_type: :tiered_matrix_with_allocation
+              ) -> void
+
+              def to_hash: -> {
+                cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::cadence,
+                item_id: String,
+                model_type: :tiered_matrix_with_allocation,
+                name: String,
+                tiered_matrix_with_allocation_config: Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig,
+                billable_metric_id: String?,
+                billed_in_advance: bool?,
+                billing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                conversion_rate: Float?,
+                conversion_rate_config: Orb::Models::conversion_rate_config?,
+                currency: String?,
+                dimensional_price_configuration: Orb::NewDimensionalPriceConfiguration?,
+                external_price_id: String?,
+                fixed_price_quantity: Float?,
+                invoice_grouping_key: String?,
+                invoicing_cycle_configuration: Orb::NewBillingCycleConfiguration?,
+                license_type_id: String?,
+                metadata: ::Hash[Symbol, String?]?,
+                reference_id: String?
+              }
+
+              type cadence =
+                :annual
+                | :semi_annual
+                | :monthly
+                | :quarterly
+                | :one_time
+                | :custom
+
+              module Cadence
+                extend Orb::Internal::Type::Enum
+
+                ANNUAL: :annual
+                SEMI_ANNUAL: :semi_annual
+                MONTHLY: :monthly
+                QUARTERLY: :quarterly
+                ONE_TIME: :one_time
+                CUSTOM: :custom
+
+                def self?.values: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::cadence]
+              end
+
+              type tiered_matrix_with_allocation_config =
+                {
+                  allocation: String,
+                  default_unit_amount: String,
+                  dimensions: ::Array[String],
+                  tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+                }
+
+              class TieredMatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
+                attr_accessor allocation: String
+
+                attr_accessor default_unit_amount: String
+
+                attr_accessor dimensions: ::Array[String]
+
+                attr_accessor tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+
+                def initialize: (
+                  allocation: String,
+                  default_unit_amount: String,
+                  dimensions: ::Array[String],
+                  tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+                ) -> void
+
+                def to_hash: -> {
+                  allocation: String,
+                  default_unit_amount: String,
+                  dimensions: ::Array[String],
+                  tiers: ::Array[Orb::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier]
+                }
+
+                type tier =
+                  {
+                    dimension_values: ::Array[String],
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  }
+
+                class Tier < Orb::Internal::Type::BaseModel
+                  attr_accessor dimension_values: ::Array[String]
+
+                  attr_accessor tier_lower_bound: String
+
+                  attr_accessor unit_amount: String
+
+                  def initialize: (
+                    dimension_values: ::Array[String],
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  ) -> void
+
+                  def to_hash: -> {
+                    dimension_values: ::Array[String],
+                    tier_lower_bound: String,
+                    unit_amount: String
+                  }
+                end
+              end
+            end
+
             type matrix_with_threshold_discounts =
               {
                 cadence: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice::Price::MatrixWithThresholdDiscounts::cadence,