orb-billing 1.35.0 → 1.36.0

data/lib/orb/models/invoice_undo_mark_as_paid_webhook_event.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class InvoiceUndoMarkAsPaidWebhookEvent < 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 invoice
+      #   An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+      #   representing the request for payment for a single subscription. This includes a
+      #   set of line items, which correspond to prices in the subscription's plan and can
+      #   represent fixed recurring fees or usage-based fees. They are generated at the
+      #   end of a billing period, or as the result of an action, such as a cancellation.
+      #
+      #   @return [Orb::Models::Invoice]
+      required :invoice, -> { Orb::Invoice }
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent::Type]
+      required :type, enum: -> { Orb::InvoiceUndoMarkAsPaidWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, invoice:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent} for more details.
+      #
+      #   Issued when an invoice is undone from marked as paid.
+      #
+      #   @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 invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent::Type] The event this payload describes.
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        INVOICE_UNDO_MARK_AS_PAID = :"invoice.undo_mark_as_paid"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/metric_events_dropped_by_watermark_webhook_event.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class MetricEventsDroppedByWatermarkWebhookEvent < 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 properties
+      #   `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
+      #   untyped message called `.isoformat()` on them, so they keep microseconds where
+      #   the webhook JSON provider would have truncated them.
+      #
+      #   @return [Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Properties]
+      required :properties, -> { Orb::MetricEventsDroppedByWatermarkWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Type]
+      required :type, enum: -> { Orb::MetricEventsDroppedByWatermarkWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent} for more details.
+      #
+      #   Issued when metric events are dropped by watermark threshold.
+      #
+      #   @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 properties [Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Properties] `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
+      #
+      #   @param type [Symbol, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute dropped
+        #
+        #   @return [Integer]
+        required :dropped, Integer
+
+        # @!attribute event_name
+        #
+        #   @return [String]
+        required :event_name, String
+
+        # @!attribute total
+        #
+        #   @return [Integer]
+        required :total, Integer
+
+        # @!attribute window_end
+        #
+        #   @return [String]
+        required :window_end, String
+
+        # @!attribute window_start
+        #
+        #   @return [String]
+        required :window_start, String
+
+        # @!method initialize(dropped:, event_name:, total:, window_end:, window_start:)
+        #   `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
+        #   untyped message called `.isoformat()` on them, so they keep microseconds where
+        #   the webhook JSON provider would have truncated them.
+        #
+        #   @param dropped [Integer]
+        #   @param event_name [String]
+        #   @param total [Integer]
+        #   @param window_end [String]
+        #   @param window_start [String]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        METRIC_EVENTS_DROPPED_BY_WATERMARK = :"metric.events_dropped_by_watermark"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/payment_method_created_webhook_event.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PaymentMethodCreatedWebhookEvent < 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 payment_method
+      #   A payment method represents a customer's stored payment instrument held with an
+      #   external payment provider (such as Adyen or Stripe).
+      #
+      #   The serialization is intentionally minimal for now; provider-pulled details
+      #   (e.g. card display metadata) will be added over time.
+      #
+      #   @return [Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod]
+      required :payment_method, -> { Orb::PaymentMethodCreatedWebhookEvent::PaymentMethod }
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::Type]
+      required :type, enum: -> { Orb::PaymentMethodCreatedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, payment_method:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PaymentMethodCreatedWebhookEvent} for more details.
+      #
+      #   Issued when a payment method is created.
+      #
+      #   @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 payment_method [Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod] A payment method represents a customer's stored payment instrument held with an
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::PaymentMethodCreatedWebhookEvent#payment_method
+      class PaymentMethod < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The Orb-assigned unique identifier for the payment method.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The time at which the payment method was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute customer_id
+        #   The ID of the Orb customer this payment method is attached to.
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute default
+        #   Whether this is the customer's default payment method.
+        #
+        #   @return [Boolean]
+        required :default, Orb::Internal::Type::Boolean
+
+        # @!attribute external_payment_method_id
+        #   The identifier of this payment method in the external payment provider.
+        #
+        #   @return [String]
+        required :external_payment_method_id, String
+
+        # @!attribute payment_method_type
+        #   The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        #
+        #   @return [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod::PaymentMethodType]
+        required :payment_method_type,
+                 enum: -> { Orb::PaymentMethodCreatedWebhookEvent::PaymentMethod::PaymentMethodType }
+
+        # @!attribute provider_type
+        #   The external payment provider this method belongs to, derived from the linked
+        #   payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+        #   has been removed.
+        #
+        #   @return [String, nil]
+        required :provider_type, String, nil?: true
+
+        # @!method initialize(id:, created_at:, customer_id:, default:, external_payment_method_id:, payment_method_type:, provider_type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod} for more details.
+        #
+        #   A payment method represents a customer's stored payment instrument held with an
+        #   external payment provider (such as Adyen or Stripe).
+        #
+        #   The serialization is intentionally minimal for now; provider-pulled details
+        #   (e.g. card display metadata) will be added over time.
+        #
+        #   @param id [String] The Orb-assigned unique identifier for the payment method.
+        #
+        #   @param created_at [Time] The time at which the payment method was created.
+        #
+        #   @param customer_id [String] The ID of the Orb customer this payment method is attached to.
+        #
+        #   @param default [Boolean] Whether this is the customer's default payment method.
+        #
+        #   @param external_payment_method_id [String] The identifier of this payment method in the external payment provider.
+        #
+        #   @param payment_method_type [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod::PaymentMethodType] The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        #
+        #   @param provider_type [String, nil] The external payment provider this method belongs to, derived from the linked pa
+
+        # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        #
+        # @see Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod#payment_method_type
+        module PaymentMethodType
+          extend Orb::Internal::Type::Enum
+
+          CARD = :card
+          US_BANK_ACCOUNT = :us_bank_account
+          LINK = :link
+          AMAZON_PAY = :amazon_pay
+          CRYPTO = :crypto
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::PaymentMethodCreatedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        PAYMENT_METHOD_CREATED = :"payment_method.created"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/payment_method_deleted_webhook_event.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PaymentMethodDeletedWebhookEvent < 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 payment_method
+      #   A payment method represents a customer's stored payment instrument held with an
+      #   external payment provider (such as Adyen or Stripe).
+      #
+      #   The serialization is intentionally minimal for now; provider-pulled details
+      #   (e.g. card display metadata) will be added over time.
+      #
+      #   @return [Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod]
+      required :payment_method, -> { Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod }
+
+      # @!attribute properties
+      #
+      #   @return [Object]
+      required :properties, Orb::Internal::Type::Unknown
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::Type]
+      required :type, enum: -> { Orb::PaymentMethodDeletedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, payment_method:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::PaymentMethodDeletedWebhookEvent} for more details.
+      #
+      #   Issued when a payment method is deleted.
+      #
+      #   @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 payment_method [Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod] A payment method represents a customer's stored payment instrument held with an
+      #
+      #   @param properties [Object]
+      #
+      #   @param type [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::PaymentMethodDeletedWebhookEvent#payment_method
+      class PaymentMethod < Orb::Internal::Type::BaseModel
+        # @!attribute id
+        #   The Orb-assigned unique identifier for the payment method.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   The time at which the payment method was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute customer_id
+        #   The ID of the Orb customer this payment method is attached to.
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute default
+        #   Whether this is the customer's default payment method.
+        #
+        #   @return [Boolean]
+        required :default, Orb::Internal::Type::Boolean
+
+        # @!attribute external_payment_method_id
+        #   The identifier of this payment method in the external payment provider.
+        #
+        #   @return [String]
+        required :external_payment_method_id, String
+
+        # @!attribute payment_method_type
+        #   The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        #
+        #   @return [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType]
+        required :payment_method_type,
+                 enum: -> { Orb::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType }
+
+        # @!attribute provider_type
+        #   The external payment provider this method belongs to, derived from the linked
+        #   payment gateway connection (e.g. `adyen` or `stripe`). Null if the connection
+        #   has been removed.
+        #
+        #   @return [String, nil]
+        required :provider_type, String, nil?: true
+
+        # @!method initialize(id:, created_at:, customer_id:, default:, external_payment_method_id:, payment_method_type:, provider_type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod} for more details.
+        #
+        #   A payment method represents a customer's stored payment instrument held with an
+        #   external payment provider (such as Adyen or Stripe).
+        #
+        #   The serialization is intentionally minimal for now; provider-pulled details
+        #   (e.g. card display metadata) will be added over time.
+        #
+        #   @param id [String] The Orb-assigned unique identifier for the payment method.
+        #
+        #   @param created_at [Time] The time at which the payment method was created.
+        #
+        #   @param customer_id [String] The ID of the Orb customer this payment method is attached to.
+        #
+        #   @param default [Boolean] Whether this is the customer's default payment method.
+        #
+        #   @param external_payment_method_id [String] The identifier of this payment method in the external payment provider.
+        #
+        #   @param payment_method_type [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod::PaymentMethodType] The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        #
+        #   @param provider_type [String, nil] The external payment provider this method belongs to, derived from the linked pa
+
+        # The type of the underlying payment instrument, e.g. `card` or `us_bank_account`.
+        #
+        # @see Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod#payment_method_type
+        module PaymentMethodType
+          extend Orb::Internal::Type::Enum
+
+          CARD = :card
+          US_BANK_ACCOUNT = :us_bank_account
+          LINK = :link
+          AMAZON_PAY = :amazon_pay
+          CRYPTO = :crypto
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::PaymentMethodDeletedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        PAYMENT_METHOD_DELETED = :"payment_method.deleted"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_default_version_set_webhook_event.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanDefaultVersionSetWebhookEvent < 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::PlanDefaultVersionSetWebhookEvent::Plan]
+      required :plan, -> { Orb::PlanDefaultVersionSetWebhookEvent::Plan }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::PlanDefaultVersionSetWebhookEvent::Properties]
+      required :properties, -> { Orb::PlanDefaultVersionSetWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::PlanDefaultVersionSetWebhookEvent::Type]
+      required :type, enum: -> { Orb::PlanDefaultVersionSetWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, plan:, properties:, type:)
+      #   Issued when a plan's default version is set.
+      #
+      #   @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::PlanDefaultVersionSetWebhookEvent::Plan]
+      #
+      #   @param properties [Orb::Models::PlanDefaultVersionSetWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::PlanDefaultVersionSetWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::PlanDefaultVersionSetWebhookEvent#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::PlanDefaultVersionSetWebhookEvent::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
+
+      # @see Orb::Models::PlanDefaultVersionSetWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute new_default_version_number
+        #
+        #   @return [Integer]
+        required :new_default_version_number, Integer
+
+        # @!attribute previous_default_version_number
+        #
+        #   @return [Integer]
+        required :previous_default_version_number, Integer
+
+        # @!method initialize(new_default_version_number:, previous_default_version_number:)
+        #   @param new_default_version_number [Integer]
+        #   @param previous_default_version_number [Integer]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::PlanDefaultVersionSetWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        PLAN_DEFAULT_VERSION_SET = :"plan.default_version_set"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/plan_version_created_webhook_event.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class PlanVersionCreatedWebhookEvent < 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::PlanVersionCreatedWebhookEvent::Plan]
+      required :plan, -> { Orb::PlanVersionCreatedWebhookEvent::Plan }
+
+      # @!attribute properties
+      #
+      #   @return [Orb::Models::PlanVersionCreatedWebhookEvent::Properties]
+      required :properties, -> { Orb::PlanVersionCreatedWebhookEvent::Properties }
+
+      # @!attribute type
+      #   The event this payload describes.
+      #
+      #   @return [Symbol, Orb::Models::PlanVersionCreatedWebhookEvent::Type]
+      required :type, enum: -> { Orb::PlanVersionCreatedWebhookEvent::Type }
+
+      # @!method initialize(id:, created_at:, plan:, properties:, type:)
+      #   Issued when a new plan version is created.
+      #
+      #   @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::PlanVersionCreatedWebhookEvent::Plan]
+      #
+      #   @param properties [Orb::Models::PlanVersionCreatedWebhookEvent::Properties]
+      #
+      #   @param type [Symbol, Orb::Models::PlanVersionCreatedWebhookEvent::Type] The event this payload describes.
+
+      # @see Orb::Models::PlanVersionCreatedWebhookEvent#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::PlanVersionCreatedWebhookEvent::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
+
+      # @see Orb::Models::PlanVersionCreatedWebhookEvent#properties
+      class Properties < Orb::Internal::Type::BaseModel
+        # @!attribute plan_version_description
+        #
+        #   @return [String, nil]
+        required :plan_version_description, String, nil?: true
+
+        # @!attribute plan_version_number
+        #
+        #   @return [Integer]
+        required :plan_version_number, Integer
+
+        # @!method initialize(plan_version_description:, plan_version_number:)
+        #   @param plan_version_description [String, nil]
+        #   @param plan_version_number [Integer]
+      end
+
+      # The event this payload describes.
+      #
+      # @see Orb::Models::PlanVersionCreatedWebhookEvent#type
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        PLAN_VERSION_CREATED = :"plan.version_created"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end