orb-billing 1.49.0 → 1.51.0

data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi

@@ -433,6 +433,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -518,6 +530,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -748,6 +762,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -807,6 +829,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi

@@ -448,6 +448,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -533,6 +545,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -763,6 +777,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -822,6 +844,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi

@@ -450,6 +450,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -535,6 +547,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -765,6 +779,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -824,6 +846,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi

@@ -445,6 +445,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -530,6 +542,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -760,6 +774,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -819,6 +841,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi

@@ -447,6 +447,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -532,6 +544,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -762,6 +776,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -821,6 +843,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi

@@ -433,6 +433,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -518,6 +530,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -748,6 +762,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -807,6 +829,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi

@@ -612,6 +612,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -697,6 +709,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -927,6 +941,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -986,6 +1008,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi

@@ -612,6 +612,18 @@ module Orb
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_issue_at
 
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_end
+
+          # 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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :service_period_start
+
           sig { returns(T.nilable(Orb::Address)) }
           attr_reader :shipping_address
 
@@ -697,6 +709,8 @@ module Orb
               payment_received_at: T.nilable(Time),
               payment_started_at: T.nilable(Time),
               scheduled_issue_at: T.nilable(Time),
+              service_period_end: T.nilable(Time),
+              service_period_start: T.nilable(Time),
               shipping_address: T.nilable(Orb::Address::OrHash),
               status:
                 Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::OrSymbol,
@@ -927,6 +941,14 @@ module Orb
             # If the invoice is in draft, this timestamp will reflect when the invoice is
             # scheduled to be issued.
             scheduled_issue_at:,
+            # 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.
+            service_period_end:,
+            # 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.
+            service_period_start:,
             shipping_address:,
             status:,
             subscription:,
@@ -986,6 +1008,8 @@ module Orb
                 payment_received_at: T.nilable(Time),
                 payment_started_at: T.nilable(Time),
                 scheduled_issue_at: T.nilable(Time),
+                service_period_end: T.nilable(Time),
+                service_period_start: T.nilable(Time),
                 shipping_address: T.nilable(Orb::Address),
                 status:
                   Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol,

data/rbi/orb/resources/customers/credits.rbi

@@ -64,6 +64,66 @@ 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`.
+        sig do
+          params(
+            customer_id: String,
+            currency: T.nilable(String),
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Models::Customers::CreditFetchBalanceResponse)
+        end
+        def fetch_balance(
+          customer_id,
+          # The ledger currency or custom pricing unit to use.
+          currency: nil,
+          request_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`.
+        sig do
+          params(
+            external_customer_id: String,
+            currency: T.nilable(String),
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(
+            Orb::Models::Customers::CreditFetchBalanceByExternalIDResponse
+          )
+        end
+        def fetch_balance_by_external_id(
+          external_customer_id,
+          # The ledger currency or custom pricing unit to use.
+          currency: nil,
+          request_options: {}
+        )
+        end
+
         # Returns a paginated list of unexpired, non-zero credit blocks for a customer.
         #
         # If `include_all_blocks` is set to `true`, all credit blocks (including expired

data/sig/orb/models/changed_subscription_resources.rbs

@@ -69,6 +69,8 @@ module Orb
           payment_received_at: Time?,
           payment_started_at: Time?,
           scheduled_issue_at: Time?,
+          service_period_end: Time?,
+          service_period_start: Time?,
           shipping_address: Orb::Address?,
           status: Orb::Models::ChangedSubscriptionResources::CreatedInvoice::status,
           subscription: Orb::SubscriptionMinified?,
@@ -152,6 +154,10 @@ module Orb
 
         attr_accessor scheduled_issue_at: Time?
 
+        attr_accessor service_period_end: Time?
+
+        attr_accessor service_period_start: Time?
+
         attr_accessor shipping_address: Orb::Address?
 
         attr_accessor status: Orb::Models::ChangedSubscriptionResources::CreatedInvoice::status
@@ -205,6 +211,8 @@ module Orb
           payment_received_at: Time?,
           payment_started_at: Time?,
           scheduled_issue_at: Time?,
+          service_period_end: Time?,
+          service_period_start: Time?,
           shipping_address: Orb::Address?,
           status: Orb::Models::ChangedSubscriptionResources::CreatedInvoice::status,
           subscription: Orb::SubscriptionMinified?,
@@ -252,6 +260,8 @@ module Orb
           payment_received_at: Time?,
           payment_started_at: Time?,
           scheduled_issue_at: Time?,
+          service_period_end: Time?,
+          service_period_start: Time?,
           shipping_address: Orb::Address?,
           status: Orb::Models::ChangedSubscriptionResources::CreatedInvoice::status,
           subscription: Orb::SubscriptionMinified?,

data/sig/orb/models/customers/credit_fetch_balance_by_external_id_params.rbs

@@ -0,0 +1,30 @@
+module Orb
+  module Models
+    module Customers
+      type credit_fetch_balance_by_external_id_params =
+        { external_customer_id: String, currency: String? }
+        & Orb::Internal::Type::request_parameters
+
+      class CreditFetchBalanceByExternalIDParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        attr_accessor external_customer_id: String
+
+        attr_accessor currency: String?
+
+        def initialize: (
+          external_customer_id: String,
+          ?currency: String?,
+          ?request_options: Orb::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          external_customer_id: String,
+          currency: String?,
+          request_options: Orb::RequestOptions
+        }
+      end
+    end
+  end
+end