orb-billing 1.48.0 → 1.50.0

data/lib/orb/models/webhooks/invoice_manually_marked_as_void_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::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::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::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_payment_failed_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::InvoicePaymentFailedStandardWebhookEvent::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::InvoicePaymentFailedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_payment_processing_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::InvoicePaymentProcessingStandardWebhookEvent::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::InvoicePaymentProcessingStandardWebhookEvent::Invoice::Status]

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

@@ -397,6 +397,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::InvoicePaymentSucceededStandardWebhookEvent::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::InvoicePaymentSucceededStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_sync_failed_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::InvoiceSyncFailedStandardWebhookEvent::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::InvoiceSyncFailedStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_sync_succeeded_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]
@@ -438,7 +454,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::InvoiceSyncSucceededStandardWebhookEvent::Invoice} for
           #   more details.
@@ -500,6 +516,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::InvoiceSyncSucceededStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/invoice_undo_mark_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]
@@ -438,7 +454,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::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice} for
           #   more details.
@@ -500,6 +516,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::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice::Status]

data/lib/orb/models/webhooks/sales_order_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::SalesOrderAccountingSyncFailedStandardWebhookEvent::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::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status]

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

@@ -475,6 +475,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]
@@ -519,7 +535,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::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice}
           #   for more details.
@@ -581,6 +597,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::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice::Status]

data/lib/orb/models.rb

@@ -751,6 +751,8 @@ module Orb
 
   SubscriptionListParams = Orb::Models::SubscriptionListParams
 
+  SubscriptionListSummaryParams = Orb::Models::SubscriptionListSummaryParams
+
   SubscriptionMinified = Orb::Models::SubscriptionMinified
 
   SubscriptionPlanChangedWebhookEvent = Orb::Models::SubscriptionPlanChangedWebhookEvent

data/lib/orb/resources/alerts.rb

@@ -233,8 +233,9 @@ module Orb
       # before invoice-level adjustments and credits) denominated in the alert's
       # currency exceeds predefined thresholds during the current billing cycle;
       # `price_filters` can scope which prices contribute. Each plan can have one
-      # `cost_exceeded` alert and one `usage_exceeded` alert per metric that is a part
-      # of the plan.
+      # `cost_exceeded` alert, one `usage_exceeded` alert per metric that is a part of
+      # the plan, and up to 50 `spend_exceeded` alerts, one per combination of currency
+      # and `price_filters`, so separate products can each have their own spend alert.
       #
       # @overload create_for_plan(plan_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, plan_version: nil, price_filters: nil, request_options: {})
       #
@@ -285,8 +286,10 @@ module Orb
       # spend (the pricing subtotal, before invoice-level adjustments and credits)
       # denominated in the alert's currency exceeds predefined thresholds during the
       # current billing cycle; `price_filters` can scope which prices contribute. Each
-      # subscription can have one `cost_exceeded` alert and one `usage_exceeded` alert
-      # per metric that is a part of the subscription.
+      # subscription can have one `cost_exceeded` alert, one `usage_exceeded` alert per
+      # metric that is a part of the subscription, and up to 50 `spend_exceeded` alerts,
+      # one per combination of currency and `price_filters`, so separate products can
+      # each have their own spend alert.
       #
       # @overload create_for_subscription(subscription_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, price_filters: nil, threshold_overrides: nil, request_options: {})
       #

data/lib/orb/resources/customers/credits.rb

@@ -75,6 +75,82 @@ module Orb
           )
         end
 
+        # This endpoint returns a customer's credit balance in a single currency or custom
+        # pricing unit: the total available balance, the balance waiting on payment, and
+        # the next upcoming expiration.
+        #
+        # `balance` is the sum of `balance` across the customer's `active` credit blocks,
+        # as listed by
+        # [Fetch customer credit balance](/api-reference/credit/fetch-customer-credit-balance).
+        # Expired, depleted, and voided blocks are not included. Blocks in
+        # `pending_payment` status are totaled in `pending_payment_balance` instead, and
+        # become available once their invoice is paid.
+        #
+        # Note that `currency` defaults to credits if not specified. To use a real world
+        # currency, set `currency` to an ISO 4217 string. A customer with no credits in
+        # that currency returns a balance of `0`.
+        #
+        # @overload fetch_balance(customer_id, currency: nil, request_options: {})
+        #
+        # @param customer_id [String]
+        #
+        # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Customers::CreditFetchBalanceResponse]
+        #
+        # @see Orb::Models::Customers::CreditFetchBalanceParams
+        def fetch_balance(customer_id, params = {})
+          parsed, options = Orb::Customers::CreditFetchBalanceParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["customers/%1$s/credits/balance", customer_id],
+            query: query,
+            model: Orb::Models::Customers::CreditFetchBalanceResponse,
+            options: options
+          )
+        end
+
+        # This endpoint returns a customer's credit balance in a single currency or custom
+        # pricing unit: the total available balance, the balance waiting on payment, and
+        # the next upcoming expiration.
+        #
+        # `balance` is the sum of `balance` across the customer's `active` credit blocks,
+        # as listed by
+        # [Fetch customer credit balance](/api-reference/credit/fetch-customer-credit-balance).
+        # Expired, depleted, and voided blocks are not included. Blocks in
+        # `pending_payment` status are totaled in `pending_payment_balance` instead, and
+        # become available once their invoice is paid.
+        #
+        # Note that `currency` defaults to credits if not specified. To use a real world
+        # currency, set `currency` to an ISO 4217 string. A customer with no credits in
+        # that currency returns a balance of `0`.
+        #
+        # @overload fetch_balance_by_external_id(external_customer_id, currency: nil, request_options: {})
+        #
+        # @param external_customer_id [String]
+        #
+        # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+        #
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse]
+        #
+        # @see Orb::Models::Customers::CreditFetchBalanceByExternalIDParams
+        def fetch_balance_by_external_id(external_customer_id, params = {})
+          parsed, options = Orb::Customers::CreditFetchBalanceByExternalIDParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["customers/external_customer_id/%1$s/credits/balance", external_customer_id],
+            query: query,
+            model: Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Customers::CreditListByExternalIDParams} for more details.
         #

data/lib/orb/resources/subscriptions.rb

@@ -897,6 +897,66 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::SubscriptionListSummaryParams} for more details.
+      #
+      # This is a lighter-weight version of
+      # [List subscriptions](/api-reference/subscription/list-subscriptions), with the
+      # same filters, pagination and order. It returns each subscription's own fields,
+      # with its plan and customer as references, and leaves out price intervals,
+      # billing periods, plan phases and other derived fields, making it faster to
+      # respond. Fetch a subscription for those.
+      #
+      # This is the same summary of a subscription that standard
+      # [webhook payloads](/integrations-and-exports/webhook-payload-styles) carry.
+      #
+      # @overload list_summary(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, external_plan_id: nil, limit: nil, plan_id: nil, status: nil, request_options: {})
+      #
+      # @param created_at_gt [Time, nil]
+      #
+      # @param created_at_gte [Time, nil]
+      #
+      # @param created_at_lt [Time, nil]
+      #
+      # @param created_at_lte [Time, nil]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #
+      # @param customer_id [String, nil]
+      #
+      # @param external_customer_id [String, nil]
+      #
+      # @param external_plan_id [String, nil]
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param plan_id [String, nil]
+      #
+      # @param status [Symbol, Orb::Models::SubscriptionListSummaryParams::Status, nil]
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Internal::Page<Orb::Models::SubscriptionListSummaryResponse>]
+      #
+      # @see Orb::Models::SubscriptionListSummaryParams
+      def list_summary(params = {})
+        parsed, options = Orb::SubscriptionListSummaryParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "subscriptions/summary",
+          query: query.transform_keys(
+            created_at_gt: "created_at[gt]",
+            created_at_gte: "created_at[gte]",
+            created_at_lt: "created_at[lt]",
+            created_at_lte: "created_at[lte]"
+          ),
+          page: Orb::Internal::Page,
+          model: Orb::Models::SubscriptionListSummaryResponse,
+          options: options
+        )
+      end
+
       # Some parameter documentations has been truncated, see
       # {Orb::Models::SubscriptionPriceIntervalsParams} for more details.
       #

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.48.0"
+  VERSION = "1.50.0"
 end

data/lib/orb.rb

@@ -147,6 +147,10 @@ require_relative "orb/models/customers/cost_list_by_external_id_params"
 require_relative "orb/models/customers/cost_list_by_external_id_response"
 require_relative "orb/models/customers/cost_list_params"
 require_relative "orb/models/customers/cost_list_response"
+require_relative "orb/models/customers/credit_fetch_balance_by_external_id_params"
+require_relative "orb/models/customers/credit_fetch_balance_by_external_id_response"
+require_relative "orb/models/customers/credit_fetch_balance_params"
+require_relative "orb/models/customers/credit_fetch_balance_response"
 require_relative "orb/models/customers/credit_list_by_external_id_params"
 require_relative "orb/models/customers/credit_list_by_external_id_response"
 require_relative "orb/models/customers/credit_list_params"
@@ -495,6 +499,8 @@ require_relative "orb/models/subscription_invoicing_threshold_exceeded_webhook_e
 require_relative "orb/models/subscription_license_allocation_reset_webhook_event"
 require_relative "orb/models/subscription_license_balance_threshold_reached_webhook_event"
 require_relative "orb/models/subscription_list_params"
+require_relative "orb/models/subscription_list_summary_params"
+require_relative "orb/models/subscription_list_summary_response"
 require_relative "orb/models/subscription_minified"
 require_relative "orb/models/subscription_plan_changed_webhook_event"
 require_relative "orb/models/subscription_plan_change_scheduled_webhook_event"