orb-billing 1.46.0 → 1.47.0

data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi

@@ -45,10 +45,8 @@ module Orb
       end
       attr_writer :properties
 
-      # A lightweight subscription representation for webhook payloads.
-      #
-      # This avoids the expensive to_subscription_params() call required for full
-      # serialization.
+      # The subscription in a license or grouped cost webhook payload: its status,
+      # dates, plan and customer.
       sig do
         returns(
           Orb::SubscriptionLicenseBalanceThresholdReachedWebhookEvent::Subscription
@@ -98,10 +96,8 @@ module Orb
         # Every license that crossed a threshold for one alert, batched into a single
         # message. For account-wide alerts the licenses may span several license types.
         properties:,
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         subscription:,
         # The event this payload describes.
         type:
@@ -1152,10 +1148,8 @@ module Orb
         end
         attr_accessor :status
 
-        # A lightweight subscription representation for webhook payloads.
-        #
-        # This avoids the expensive to_subscription_params() call required for full
-        # serialization.
+        # The subscription in a license or grouped cost webhook payload: its status,
+        # dates, plan and customer.
         sig do
           params(
             id: String,

data/rbi/orb/models/webhook_endpoint.rbi

@@ -23,6 +23,13 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      sig { returns(Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol) }
+      attr_accessor :payload_style
+
       # The HTTPS URL that Orb sends webhook events to.
       sig { returns(String) }
       attr_accessor :url
@@ -35,6 +42,7 @@ module Orb
           created_at: Time,
           enabled: T::Boolean,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style: Orb::WebhookEndpoint::PayloadStyle::OrSymbol,
           url: String
         ).returns(T.attached_class)
       end
@@ -48,6 +56,11 @@ module Orb
         # The webhook event types sent to this endpoint. If null, all event types are
         # sent.
         enabled_event_types:,
+        # The payload style of the webhook events sent to this endpoint. `standard`
+        # payloads include each object's own fields and references to related objects,
+        # without invoice line items or subscription price intervals. `expanded` payloads
+        # include every object fully expanded.
+        payload_style:,
         # The HTTPS URL that Orb sends webhook events to.
         url:
       )
@@ -60,12 +73,38 @@ module Orb
             created_at: Time,
             enabled: T::Boolean,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style: Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol,
             url: String
           }
         )
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::WebhookEndpoint::PayloadStyle) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(:expanded, Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol)
+        STANDARD =
+          T.let(:standard, Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Orb::WebhookEndpoint::PayloadStyle::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/webhook_endpoint_create_params.rbi

@@ -20,10 +20,21 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. If omitted or
+      # null, the account's default style is used.
+      sig do
+        returns(
+          T.nilable(Orb::WebhookEndpointCreateParams::PayloadStyle::OrSymbol)
+        )
+      end
+      attr_accessor :payload_style
+
       sig do
         params(
           url: String,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style:
+            T.nilable(Orb::WebhookEndpointCreateParams::PayloadStyle::OrSymbol),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -33,6 +44,9 @@ module Orb
         # The webhook event types to send to this endpoint. If omitted or null, all event
         # types are sent.
         enabled_event_types: nil,
+        # The payload style of the webhook events sent to this endpoint. If omitted or
+        # null, the account's default style is used.
+        payload_style: nil,
         request_options: {}
       )
       end
@@ -42,12 +56,49 @@ module Orb
           {
             url: String,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style:
+              T.nilable(
+                Orb::WebhookEndpointCreateParams::PayloadStyle::OrSymbol
+              ),
             request_options: Orb::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. If omitted or
+      # null, the account's default style is used.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::WebhookEndpointCreateParams::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::WebhookEndpointCreateParams::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::WebhookEndpointCreateParams::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::WebhookEndpointCreateParams::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/webhook_endpoint_update_params.rbi

@@ -19,6 +19,15 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. Applies to events
+      # created after the change; omit to leave it unchanged.
+      sig do
+        returns(
+          T.nilable(Orb::WebhookEndpointUpdateParams::PayloadStyle::OrSymbol)
+        )
+      end
+      attr_accessor :payload_style
+
       # The HTTPS URL that Orb sends webhook events to.
       sig { returns(T.nilable(String)) }
       attr_accessor :url
@@ -27,6 +36,8 @@ module Orb
         params(
           webhook_endpoint_id: String,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style:
+            T.nilable(Orb::WebhookEndpointUpdateParams::PayloadStyle::OrSymbol),
           url: T.nilable(String),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -36,6 +47,9 @@ module Orb
         # The webhook event types to send to this endpoint. Null sends all event types;
         # omit to leave them unchanged.
         enabled_event_types: nil,
+        # The payload style of the webhook events sent to this endpoint. Applies to events
+        # created after the change; omit to leave it unchanged.
+        payload_style: nil,
         # The HTTPS URL that Orb sends webhook events to.
         url: nil,
         request_options: {}
@@ -47,6 +61,10 @@ module Orb
           {
             webhook_endpoint_id: String,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style:
+              T.nilable(
+                Orb::WebhookEndpointUpdateParams::PayloadStyle::OrSymbol
+              ),
             url: T.nilable(String),
             request_options: Orb::RequestOptions
           }
@@ -54,6 +72,39 @@ module Orb
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. Applies to events
+      # created after the change; omit to leave it unchanged.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::WebhookEndpointUpdateParams::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::WebhookEndpointUpdateParams::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::WebhookEndpointUpdateParams::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Orb::WebhookEndpointUpdateParams::PayloadStyle::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/webhook_endpoint_with_secret.rbi

@@ -25,6 +25,15 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :enabled_event_types
 
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      sig do
+        returns(Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol)
+      end
+      attr_accessor :payload_style
+
       # The secret used to sign the webhook events sent to this endpoint. Only returned
       # when the endpoint is created.
       sig { returns(String) }
@@ -42,6 +51,7 @@ module Orb
           created_at: Time,
           enabled: T::Boolean,
           enabled_event_types: T.nilable(T::Array[String]),
+          payload_style: Orb::WebhookEndpointWithSecret::PayloadStyle::OrSymbol,
           secret: String,
           url: String
         ).returns(T.attached_class)
@@ -56,6 +66,11 @@ module Orb
         # The webhook event types sent to this endpoint. If null, all event types are
         # sent.
         enabled_event_types:,
+        # The payload style of the webhook events sent to this endpoint. `standard`
+        # payloads include each object's own fields and references to related objects,
+        # without invoice line items or subscription price intervals. `expanded` payloads
+        # include every object fully expanded.
+        payload_style:,
         # The secret used to sign the webhook events sent to this endpoint. Only returned
         # when the endpoint is created.
         secret:,
@@ -71,6 +86,8 @@ module Orb
             created_at: Time,
             enabled: T::Boolean,
             enabled_event_types: T.nilable(T::Array[String]),
+            payload_style:
+              Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol,
             secret: String,
             url: String
           }
@@ -78,6 +95,39 @@ module Orb
       end
       def to_hash
       end
+
+      # The payload style of the webhook events sent to this endpoint. `standard`
+      # payloads include each object's own fields and references to related objects,
+      # without invoice line items or subscription price intervals. `expanded` payloads
+      # include every object fully expanded.
+      module PayloadStyle
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Orb::WebhookEndpointWithSecret::PayloadStyle)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EXPANDED =
+          T.let(
+            :expanded,
+            Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol
+          )
+        STANDARD =
+          T.let(
+            :standard,
+            Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::WebhookEndpointWithSecret::PayloadStyle::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi

@@ -35,7 +35,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice
@@ -106,7 +107,8 @@ module Orb
           accounting_sync_record:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -653,7 +655,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi

@@ -35,7 +35,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice
@@ -106,7 +107,8 @@ module Orb
           accounting_sync_record:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -653,7 +655,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -488,7 +490,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -488,7 +490,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -488,7 +490,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -488,7 +490,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(Orb::Webhooks::InvoiceEditedStandardWebhookEvent::Invoice)
         end
@@ -84,7 +85,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -484,7 +486,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceIssueFailedStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -488,7 +490,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(Orb::Webhooks::InvoiceIssuedStandardWebhookEvent::Invoice)
         end
@@ -84,7 +85,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -484,7 +486,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,

data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi

@@ -20,7 +20,8 @@ module Orb
         sig { returns(Time) }
         attr_accessor :created_at
 
-        # #InvoiceApiResourceWithoutLineItems
+        # An invoice without its line items, subtotal, discounts, minimums or maximums.
+        # Fetch the invoice for those.
         sig do
           returns(
             Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice
@@ -89,7 +90,8 @@ module Orb
           id:,
           # The time at which this event was created, to the second.
           created_at:,
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           invoice:,
           # The serialization style this payload was rendered in, as configured on the
           # endpoint.
@@ -489,7 +491,8 @@ module Orb
           sig { returns(T::Boolean) }
           attr_accessor :will_auto_issue
 
-          # #InvoiceApiResourceWithoutLineItems
+          # An invoice without its line items, subtotal, discounts, minimums or maximums.
+          # Fetch the invoice for those.
           sig do
             params(
               id: String,