orb-billing 1.14.0 → 1.15.0

data/rbi/orb/resources/subscriptions.rbi

@@ -275,6 +275,7 @@ module Orb
             ),
           align_billing_with_subscription_start_date: T::Boolean,
           auto_collection: T.nilable(T::Boolean),
+          auto_issuance: T.nilable(T::Boolean),
           aws_region: T.nilable(String),
           billing_cycle_anchor_configuration:
             T.nilable(Orb::BillingCycleAnchorConfiguration::OrHash),
@@ -335,6 +336,11 @@ module Orb
         # charged with the saved payment method on the due date. If not specified, this
         # defaults to the behavior configured for this customer.
         auto_collection: nil,
+        # Used to determine if invoices for this subscription will be automatically
+        # issued. If true, invoices will be automatically issued. If false, invoices will
+        # require manual approval. If `null` is specified, this defaults to the behavior
+        # configured for this customer.
+        auto_issuance: nil,
         aws_region: nil,
         billing_cycle_anchor_configuration: nil,
         # Redemption code to be used for this subscription. If the coupon cannot be found
@@ -423,6 +429,7 @@ module Orb
         params(
           subscription_id: String,
           auto_collection: T.nilable(T::Boolean),
+          auto_issuance: T.nilable(T::Boolean),
           default_invoice_memo: T.nilable(String),
           invoicing_threshold: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
@@ -436,6 +443,11 @@ module Orb
         # charged with the saved payment method on the due date. This property defaults to
         # the plan's behavior.
         auto_collection: nil,
+        # Used to determine if invoices for this subscription will be automatically
+        # issued. If true, invoices will be automatically issued. If false, invoices will
+        # require manual approval. If `null` is specified, this defaults to the behavior
+        # configured for this customer.
+        auto_issuance: nil,
         # Determines the default memo on this subscription's invoices. Note that if this
         # is not provided, it is determined by the plan configuration.
         default_invoice_memo: nil,
@@ -465,6 +477,11 @@ module Orb
       # customer_id or external_customer_id query parameters. To filter subscriptions
       # for multiple customers, use the customer_id[] or external_customer_id[] query
       # parameters.
+      #
+      # Subscriptions can be filtered by status using the status query parameter (one of
+      # `active`, `ended`, or `upcoming`). To filter for multiple statuses in a single
+      # request, use the status[] query parameter, e.g.
+      # `status[]=active&status[]=ended`.
       sig do
         params(
           created_at_gt: T.nilable(Time),
@@ -1250,6 +1267,7 @@ module Orb
             ),
           align_billing_with_plan_change_date: T.nilable(T::Boolean),
           auto_collection: T.nilable(T::Boolean),
+          auto_issuance: T.nilable(T::Boolean),
           billing_cycle_alignment:
             T.nilable(
               Orb::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::OrSymbol
@@ -1314,6 +1332,11 @@ module Orb
         # charged with the saved payment method on the due date. If not specified, this
         # defaults to the behavior configured for this customer.
         auto_collection: nil,
+        # Used to determine if invoices for this subscription will be automatically
+        # issued. If true, invoices will be automatically issued. If false, invoices will
+        # require manual approval. If `null` is specified, this defaults to the behavior
+        # configured for this customer.
+        auto_issuance: nil,
         # Reset billing periods to be aligned with the plan change's effective date or
         # start of the month. Defaults to `unchanged` which keeps subscription's existing
         # billing cycle alignment.
@@ -1415,6 +1438,12 @@ module Orb
       # To be eligible, the subscription must currently be active and have a future
       # cancellation. This operation will turn on auto-renew, ensuring that the
       # subscription does not end at the currently scheduled cancellation time.
+      #
+      # Note: uncancellation is a lossy operation. Price intervals that were cut short
+      # by the cancellation are extended to infinity (original end dates are lost), and
+      # future intervals or phases scheduled after the cancellation time are permanently
+      # deleted. For complex subscriptions with phases or scheduled plan changes,
+      # consider creating a new plan change instead of uncancelling.
       sig do
         params(
           subscription_id: String,

data/sig/orb/models/accounting_provider_config.rbs

@@ -1,19 +1,36 @@
 module Orb
   module Models
     type accounting_provider_config =
-      { external_provider_id: String, provider_type: String }
+      {
+        external_provider_id: String,
+        provider_type: Orb::Models::AccountingProviderConfig::provider_type
+      }
 
     class AccountingProviderConfig < Orb::Internal::Type::BaseModel
       attr_accessor external_provider_id: String
 
-      attr_accessor provider_type: String
+      attr_accessor provider_type: Orb::Models::AccountingProviderConfig::provider_type
 
       def initialize: (
         external_provider_id: String,
-        provider_type: String
+        provider_type: Orb::Models::AccountingProviderConfig::provider_type
       ) -> void
 
-      def to_hash: -> { external_provider_id: String, provider_type: String }
+      def to_hash: -> {
+        external_provider_id: String,
+        provider_type: Orb::Models::AccountingProviderConfig::provider_type
+      }
+
+      type provider_type = :quickbooks | :netsuite
+
+      module ProviderType
+        extend Orb::Internal::Type::Enum
+
+        QUICKBOOKS: :quickbooks
+        NETSUITE: :netsuite
+
+        def self?.values: -> ::Array[Orb::Models::AccountingProviderConfig::provider_type]
+      end
     end
   end
 end

data/sig/orb/models/adjustment_interval.rbs

@@ -40,12 +40,146 @@ module Orb
         Orb::PlanPhaseUsageDiscountAdjustment
         | Orb::PlanPhaseAmountDiscountAdjustment
         | Orb::PlanPhasePercentageDiscountAdjustment
+        | Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount
         | Orb::PlanPhaseMinimumAdjustment
         | Orb::PlanPhaseMaximumAdjustment
 
       module Adjustment
         extend Orb::Internal::Type::Union
 
+        type tiered_percentage_discount =
+          {
+            id: String,
+            adjustment_type: :tiered_percentage_discount,
+            applies_to_price_ids: ::Array[String],
+            filters: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter],
+            is_invoice_level: bool,
+            plan_phase_order: Integer?,
+            reason: String?,
+            replaces_adjustment_id: String?,
+            tiers: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier]
+          }
+
+        class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor adjustment_type: :tiered_percentage_discount
+
+          attr_accessor applies_to_price_ids: ::Array[String]
+
+          attr_accessor filters: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter]
+
+          attr_accessor is_invoice_level: bool
+
+          attr_accessor plan_phase_order: Integer?
+
+          attr_accessor reason: String?
+
+          attr_accessor replaces_adjustment_id: String?
+
+          attr_accessor tiers: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier]
+
+          def initialize: (
+            id: String,
+            applies_to_price_ids: ::Array[String],
+            filters: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter],
+            is_invoice_level: bool,
+            plan_phase_order: Integer?,
+            reason: String?,
+            replaces_adjustment_id: String?,
+            tiers: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier],
+            ?adjustment_type: :tiered_percentage_discount
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            adjustment_type: :tiered_percentage_discount,
+            applies_to_price_ids: ::Array[String],
+            filters: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter],
+            is_invoice_level: bool,
+            plan_phase_order: Integer?,
+            reason: String?,
+            replaces_adjustment_id: String?,
+            tiers: ::Array[Orb::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Tier]
+          }
+
+          type filter =
+            {
+              field: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::field,
+              operator: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::operator,
+              values: ::Array[String]
+            }
+
+          class Filter < Orb::Internal::Type::BaseModel
+            attr_accessor field: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::field
+
+            attr_accessor operator: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::operator
+
+            attr_accessor values: ::Array[String]
+
+            def initialize: (
+              field: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::field,
+              operator: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::operator,
+              values: ::Array[String]
+            ) -> void
+
+            def to_hash: -> {
+              field: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::field,
+              operator: Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::operator,
+              values: ::Array[String]
+            }
+
+            type field =
+              :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              PRICE_ID: :price_id
+              ITEM_ID: :item_id
+              PRICE_TYPE: :price_type
+              CURRENCY: :currency
+              PRICING_UNIT_ID: :pricing_unit_id
+
+              def self?.values: -> ::Array[Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::field]
+            end
+
+            type operator = :includes | :excludes
+
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES: :includes
+              EXCLUDES: :excludes
+
+              def self?.values: -> ::Array[Orb::Models::AdjustmentInterval::Adjustment::TieredPercentageDiscount::Filter::operator]
+            end
+          end
+
+          type tier =
+            { lower_bound: Float, percentage: Float, upper_bound: Float? }
+
+          class Tier < Orb::Internal::Type::BaseModel
+            attr_accessor lower_bound: Float
+
+            attr_accessor percentage: Float
+
+            attr_accessor upper_bound: Float?
+
+            def initialize: (
+              lower_bound: Float,
+              percentage: Float,
+              ?upper_bound: Float?
+            ) -> void
+
+            def to_hash: -> {
+              lower_bound: Float,
+              percentage: Float,
+              upper_bound: Float?
+            }
+          end
+        end
+
         def self?.variants: -> ::Array[Orb::Models::AdjustmentInterval::adjustment]
       end
     end

data/sig/orb/models/alert.rbs

@@ -14,7 +14,9 @@ module Orb
         type: Orb::Models::Alert::type_,
         balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?,
         grouping_keys: ::Array[String]?,
-        license_type: Orb::Alert::LicenseType?
+        license_type: Orb::Alert::LicenseType?,
+        price_filters: ::Array[Orb::Alert::PriceFilter]?,
+        threshold_overrides: ::Array[Orb::Alert::ThresholdOverride]?
       }
 
     class Alert < Orb::Internal::Type::BaseModel
@@ -44,6 +46,10 @@ module Orb
 
       attr_accessor license_type: Orb::Alert::LicenseType?
 
+      attr_accessor price_filters: ::Array[Orb::Alert::PriceFilter]?
+
+      attr_accessor threshold_overrides: ::Array[Orb::Alert::ThresholdOverride]?
+
       def initialize: (
         id: String,
         created_at: Time,
@@ -57,7 +63,9 @@ module Orb
         type: Orb::Models::Alert::type_,
         ?balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?,
         ?grouping_keys: ::Array[String]?,
-        ?license_type: Orb::Alert::LicenseType?
+        ?license_type: Orb::Alert::LicenseType?,
+        ?price_filters: ::Array[Orb::Alert::PriceFilter]?,
+        ?threshold_overrides: ::Array[Orb::Alert::ThresholdOverride]?
       ) -> void
 
       def to_hash: -> {
@@ -73,7 +81,9 @@ module Orb
         type: Orb::Models::Alert::type_,
         balance_alert_status: ::Array[Orb::Alert::BalanceAlertStatus]?,
         grouping_keys: ::Array[String]?,
-        license_type: Orb::Alert::LicenseType?
+        license_type: Orb::Alert::LicenseType?,
+        price_filters: ::Array[Orb::Alert::PriceFilter]?,
+        threshold_overrides: ::Array[Orb::Alert::ThresholdOverride]?
       }
 
       type metric = { id: String }
@@ -160,6 +170,78 @@ module Orb
 
         def to_hash: -> { id: String }
       end
+
+      type price_filter =
+        {
+          field: Orb::Models::Alert::PriceFilter::field,
+          operator: Orb::Models::Alert::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::Alert::PriceFilter::field
+
+        attr_accessor operator: Orb::Models::Alert::PriceFilter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::Alert::PriceFilter::field,
+          operator: Orb::Models::Alert::PriceFilter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::Alert::PriceFilter::field,
+          operator: Orb::Models::Alert::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+        type field =
+          :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID: :price_id
+          ITEM_ID: :item_id
+          PRICE_TYPE: :price_type
+          CURRENCY: :currency
+          PRICING_UNIT_ID: :pricing_unit_id
+
+          def self?.values: -> ::Array[Orb::Models::Alert::PriceFilter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::Alert::PriceFilter::operator]
+        end
+      end
+
+      type threshold_override =
+        { group_values: ::Array[String], thresholds: ::Array[Orb::Threshold] }
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        attr_accessor group_values: ::Array[String]
+
+        attr_accessor thresholds: ::Array[Orb::Threshold]
+
+        def initialize: (
+          group_values: ::Array[String],
+          thresholds: ::Array[Orb::Threshold]
+        ) -> void
+
+        def to_hash: -> {
+          group_values: ::Array[String],
+          thresholds: ::Array[Orb::Threshold]
+        }
+      end
     end
   end
 end

data/sig/orb/models/alert_create_for_subscription_params.rbs

@@ -5,9 +5,11 @@ module Orb
         subscription_id: String,
         thresholds: ::Array[Orb::Threshold],
         type: Orb::Models::AlertCreateForSubscriptionParams::type_,
+        currency: String?,
         grouping_keys: ::Array[String]?,
         metric_id: String?,
-        pricing_unit_id: String?
+        price_filters: ::Array[Orb::AlertCreateForSubscriptionParams::PriceFilter]?,
+        threshold_overrides: ::Array[Orb::AlertCreateForSubscriptionParams::ThresholdOverride]?
       }
       & Orb::Internal::Type::request_parameters
 
@@ -21,19 +23,25 @@ module Orb
 
       attr_accessor type: Orb::Models::AlertCreateForSubscriptionParams::type_
 
+      attr_accessor currency: String?
+
       attr_accessor grouping_keys: ::Array[String]?
 
       attr_accessor metric_id: String?
 
-      attr_accessor pricing_unit_id: String?
+      attr_accessor price_filters: ::Array[Orb::AlertCreateForSubscriptionParams::PriceFilter]?
+
+      attr_accessor threshold_overrides: ::Array[Orb::AlertCreateForSubscriptionParams::ThresholdOverride]?
 
       def initialize: (
         subscription_id: String,
         thresholds: ::Array[Orb::Threshold],
         type: Orb::Models::AlertCreateForSubscriptionParams::type_,
+        ?currency: String?,
         ?grouping_keys: ::Array[String]?,
         ?metric_id: String?,
-        ?pricing_unit_id: String?,
+        ?price_filters: ::Array[Orb::AlertCreateForSubscriptionParams::PriceFilter]?,
+        ?threshold_overrides: ::Array[Orb::AlertCreateForSubscriptionParams::ThresholdOverride]?,
         ?request_options: Orb::request_opts
       ) -> void
 
@@ -41,9 +49,11 @@ module Orb
         subscription_id: String,
         thresholds: ::Array[Orb::Threshold],
         type: Orb::Models::AlertCreateForSubscriptionParams::type_,
+        currency: String?,
         grouping_keys: ::Array[String]?,
         metric_id: String?,
-        pricing_unit_id: String?,
+        price_filters: ::Array[Orb::AlertCreateForSubscriptionParams::PriceFilter]?,
+        threshold_overrides: ::Array[Orb::AlertCreateForSubscriptionParams::ThresholdOverride]?,
         request_options: Orb::RequestOptions
       }
 
@@ -57,6 +67,78 @@ module Orb
 
         def self?.values: -> ::Array[Orb::Models::AlertCreateForSubscriptionParams::type_]
       end
+
+      type price_filter =
+        {
+          field: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::field,
+          operator: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::field
+
+        attr_accessor operator: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::field,
+          operator: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::field,
+          operator: Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+        type field =
+          :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID: :price_id
+          ITEM_ID: :item_id
+          PRICE_TYPE: :price_type
+          CURRENCY: :currency
+          PRICING_UNIT_ID: :pricing_unit_id
+
+          def self?.values: -> ::Array[Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::AlertCreateForSubscriptionParams::PriceFilter::operator]
+        end
+      end
+
+      type threshold_override =
+        { group_values: ::Array[String], thresholds: ::Array[Orb::Threshold] }
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        attr_accessor group_values: ::Array[String]
+
+        attr_accessor thresholds: ::Array[Orb::Threshold]
+
+        def initialize: (
+          group_values: ::Array[String],
+          thresholds: ::Array[Orb::Threshold]
+        ) -> void
+
+        def to_hash: -> {
+          group_values: ::Array[String],
+          thresholds: ::Array[Orb::Threshold]
+        }
+      end
     end
   end
 end

data/sig/orb/models/alert_update_params.rbs

@@ -1,7 +1,12 @@
 module Orb
   module Models
     type alert_update_params =
-      { alert_configuration_id: String, thresholds: ::Array[Orb::Threshold] }
+      {
+        alert_configuration_id: String,
+        thresholds: ::Array[Orb::Threshold],
+        price_filters: ::Array[Orb::AlertUpdateParams::PriceFilter]?,
+        threshold_overrides: ::Array[Orb::AlertUpdateParams::ThresholdOverride]?
+      }
       & Orb::Internal::Type::request_parameters
 
     class AlertUpdateParams < Orb::Internal::Type::BaseModel
@@ -12,17 +17,97 @@ module Orb
 
       attr_accessor thresholds: ::Array[Orb::Threshold]
 
+      attr_accessor price_filters: ::Array[Orb::AlertUpdateParams::PriceFilter]?
+
+      attr_accessor threshold_overrides: ::Array[Orb::AlertUpdateParams::ThresholdOverride]?
+
       def initialize: (
         alert_configuration_id: String,
         thresholds: ::Array[Orb::Threshold],
+        ?price_filters: ::Array[Orb::AlertUpdateParams::PriceFilter]?,
+        ?threshold_overrides: ::Array[Orb::AlertUpdateParams::ThresholdOverride]?,
         ?request_options: Orb::request_opts
       ) -> void
 
       def to_hash: -> {
         alert_configuration_id: String,
         thresholds: ::Array[Orb::Threshold],
+        price_filters: ::Array[Orb::AlertUpdateParams::PriceFilter]?,
+        threshold_overrides: ::Array[Orb::AlertUpdateParams::ThresholdOverride]?,
         request_options: Orb::RequestOptions
       }
+
+      type price_filter =
+        {
+          field: Orb::Models::AlertUpdateParams::PriceFilter::field,
+          operator: Orb::Models::AlertUpdateParams::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        attr_accessor field: Orb::Models::AlertUpdateParams::PriceFilter::field
+
+        attr_accessor operator: Orb::Models::AlertUpdateParams::PriceFilter::operator
+
+        attr_accessor values: ::Array[String]
+
+        def initialize: (
+          field: Orb::Models::AlertUpdateParams::PriceFilter::field,
+          operator: Orb::Models::AlertUpdateParams::PriceFilter::operator,
+          values: ::Array[String]
+        ) -> void
+
+        def to_hash: -> {
+          field: Orb::Models::AlertUpdateParams::PriceFilter::field,
+          operator: Orb::Models::AlertUpdateParams::PriceFilter::operator,
+          values: ::Array[String]
+        }
+
+        type field =
+          :price_id | :item_id | :price_type | :currency | :pricing_unit_id
+
+        module Field
+          extend Orb::Internal::Type::Enum
+
+          PRICE_ID: :price_id
+          ITEM_ID: :item_id
+          PRICE_TYPE: :price_type
+          CURRENCY: :currency
+          PRICING_UNIT_ID: :pricing_unit_id
+
+          def self?.values: -> ::Array[Orb::Models::AlertUpdateParams::PriceFilter::field]
+        end
+
+        type operator = :includes | :excludes
+
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES: :includes
+          EXCLUDES: :excludes
+
+          def self?.values: -> ::Array[Orb::Models::AlertUpdateParams::PriceFilter::operator]
+        end
+      end
+
+      type threshold_override =
+        { group_values: ::Array[String], thresholds: ::Array[Orb::Threshold] }
+
+      class ThresholdOverride < Orb::Internal::Type::BaseModel
+        attr_accessor group_values: ::Array[String]
+
+        attr_accessor thresholds: ::Array[Orb::Threshold]
+
+        def initialize: (
+          group_values: ::Array[String],
+          thresholds: ::Array[Orb::Threshold]
+        ) -> void
+
+        def to_hash: -> {
+          group_values: ::Array[String],
+          thresholds: ::Array[Orb::Threshold]
+        }
+      end
     end
   end
 end