orb-billing 1.43.0 → 1.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5dc40a201faac67ea9e72b07425ff535bee8c7963fb6eb92d3ba2e5bc224034
-  data.tar.gz: f895167c6a7d1f9333e90ff8cbecff8e29728b4154d91312b9ebfbd26ee77678
+  metadata.gz: cd059e42a0bc32f497b8d1732f74f0eabe55ea23967eaa351b5e4effc2fb81e8
+  data.tar.gz: 196741b32eb376ae1814cac93aa45e6aff6a470830269c3fcf200c1a27b58283
 SHA512:
-  metadata.gz: 00aefa80fd013628e189a38423ce551e8e4efffde14221d9532eaef6830287d0ac51e2b878d1c5ef4f7d7057b3f9f27a9627b9c3fc03a70afd72e7f644b124ff
-  data.tar.gz: ee6b01f1ef20639b49d8bbacb86da21eb4441d4a6ece28aa4324f4e8a1437dd35394ad909dc7c812c493ca60283e583b551354499d8ab00f0fde0cdc0f52776a
+  metadata.gz: 670d061bbe37e35134fc6230add9db785ff9c0ebc50db153f0beb136180c4c5feb392a9ce33b7148d806956ee87ff11716f2d154ae67cd939e44f131625a6c0a
+  data.tar.gz: e89f8e57d4e47e14b72b1ac6b113a0744ad0ebf6113563136d536ff7a7cda237cd7754f02b0b1613c171547fdb0f882376a67fcca88b7686f88e57362a8fd08d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.44.0](https://github.com/orbcorp/orb-ruby/compare/v1.43.0...v1.44.0) (2026-10-20)
+
+
+### Features
+
+* **api:** add `plan.created` and `plan.edited` webhook events ([9413030](https://github.com/orbcorp/orb-ruby/commit/9413030251c1fd9ac58b583a369afbfb7c02672d))
+* **api:** add `tax_reason` field to tax amount entries ([8d1c0db](https://github.com/orbcorp/orb-ruby/commit/8d1c0db96ed1accbe3ff654d1e87bdad7a1d6ad2))
+
 ## [1.43.0](https://github.com/orbcorp/orb-ruby/compare/v1.42.0...v1.43.0) (2026-10-16)
 
 

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.43.0"
+gem "orb-billing", "~> 1.44.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -96,6 +96,11 @@ module Orb
     # @return [Orb::Resources::Items]
     attr_reader :items
 
+    # A webhook endpoint is an HTTPS URL that Orb sends
+    # [webhook events](/integrations-and-exports/webhooks) to.
+    # @return [Orb::Resources::WebhookEndpoints]
+    attr_reader :webhook_endpoints
+
     # The Metric resource represents a calculation of a quantity based on events.
     # Metrics are defined by the query that transforms raw usage events into
     # meaningful values for your customers.
@@ -232,6 +237,7 @@ module Orb
       @invoice_line_items = Orb::Resources::InvoiceLineItems.new(client: self)
       @invoices = Orb::Resources::Invoices.new(client: self)
       @items = Orb::Resources::Items.new(client: self)
+      @webhook_endpoints = Orb::Resources::WebhookEndpoints.new(client: self)
       @metrics = Orb::Resources::Metrics.new(client: self)
       @plans = Orb::Resources::Plans.new(client: self)
       @prices = Orb::Resources::Prices.new(client: self)

data/lib/orb/models/alert_create_for_plan_params.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Alerts#create_for_plan
+    class AlertCreateForPlanParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!attribute plan_id
+      #
+      #   @return [String]
+      required :plan_id, String
+
+      # @!attribute thresholds
+      #   The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @return [Array<Orb::Models::Threshold>]
+      required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
+
+      # @!attribute type
+      #   The type of alert to create. This must be a valid alert type.
+      #
+      #   @return [Symbol, Orb::Models::AlertCreateForPlanParams::Type]
+      required :type, enum: -> { Orb::AlertCreateForPlanParams::Type }
+
+      # @!attribute currency
+      #   The case sensitive currency or custom pricing unit the alert is denominated in.
+      #   Required for spend_exceeded alerts and when grouping_keys is set.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute grouping_keys
+      #   The property keys to group cost alerts by. Only applicable for cost_exceeded
+      #   alerts.
+      #
+      #   @return [Array<String>, nil]
+      optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute metric_id
+      #   The metric to track usage for.
+      #
+      #   @return [String, nil]
+      optional :metric_id, String, nil?: true
+
+      # @!attribute plan_version
+      #   The plan version to create alerts for. If not specified, the default will be the
+      #   plan's active plan version.
+      #
+      #   @return [Integer, nil]
+      optional :plan_version, Integer, nil?: true
+
+      # @!attribute price_filters
+      #   Filters to scope which prices are included in alert evaluation. Supports
+      #   filtering by price_id, item_id, or price_type with includes/excludes operators.
+      #   Only applicable to spend_exceeded alerts and to cost_exceeded alerts with
+      #   grouping_keys set.
+      #
+      #   @return [Array<Orb::Models::AlertCreateForPlanParams::PriceFilter>, nil]
+      optional :price_filters,
+               -> { Orb::Internal::Type::ArrayOf[Orb::AlertCreateForPlanParams::PriceFilter] },
+               nil?: true
+
+      # @!method initialize(plan_id:, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, plan_version: nil, price_filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AlertCreateForPlanParams} for more details.
+      #
+      #   @param plan_id [String]
+      #
+      #   @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
+      #   @param type [Symbol, Orb::Models::AlertCreateForPlanParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      #   @param currency [String, nil] The case sensitive currency or custom pricing unit the alert is denominated in.
+      #
+      #   @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
+      #
+      #   @param metric_id [String, nil] The metric to track usage for.
+      #
+      #   @param plan_version [Integer, nil] The plan version to create alerts for. If not specified, the default will be the
+      #
+      #   @param price_filters [Array<Orb::Models::AlertCreateForPlanParams::PriceFilter>, nil] Filters to scope which prices are included in alert evaluation. Supports filteri
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+
+      # The type of alert to create. This must be a valid alert type.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        USAGE_EXCEEDED = :usage_exceeded
+        COST_EXCEEDED = :cost_exceeded
+        SPEND_EXCEEDED = :spend_exceeded
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class PriceFilter < Orb::Internal::Type::BaseModel
+        # @!attribute field
+        #   The property of the price to filter on.
+        #
+        #   @return [Symbol, Orb::Models::AlertCreateForPlanParams::PriceFilter::Field]
+        required :field, enum: -> { Orb::AlertCreateForPlanParams::PriceFilter::Field }
+
+        # @!attribute operator
+        #   Should prices that match the filter be included or excluded.
+        #
+        #   @return [Symbol, Orb::Models::AlertCreateForPlanParams::PriceFilter::Operator]
+        required :operator, enum: -> { Orb::AlertCreateForPlanParams::PriceFilter::Operator }
+
+        # @!attribute values
+        #   The IDs or values that match this filter.
+        #
+        #   @return [Array<String>]
+        required :values, Orb::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(field:, operator:, values:)
+        #   @param field [Symbol, Orb::Models::AlertCreateForPlanParams::PriceFilter::Field] The property of the price to filter on.
+        #
+        #   @param operator [Symbol, Orb::Models::AlertCreateForPlanParams::PriceFilter::Operator] Should prices that match the filter be included or excluded.
+        #
+        #   @param values [Array<String>] The IDs or values that match this filter.
+
+        # The property of the price to filter on.
+        #
+        # @see Orb::Models::AlertCreateForPlanParams::PriceFilter#field
+        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
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Should prices that match the filter be included or excluded.
+        #
+        # @see Orb::Models::AlertCreateForPlanParams::PriceFilter#operator
+        module Operator
+          extend Orb::Internal::Type::Enum
+
+          INCLUDES = :includes
+          EXCLUDES = :excludes
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/dimensional_price_groups/price_create_params.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      # @see Orb::Resources::DimensionalPriceGroups::Prices#create
+      class PriceCreateParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        # @!attribute dimensional_price_group_id
+        #
+        #   @return [String]
+        required :dimensional_price_group_id, String
+
+        # @!attribute cadence
+        #   Billing cadence for every price
+        #
+        #   @return [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::Cadence]
+        required :cadence, enum: -> { Orb::DimensionalPriceGroups::PriceCreateParams::Cadence }
+
+        # @!attribute currency
+        #   An ISO 4217 currency string for every price.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute item_id
+        #   The item for every price. Must be the group's billable metric item.
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!attribute model_type
+        #
+        #   @return [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::ModelType]
+        required :model_type, enum: -> { Orb::DimensionalPriceGroups::PriceCreateParams::ModelType }
+
+        # @!attribute prices
+        #
+        #   @return [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Price>]
+        required :prices,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::DimensionalPriceGroups::PriceCreateParams::Price] }
+
+        # @!attribute tiers
+        #   Shared tier boundaries. Required for tiered prices and omitted for unit prices.
+        #
+        #   @return [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Tier>, nil]
+        optional :tiers,
+                 -> { Orb::Internal::Type::ArrayOf[Orb::DimensionalPriceGroups::PriceCreateParams::Tier] },
+                 nil?: true
+
+        # @!method initialize(dimensional_price_group_id:, cadence:, currency:, item_id:, model_type:, prices:, tiers: nil, request_options: {})
+        #   @param dimensional_price_group_id [String]
+        #
+        #   @param cadence [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::Cadence] Billing cadence for every price
+        #
+        #   @param currency [String] An ISO 4217 currency string for every price.
+        #
+        #   @param item_id [String] The item for every price. Must be the group's billable metric item.
+        #
+        #   @param model_type [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::ModelType]
+        #
+        #   @param prices [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Price>]
+        #
+        #   @param tiers [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Tier>, nil] Shared tier boundaries. Required for tiered prices and omitted for unit prices.
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+
+        # Billing cadence for every price
+        module Cadence
+          extend Orb::Internal::Type::Enum
+
+          ONE_TIME = :one_time
+          MONTHLY = :monthly
+          QUARTERLY = :quarterly
+          SEMI_ANNUAL = :semi_annual
+          ANNUAL = :annual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module ModelType
+          extend Orb::Internal::Type::Enum
+
+          UNIT = :unit
+          TIERED = :tiered
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Price < Orb::Internal::Type::BaseModel
+          # @!attribute amounts
+          #   One amount for a unit price. One amount per tier for a tiered price, in tier
+          #   order.
+          #
+          #   @return [Array<Float>]
+          required :amounts, Orb::Internal::Type::ArrayOf[Float]
+
+          # @!attribute dimension_values
+          #   Dimension values, in the group's dimension order.
+          #
+          #   @return [Array<String>]
+          required :dimension_values, Orb::Internal::Type::ArrayOf[String]
+
+          # @!attribute name
+          #   Price name. Defaults to the dimension values.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!method initialize(amounts:, dimension_values:, name: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::DimensionalPriceGroups::PriceCreateParams::Price} for more
+          #   details.
+          #
+          #   @param amounts [Array<Float>] One amount for a unit price. One amount per tier for a tiered price, in tier ord
+          #
+          #   @param dimension_values [Array<String>] Dimension values, in the group's dimension order.
+          #
+          #   @param name [String, nil] Price name. Defaults to the dimension values.
+        end
+
+        class Tier < Orb::Internal::Type::BaseModel
+          # @!attribute first_unit
+          #   Exclusive tier starting value
+          #
+          #   @return [Float]
+          required :first_unit, Float
+
+          # @!attribute last_unit
+          #   Inclusive tier ending value. Null on the last tier.
+          #
+          #   @return [Float, nil]
+          optional :last_unit, Float, nil?: true
+
+          # @!method initialize(first_unit:, last_unit: nil)
+          #   @param first_unit [Float] Exclusive tier starting value
+          #
+          #   @param last_unit [Float, nil] Inclusive tier ending value. Null on the last tier.
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/dimensional_price_groups/price_create_response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      # @see Orb::Resources::DimensionalPriceGroups::Prices#create
+      class PriceCreateResponse < Orb::Internal::Type::BaseModel
+        # @!attribute data
+        #   The prices created by this request, in request order.
+        #
+        #   @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>]
+        required :data, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
+
+        # @!method initialize(data:)
+        #   @param data [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>] The prices created by this request, in request order.
+      end
+    end
+  end
+end

data/lib/orb/models/dimensional_price_groups/price_list_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      # @see Orb::Resources::DimensionalPriceGroups::Prices#list
+      class PriceListParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        # @!attribute dimensional_price_group_id
+        #
+        #   @return [String]
+        required :dimensional_price_group_id, String
+
+        # @!attribute cursor
+        #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #   from the initial request.
+        #
+        #   @return [String, nil]
+        optional :cursor, String, nil?: true
+
+        # @!attribute limit
+        #   The number of items to fetch. Defaults to 20.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute status
+        #   active omits archived prices. archived returns only archived prices. all returns
+        #   both.
+        #
+        #   @return [Symbol, Orb::Models::DimensionalPriceGroups::PriceListParams::Status, nil]
+        optional :status, enum: -> { Orb::DimensionalPriceGroups::PriceListParams::Status }
+
+        # @!method initialize(dimensional_price_group_id:, cursor: nil, limit: nil, status: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::DimensionalPriceGroups::PriceListParams} for more details.
+        #
+        #   @param dimensional_price_group_id [String]
+        #
+        #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        #
+        #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
+        #   @param status [Symbol, Orb::Models::DimensionalPriceGroups::PriceListParams::Status] active omits archived prices. archived returns only archived prices. all returns
+        #
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+
+        # active omits archived prices. archived returns only archived prices. all returns
+        # both.
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          ACTIVE = :active
+          ARCHIVED = :archived
+          ALL = :all
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/plan_created_webhook_event.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanCreatedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute plan
+      #
+      #   @return [Orb::Models::PlanCreatedWebhookEvent::Plan]
+      required :plan, -> { Orb::PlanCreatedWebhookEvent::Plan }
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::PlanCreatedWebhookEvent::Type]
+      required :type, enum: -> { Orb::PlanCreatedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, plan:, properties:, type:)
+      #   Issued when a plan is created, or when a draft plan is published.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param plan [Orb::Models::PlanCreatedWebhookEvent::Plan]
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::PlanCreatedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::PlanCreatedWebhookEvent#plan
+      class Plan < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        required :id, String, nil?: true
+
+        # @!attribute external_plan_id
+        #   An optional user-defined ID for this plan resource, used throughout the system
+        #   as an alias for this Plan. Use this field to identify a plan by an existing
+        #   identifier in your system.
+        #
+        #   @return [String, nil]
+        required :external_plan_id, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!method initialize(id:, external_plan_id:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::PlanCreatedWebhookEvent::Plan} for more details.
+        #
+        #   @param id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #
+        #   @param name [String, nil]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::PlanCreatedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        PLAN_CREATED = :"plan.created"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_edited_webhook_event.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanEditedWebhookEvent < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of this webhook event.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The time at which this event was created, to the second.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute plan
+      #   The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #   subscribed to by a customer. Plans define the billing behavior of the
+      #   subscription. You can see more about how to configure prices in the
+      #   [Price resource](/reference/price).
+      #
+      #   @return [Orb::Models::Plan]
+      required :plan, -> { Orb::Plan }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::PlanEditedWebhookEvent::Properties]
+      required :properties, -> { Orb::PlanEditedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::PlanEditedWebhookEvent::Type]
+      required :type, enum: -> { Orb::PlanEditedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, plan:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PlanEditedWebhookEvent} for more details.
+      #
+      #   Issued when a plan's name, description, external plan ID, metadata or status is
+      #   edited.
+      #
+      #   @param id [String] The ID of this webhook event.
+      #
+      #   @param created_at [Time] The time at which this event was created, to the second.
+      #
+      #   @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      #
+      #   @param properties [Orb::Models::PlanEditedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::PlanEditedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::PlanEditedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute previous_attributes
+        #   metadata values are non-null on the wire, as on the price event.
+        #
+        #   @return [Orb::Models::PlanEditedWebhookEvent::Properties::PreviousAttributes]
+        required :previous_attributes, -> { Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes }
+
+        # @!method initialize(previous_attributes:)
+        #   @param previous_attributes [Orb::Models::PlanEditedWebhookEvent::Properties::PreviousAttributes] metadata values are non-null on the wire, as on the price event.
+
+        # @see Orb::Models::PlanEditedWebhookEvent::Properties#previous_attributes
+        class PreviousAttributes < Orb::Internal::Type::BaseModel
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute external_plan_id
+          #
+          #   @return [String, nil]
+          optional :external_plan_id, String, nil?: true
+
+          # @!attribute metadata
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :metadata, Orb::Internal::Type::HashOf[String], nil?: true
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Orb::Models::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status, nil]
+          optional :status,
+                   enum: -> { Orb::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status },
+                   nil?: true
+
+          # @!method initialize(description: nil, external_plan_id: nil, metadata: nil, name: nil, status: nil)
+          #   metadata values are non-null on the wire, as on the price event.
+          #
+          #   @param description [String, nil]
+          #   @param external_plan_id [String, nil]
+          #   @param metadata [Hash{Symbol=>String}, nil]
+          #   @param name [String, nil]
+          #   @param status [Symbol, Orb::Models::PlanEditedWebhookEvent::Properties::PreviousAttributes::Status, nil]
+
+          # @see Orb::Models::PlanEditedWebhookEvent::Properties::PreviousAttributes#status
+          module Status
+            extend Orb::Internal::Type::Enum
+
+            ACTIVE = :active
+            ARCHIVED = :archived
+            DRAFT = :draft
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::PlanEditedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        PLAN_EDITED = :"plan.edited"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end