orb-billing 1.43.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5dc40a201faac67ea9e72b07425ff535bee8c7963fb6eb92d3ba2e5bc224034
-  data.tar.gz: f895167c6a7d1f9333e90ff8cbecff8e29728b4154d91312b9ebfbd26ee77678
+  metadata.gz: 06c0074b0a16a37c4a6ddeb4fb2ef718479c621bd78268d964f5949167e9cd68
+  data.tar.gz: 779cf49681b6d3791724aaed878a536062beb6b065535501f62e1cbe2dddb6cb
 SHA512:
-  metadata.gz: 00aefa80fd013628e189a38423ce551e8e4efffde14221d9532eaef6830287d0ac51e2b878d1c5ef4f7d7057b3f9f27a9627b9c3fc03a70afd72e7f644b124ff
-  data.tar.gz: ee6b01f1ef20639b49d8bbacb86da21eb4441d4a6ece28aa4324f4e8a1437dd35394ad909dc7c812c493ca60283e583b551354499d8ab00f0fde0cdc0f52776a
+  metadata.gz: a29cd78e8c652ec6af4658ef68a1943401a9e2ed2d86f7acccb956bfcf0055f13dfece6568a1610d9e73da7049391a41035a0e28f35a1fc1dbe879811121fe76
+  data.tar.gz: '0681fe7130768ec32ffa151706102b023385e6303cb91fd1a70530ce239a838ef55cae74db86f1f749e985e38988e79d99cc942c39919dc5b1ce15771c96daa8'

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.45.0](https://github.com/orbcorp/orb-ruby/compare/v1.44.0...v1.45.0) (2026-10-21)
+
+
+### Features
+
+* **api:** api update ([bf20672](https://github.com/orbcorp/orb-ruby/commit/bf206724a957f94ca650009dfc18879d47d1ec53))
+
+## [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.45.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/backfill_reflected_webhook_event.rb

@@ -22,6 +22,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::BackfillReflectedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::BackfillReflectedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Object]
@@ -33,7 +40,7 @@ module Orb
       #   @return [Symbol, Orb::Models::BackfillReflectedWebhookEvent::Type]
       required :type, enum: -> { Orb::BackfillReflectedWebhookEvent::Type }
 
-      # @!method initialize(id:, backfill:, created_at:, properties:, type:)
+      # @!method initialize(id:, backfill:, created_at:, payload_style:, properties:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::BackfillReflectedWebhookEvent} for more details.
       #
@@ -45,6 +52,8 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::BackfillReflectedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Object]
       #
       #   @param type [Symbol, Orb::Models::BackfillReflectedWebhookEvent::Type] The event this payload describes.
@@ -164,6 +173,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::BackfillReflectedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The event this payload describes.
       #
       # @see Orb::Models::BackfillReflectedWebhookEvent#type

data/lib/orb/models/backfill_reverted_webhook_event.rb

@@ -22,6 +22,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::BackfillRevertedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::BackfillRevertedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Object]
@@ -33,7 +40,7 @@ module Orb
       #   @return [Symbol, Orb::Models::BackfillRevertedWebhookEvent::Type]
       required :type, enum: -> { Orb::BackfillRevertedWebhookEvent::Type }
 
-      # @!method initialize(id:, backfill:, created_at:, properties:, type:)
+      # @!method initialize(id:, backfill:, created_at:, payload_style:, properties:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::BackfillRevertedWebhookEvent} for more details.
       #
@@ -45,6 +52,8 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::BackfillRevertedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Object]
       #
       #   @param type [Symbol, Orb::Models::BackfillRevertedWebhookEvent::Type] The event this payload describes.
@@ -164,6 +173,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::BackfillRevertedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The event this payload describes.
       #
       # @see Orb::Models::BackfillRevertedWebhookEvent#type

data/lib/orb/models/billable_metric_edited_webhook_event.rb

@@ -23,6 +23,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::BillableMetricEditedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::BillableMetricEditedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::BillableMetricEditedWebhookEvent::Properties]
@@ -34,7 +41,7 @@ module Orb
       #   @return [Symbol, Orb::Models::BillableMetricEditedWebhookEvent::Type]
       required :type, enum: -> { Orb::BillableMetricEditedWebhookEvent::Type }
 
-      # @!method initialize(id:, billable_metric:, created_at:, properties:, type:)
+      # @!method initialize(id:, billable_metric:, created_at:, payload_style:, properties:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::BillableMetricEditedWebhookEvent} for more details.
       #
@@ -46,10 +53,26 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::BillableMetricEditedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::BillableMetricEditedWebhookEvent::Properties]
       #
       #   @param type [Symbol, Orb::Models::BillableMetricEditedWebhookEvent::Type] The event this payload describes.
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::BillableMetricEditedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::BillableMetricEditedWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute previous_attributes

data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb

@@ -27,6 +27,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent::Properties]
@@ -38,7 +45,10 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent::Type]
       required :type, enum: -> { Orb::CreditBlockAccountingSyncFailedWebhookEvent::Type }
 
-      # @!method initialize(id:, accounting_sync_record:, block:, created_at:, properties:, type:)
+      # @!method initialize(id:, accounting_sync_record:, block:, created_at:, payload_style:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent} for more details.
+      #
       #   Issued when a credit block accounting sync fails.
       #
       #   @param id [String] The ID of this webhook event.
@@ -49,6 +59,8 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent::Properties]
       #
       #   @param type [Symbol, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
@@ -466,6 +478,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute connection_type

data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb

@@ -27,6 +27,13 @@ module Orb
       #   @return [Time]
       required :created_at, Time
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Properties]
@@ -38,7 +45,10 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Type]
       required :type, enum: -> { Orb::CreditBlockAccountingSyncSucceededWebhookEvent::Type }
 
-      # @!method initialize(id:, accounting_sync_record:, block:, created_at:, properties:, type:)
+      # @!method initialize(id:, accounting_sync_record:, block:, created_at:, payload_style:, properties:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent} for more details.
+      #
       #   Issued when a credit block accounting sync succeeds.
       #
       #   @param id [String] The ID of this webhook event.
@@ -49,6 +59,8 @@ module Orb
       #
       #   @param created_at [Time] The time at which this event was created, to the second.
       #
+      #   @param payload_style [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Properties]
       #
       #   @param type [Symbol, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
@@ -467,6 +479,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute connection_type

data/lib/orb/models/credit_note_accounting_sync_failed_webhook_event.rb

@@ -28,6 +28,13 @@ module Orb
       #   @return [Orb::Models::CreditNote]
       required :credit_note, -> { Orb::CreditNote }
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::CreditNoteAccountingSyncFailedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Properties]
@@ -39,7 +46,7 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Type]
       required :type, enum: -> { Orb::CreditNoteAccountingSyncFailedWebhookEvent::Type }
 
-      # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, properties:, type:)
+      # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, payload_style:, properties:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent} for more details.
       #
@@ -53,6 +60,8 @@ module Orb
       #
       #   @param credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
       #
+      #   @param payload_style [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Properties]
       #
       #   @param type [Symbol, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
@@ -128,6 +137,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute connection_type

data/lib/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rb

@@ -28,6 +28,13 @@ module Orb
       #   @return [Orb::Models::CreditNote]
       required :credit_note, -> { Orb::CreditNote }
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::CreditNoteAccountingSyncSucceededWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Properties]
@@ -39,7 +46,7 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Type]
       required :type, enum: -> { Orb::CreditNoteAccountingSyncSucceededWebhookEvent::Type }
 
-      # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, properties:, type:)
+      # @!method initialize(id:, accounting_sync_record:, created_at:, credit_note:, payload_style:, properties:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent} for more details.
       #
@@ -53,6 +60,8 @@ module Orb
       #
       #   @param credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
       #
+      #   @param payload_style [Symbol, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Properties]
       #
       #   @param type [Symbol, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
@@ -128,6 +137,20 @@ module Orb
         end
       end
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # @see Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent#properties
       class Properties < Orb::Internal::Type::BaseModel
         # @!attribute connection_type

data/lib/orb/models/credit_note_issued_webhook_event.rb

@@ -22,6 +22,13 @@ module Orb
       #   @return [Orb::Models::CreditNote]
       required :credit_note, -> { Orb::CreditNote }
 
+      # @!attribute payload_style
+      #   The serialization style this payload was rendered in, as configured on the
+      #   endpoint.
+      #
+      #   @return [Symbol, Orb::Models::CreditNoteIssuedWebhookEvent::PayloadStyle]
+      required :payload_style, enum: -> { Orb::CreditNoteIssuedWebhookEvent::PayloadStyle }
+
       # @!attribute properties
       #
       #   @return [Object]
@@ -33,7 +40,7 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditNoteIssuedWebhookEvent::Type]
       required :type, enum: -> { Orb::CreditNoteIssuedWebhookEvent::Type }
 
-      # @!method initialize(id:, created_at:, credit_note:, properties:, type:)
+      # @!method initialize(id:, created_at:, credit_note:, payload_style:, properties:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::CreditNoteIssuedWebhookEvent} for more details.
       #
@@ -45,10 +52,26 @@ module Orb
       #
       #   @param credit_note [Orb::Models::CreditNote] The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
       #
+      #   @param payload_style [Symbol, Orb::Models::CreditNoteIssuedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
+      #
       #   @param properties [Object]
       #
       #   @param type [Symbol, Orb::Models::CreditNoteIssuedWebhookEvent::Type] The event this payload describes.
 
+      # The serialization style this payload was rendered in, as configured on the
+      # endpoint.
+      #
+      # @see Orb::Models::CreditNoteIssuedWebhookEvent#payload_style
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        EXPANDED = :expanded
+        STANDARD = :standard
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       # The event this payload describes.
       #
       # @see Orb::Models::CreditNoteIssuedWebhookEvent#type