orb-billing 1.48.0 → 1.50.0

data/lib/orb/models/subscription_list_summary_response.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#list_summary
+    class SubscriptionListSummaryResponse < Orb::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute customer
+      #
+      #   @return [Orb::Models::CustomerMinified]
+      required :customer, -> { Orb::CustomerMinified }
+
+      # @!attribute end_date
+      #   The date Orb stops billing for this subscription.
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #   to an empty dictionary. Individual keys can be removed by setting the value to
+      #   `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #   `null`.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Orb::Internal::Type::HashOf[String]
+
+      # @!attribute name
+      #   The name of the subscription.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute plan
+      #
+      #   @return [Orb::Models::SubscriptionListSummaryResponse::Plan, nil]
+      required :plan, -> { Orb::Models::SubscriptionListSummaryResponse::Plan }, nil?: true
+
+      # @!attribute start_date
+      #   The date Orb starts billing for this subscription.
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionListSummaryResponse::Status]
+      required :status, enum: -> { Orb::Models::SubscriptionListSummaryResponse::Status }
+
+      # @!method initialize(id:, created_at:, customer:, end_date:, metadata:, name:, plan:, start_date:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionListSummaryResponse} for more details.
+      #
+      #   A subscription's own fields, with its plan and customer as references, as listed
+      #   by List subscription summaries and carried in standard webhook payloads. Fetch
+      #   the subscription for its price intervals, billing periods, plan phases and other
+      #   derived fields.
+      #
+      #   @param id [String]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param customer [Orb::Models::CustomerMinified]
+      #
+      #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #
+      #   @param name [String] The name of the subscription.
+      #
+      #   @param plan [Orb::Models::SubscriptionListSummaryResponse::Plan, nil]
+      #
+      #   @param start_date [Time] The date Orb starts billing for this subscription.
+      #
+      #   @param status [Symbol, Orb::Models::SubscriptionListSummaryResponse::Status]
+
+      # @see Orb::Models::SubscriptionListSummaryResponse#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::SubscriptionListSummaryResponse::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::SubscriptionListSummaryResponse#status
+      module Status
+        extend Orb::Internal::Type::Enum
+
+        ACTIVE = :active
+        ENDED = :ended
+        UPCOMING = :upcoming
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb

@@ -474,6 +474,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -518,7 +534,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice}
           #   for more details.
@@ -580,6 +596,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb

@@ -474,6 +474,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -518,7 +534,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice}
           #   for more details.
@@ -580,6 +596,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb

@@ -395,6 +395,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -439,7 +455,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice}
           #   for more details.
@@ -501,6 +517,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb

@@ -395,6 +395,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -439,7 +455,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent::Invoice}
           #   for more details.
@@ -501,6 +517,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb

@@ -395,6 +395,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -439,7 +455,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent::Invoice}
           #   for more details.
@@ -501,6 +517,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb

@@ -396,6 +396,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -440,7 +456,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent::Invoice}
           #   for more details.
@@ -502,6 +518,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb

@@ -393,6 +393,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -436,7 +452,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceEditedStandardWebhookEvent::Invoice} for more
           #   details.
@@ -498,6 +514,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceEditedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb

@@ -394,6 +394,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -437,7 +453,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceIssueFailedStandardWebhookEvent::Invoice} for
           #   more details.
@@ -499,6 +515,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceIssueFailedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb

@@ -393,6 +393,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -436,7 +452,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceIssuedStandardWebhookEvent::Invoice} for more
           #   details.
@@ -498,6 +514,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceIssuedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb

@@ -396,6 +396,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -439,7 +455,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice} for
           #   more details.
@@ -501,6 +517,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb

@@ -395,6 +395,22 @@ module Orb
           #   @return [Time, nil]
           required :scheduled_issue_at, Time, nil?: true
 
+          # @!attribute service_period_end
+          #   The latest `end_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_end, Time, nil?: true
+
+          # @!attribute service_period_start
+          #   The earliest `start_date` of the invoice's line items, including any line items
+          #   hidden because they have zero quantity. This is `null` when the invoice has no
+          #   line items.
+          #
+          #   @return [Time, nil]
+          required :service_period_start, Time, nil?: true
+
           # @!attribute shipping_address
           #
           #   @return [Orb::Models::Address, nil]
@@ -439,7 +455,7 @@ module Orb
           #   @return [Boolean]
           required :will_auto_issue, Orb::Internal::Type::Boolean
 
-          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
+          # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, service_period_end:, service_period_start:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
           #   Some parameter documentations has been truncated, see
           #   {Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice}
           #   for more details.
@@ -501,6 +517,10 @@ module Orb
           #
           #   @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
           #
+          #   @param service_period_end [Time, nil] The latest `end_date` of the invoice's line items, including any line items hidd
+          #
+          #   @param service_period_start [Time, nil] The earliest `start_date` of the invoice's line items, including any line items
+          #
           #   @param shipping_address [Orb::Models::Address, nil]
           #
           #   @param status [Symbol, Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice::Status]