orb-billing 1.4.0 → 1.5.0

data/rbi/orb/models/credit_note.rbi

@@ -211,6 +211,14 @@ module Orb
         end
         attr_writer :discounts
 
+        # The end time of the service period for this credit note line item.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :end_time_exclusive
+
+        # The start time of the service period for this credit note line item.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :start_time_inclusive
+
         sig do
           params(
             id: String,
@@ -220,7 +228,9 @@ module Orb
             quantity: T.nilable(Float),
             subtotal: String,
             tax_amounts: T::Array[Orb::TaxAmount::OrHash],
-            discounts: T::Array[Orb::CreditNote::LineItem::Discount::OrHash]
+            discounts: T::Array[Orb::CreditNote::LineItem::Discount::OrHash],
+            end_time_exclusive: T.nilable(Time),
+            start_time_inclusive: T.nilable(Time)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -239,7 +249,11 @@ module Orb
           # Any tax amounts applied onto the line item.
           tax_amounts:,
           # Any line item discounts from the invoice's line item.
-          discounts: nil
+          discounts: nil,
+          # The end time of the service period for this credit note line item.
+          end_time_exclusive: nil,
+          # The start time of the service period for this credit note line item.
+          start_time_inclusive: nil
         )
         end
 
@@ -253,7 +267,9 @@ module Orb
               quantity: T.nilable(Float),
               subtotal: String,
               tax_amounts: T::Array[Orb::TaxAmount],
-              discounts: T::Array[Orb::CreditNote::LineItem::Discount]
+              discounts: T::Array[Orb::CreditNote::LineItem::Discount],
+              end_time_exclusive: T.nilable(Time),
+              start_time_inclusive: T.nilable(Time)
             }
           )
         end

data/rbi/orb/models/credit_note_create_params.rbi

@@ -18,15 +18,31 @@ module Orb
       sig { returns(Orb::CreditNoteCreateParams::Reason::OrSymbol) }
       attr_accessor :reason
 
+      # A date string to specify the global credit note service period end date in the
+      # customer's timezone. This will be applied to all line items that don't have
+      # their own individual service periods specified. If not provided, line items will
+      # use their original invoice line item service periods. This date is inclusive.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :end_date
+
       # An optional memo to attach to the credit note.
       sig { returns(T.nilable(String)) }
       attr_accessor :memo
 
+      # A date string to specify the global credit note service period start date in the
+      # customer's timezone. This will be applied to all line items that don't have
+      # their own individual service periods specified. If not provided, line items will
+      # use their original invoice line item service periods. This date is inclusive.
+      sig { returns(T.nilable(Date)) }
+      attr_accessor :start_date
+
       sig do
         params(
           line_items: T::Array[Orb::CreditNoteCreateParams::LineItem::OrHash],
           reason: Orb::CreditNoteCreateParams::Reason::OrSymbol,
+          end_date: T.nilable(Date),
           memo: T.nilable(String),
+          start_date: T.nilable(Date),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -34,8 +50,18 @@ module Orb
         line_items:,
         # An optional reason for the credit note.
         reason:,
+        # A date string to specify the global credit note service period end date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
+        end_date: nil,
         # An optional memo to attach to the credit note.
         memo: nil,
+        # A date string to specify the global credit note service period start date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
+        start_date: nil,
         request_options: {}
       )
       end
@@ -45,7 +71,9 @@ module Orb
           {
             line_items: T::Array[Orb::CreditNoteCreateParams::LineItem],
             reason: Orb::CreditNoteCreateParams::Reason::OrSymbol,
+            end_date: T.nilable(Date),
             memo: T.nilable(String),
+            start_date: T.nilable(Date),
             request_options: Orb::RequestOptions
           }
         )
@@ -67,21 +95,57 @@ module Orb
         sig { returns(String) }
         attr_accessor :invoice_line_item_id
 
+        # A date string to specify this line item's credit note service period end date in
+        # the customer's timezone. If provided, this will be used for this specific line
+        # item. If not provided, will use the global end_date if available, otherwise
+        # defaults to the original invoice line item's end date. This date is inclusive.
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :end_date
+
+        # A date string to specify this line item's credit note service period start date
+        # in the customer's timezone. If provided, this will be used for this specific
+        # line item. If not provided, will use the global start_date if available,
+        # otherwise defaults to the original invoice line item's start date. This date is
+        # inclusive.
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :start_date
+
         sig do
-          params(amount: String, invoice_line_item_id: String).returns(
-            T.attached_class
-          )
+          params(
+            amount: String,
+            invoice_line_item_id: String,
+            end_date: T.nilable(Date),
+            start_date: T.nilable(Date)
+          ).returns(T.attached_class)
         end
         def self.new(
           # The total amount in the invoice's currency to credit this line item.
           amount:,
           # The ID of the line item to credit.
-          invoice_line_item_id:
+          invoice_line_item_id:,
+          # A date string to specify this line item's credit note service period end date in
+          # the customer's timezone. If provided, this will be used for this specific line
+          # item. If not provided, will use the global end_date if available, otherwise
+          # defaults to the original invoice line item's end date. This date is inclusive.
+          end_date: nil,
+          # A date string to specify this line item's credit note service period start date
+          # in the customer's timezone. If provided, this will be used for this specific
+          # line item. If not provided, will use the global start_date if available,
+          # otherwise defaults to the original invoice line item's start date. This date is
+          # inclusive.
+          start_date: nil
         )
         end
 
         sig do
-          override.returns({ amount: String, invoice_line_item_id: String })
+          override.returns(
+            {
+              amount: String,
+              invoice_line_item_id: String,
+              end_date: T.nilable(Date),
+              start_date: T.nilable(Date)
+            }
+          )
         end
         def to_hash
         end

data/rbi/orb/models/events/backfill_create_params.rbi

@@ -13,13 +13,13 @@ module Orb
           end
 
         # The (exclusive) end of the usage timeframe affected by this backfill. By
-        # default, Orb allows backfills up to 10 days in duration at a time. Reach out to
+        # default, Orb allows backfills up to 31 days in duration at a time. Reach out to
         # discuss extending this limit and your use case.
         sig { returns(Time) }
         attr_accessor :timeframe_end
 
         # The (inclusive) start of the usage timeframe affected by this backfill. By
-        # default, Orb allows backfills up to 10 days in duration at a time. Reach out to
+        # default, Orb allows backfills up to 31 days in duration at a time. Reach out to
         # discuss extending this limit and your use case.
         sig { returns(Time) }
         attr_accessor :timeframe_start
@@ -68,11 +68,11 @@ module Orb
         end
         def self.new(
           # The (exclusive) end of the usage timeframe affected by this backfill. By
-          # default, Orb allows backfills up to 10 days in duration at a time. Reach out to
+          # default, Orb allows backfills up to 31 days in duration at a time. Reach out to
           # discuss extending this limit and your use case.
           timeframe_end:,
           # The (inclusive) start of the usage timeframe affected by this backfill. By
-          # default, Orb allows backfills up to 10 days in duration at a time. Reach out to
+          # default, Orb allows backfills up to 31 days in duration at a time. Reach out to
           # discuss extending this limit and your use case.
           timeframe_start:,
           # The time at which no more events will be accepted for this backfill. The

data/rbi/orb/models/mutated_subscription.rbi

@@ -87,7 +87,8 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :default_invoice_memo
 
-      # The discount intervals for this subscription sorted by the start_date.
+      # The discount intervals for this subscription sorted by the start_date. This
+      # field is deprecated in favor of `adjustment_intervals`.
       sig do
         returns(T::Array[Orb::MutatedSubscription::DiscountInterval::Variants])
       end
@@ -103,7 +104,8 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :invoicing_threshold
 
-      # The maximum intervals for this subscription sorted by the start_date.
+      # The maximum intervals for this subscription sorted by the start_date. This field
+      # is deprecated in favor of `adjustment_intervals`.
       sig { returns(T::Array[Orb::MaximumInterval]) }
       attr_accessor :maximum_intervals
 
@@ -114,7 +116,8 @@ module Orb
       sig { returns(T::Hash[Symbol, String]) }
       attr_accessor :metadata
 
-      # The minimum intervals for this subscription sorted by the start_date.
+      # The minimum intervals for this subscription sorted by the start_date. This field
+      # is deprecated in favor of `adjustment_intervals`.
       sig { returns(T::Array[Orb::MinimumInterval]) }
       attr_accessor :minimum_intervals
 
@@ -282,20 +285,23 @@ module Orb
         # Determines the default memo on this subscriptions' invoices. Note that if this
         # is not provided, it is determined by the plan configuration.
         default_invoice_memo:,
-        # The discount intervals for this subscription sorted by the start_date.
+        # The discount intervals for this subscription sorted by the start_date. This
+        # field is deprecated in favor of `adjustment_intervals`.
         discount_intervals:,
         # The date Orb stops billing for this subscription.
         end_date:,
         fixed_fee_quantity_schedule:,
         invoicing_threshold:,
-        # The maximum intervals for this subscription sorted by the start_date.
+        # The maximum intervals for this subscription sorted by the start_date. This field
+        # is deprecated in favor of `adjustment_intervals`.
         maximum_intervals:,
         # 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`.
         metadata:,
-        # The minimum intervals for this subscription sorted by the start_date.
+        # The minimum intervals for this subscription sorted by the start_date. This field
+        # is deprecated in favor of `adjustment_intervals`.
         minimum_intervals:,
         # The name of the subscription.
         name:,

data/rbi/orb/models/price_evaluate_multiple_params.rbi

@@ -94,6 +94,10 @@ module Orb
             )
           end
 
+        # The external ID of a price to evaluate that exists in your Orb account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_price_id
+
         # A boolean
         # [computed property](/extensibility/advanced-metrics#computed-properties) used to
         # filter the underlying billable metric
@@ -155,6 +159,7 @@ module Orb
 
         sig do
           params(
+            external_price_id: T.nilable(String),
             filter: T.nilable(String),
             grouping_keys: T::Array[String],
             price:
@@ -194,6 +199,8 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          # The external ID of a price to evaluate that exists in your Orb account.
+          external_price_id: nil,
           # A boolean
           # [computed property](/extensibility/advanced-metrics#computed-properties) used to
           # filter the underlying billable metric
@@ -213,6 +220,7 @@ module Orb
         sig do
           override.returns(
             {
+              external_price_id: T.nilable(String),
               filter: T.nilable(String),
               grouping_keys: T::Array[String],
               price:

data/rbi/orb/models/price_evaluate_multiple_response.rbi

@@ -50,6 +50,10 @@ module Orb
         sig { returns(T::Array[Orb::EvaluatePriceGroup]) }
         attr_accessor :price_groups
 
+        # The external ID of the price
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_price_id
+
         # The index of the inline price
         sig { returns(T.nilable(Integer)) }
         attr_accessor :inline_price_index
@@ -62,6 +66,7 @@ module Orb
           params(
             currency: String,
             price_groups: T::Array[Orb::EvaluatePriceGroup::OrHash],
+            external_price_id: T.nilable(String),
             inline_price_index: T.nilable(Integer),
             price_id: T.nilable(String)
           ).returns(T.attached_class)
@@ -71,6 +76,8 @@ module Orb
           currency:,
           # The computed price groups associated with input price.
           price_groups:,
+          # The external ID of the price
+          external_price_id: nil,
           # The index of the inline price
           inline_price_index: nil,
           # The ID of the price
@@ -83,6 +90,7 @@ module Orb
             {
               currency: String,
               price_groups: T::Array[Orb::EvaluatePriceGroup],
+              external_price_id: T.nilable(String),
               inline_price_index: T.nilable(Integer),
               price_id: T.nilable(String)
             }

data/rbi/orb/models/price_evaluate_preview_events_params.rbi

@@ -195,6 +195,10 @@ module Orb
             )
           end
 
+        # The external ID of a price to evaluate that exists in your Orb account.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_price_id
+
         # A boolean
         # [computed property](/extensibility/advanced-metrics#computed-properties) used to
         # filter the underlying billable metric
@@ -256,6 +260,7 @@ module Orb
 
         sig do
           params(
+            external_price_id: T.nilable(String),
             filter: T.nilable(String),
             grouping_keys: T::Array[String],
             price:
@@ -295,6 +300,8 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
+          # The external ID of a price to evaluate that exists in your Orb account.
+          external_price_id: nil,
           # A boolean
           # [computed property](/extensibility/advanced-metrics#computed-properties) used to
           # filter the underlying billable metric
@@ -314,6 +321,7 @@ module Orb
         sig do
           override.returns(
             {
+              external_price_id: T.nilable(String),
               filter: T.nilable(String),
               grouping_keys: T::Array[String],
               price:

data/rbi/orb/models/price_evaluate_preview_events_response.rbi

@@ -55,6 +55,10 @@ module Orb
         sig { returns(T::Array[Orb::EvaluatePriceGroup]) }
         attr_accessor :price_groups
 
+        # The external ID of the price
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_price_id
+
         # The index of the inline price
         sig { returns(T.nilable(Integer)) }
         attr_accessor :inline_price_index
@@ -67,6 +71,7 @@ module Orb
           params(
             currency: String,
             price_groups: T::Array[Orb::EvaluatePriceGroup::OrHash],
+            external_price_id: T.nilable(String),
             inline_price_index: T.nilable(Integer),
             price_id: T.nilable(String)
           ).returns(T.attached_class)
@@ -76,6 +81,8 @@ module Orb
           currency:,
           # The computed price groups associated with input price.
           price_groups:,
+          # The external ID of the price
+          external_price_id: nil,
           # The index of the inline price
           inline_price_index: nil,
           # The ID of the price
@@ -88,6 +95,7 @@ module Orb
             {
               currency: String,
               price_groups: T::Array[Orb::EvaluatePriceGroup],
+              external_price_id: T.nilable(String),
               inline_price_index: T.nilable(Integer),
               price_id: T.nilable(String)
             }

data/rbi/orb/models/subscription.rbi

@@ -86,7 +86,8 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :default_invoice_memo
 
-      # The discount intervals for this subscription sorted by the start_date.
+      # The discount intervals for this subscription sorted by the start_date. This
+      # field is deprecated in favor of `adjustment_intervals`.
       sig { returns(T::Array[Orb::Subscription::DiscountInterval::Variants]) }
       attr_accessor :discount_intervals
 
@@ -100,7 +101,8 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :invoicing_threshold
 
-      # The maximum intervals for this subscription sorted by the start_date.
+      # The maximum intervals for this subscription sorted by the start_date. This field
+      # is deprecated in favor of `adjustment_intervals`.
       sig { returns(T::Array[Orb::MaximumInterval]) }
       attr_accessor :maximum_intervals
 
@@ -111,7 +113,8 @@ module Orb
       sig { returns(T::Hash[Symbol, String]) }
       attr_accessor :metadata
 
-      # The minimum intervals for this subscription sorted by the start_date.
+      # The minimum intervals for this subscription sorted by the start_date. This field
+      # is deprecated in favor of `adjustment_intervals`.
       sig { returns(T::Array[Orb::MinimumInterval]) }
       attr_accessor :minimum_intervals
 
@@ -282,20 +285,23 @@ module Orb
         # Determines the default memo on this subscriptions' invoices. Note that if this
         # is not provided, it is determined by the plan configuration.
         default_invoice_memo:,
-        # The discount intervals for this subscription sorted by the start_date.
+        # The discount intervals for this subscription sorted by the start_date. This
+        # field is deprecated in favor of `adjustment_intervals`.
         discount_intervals:,
         # The date Orb stops billing for this subscription.
         end_date:,
         fixed_fee_quantity_schedule:,
         invoicing_threshold:,
-        # The maximum intervals for this subscription sorted by the start_date.
+        # The maximum intervals for this subscription sorted by the start_date. This field
+        # is deprecated in favor of `adjustment_intervals`.
         maximum_intervals:,
         # 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`.
         metadata:,
-        # The minimum intervals for this subscription sorted by the start_date.
+        # The minimum intervals for this subscription sorted by the start_date. This field
+        # is deprecated in favor of `adjustment_intervals`.
         minimum_intervals:,
         # The name of the subscription.
         name:,

data/rbi/orb/models/subscription_price_intervals_params.rbi

@@ -888,8 +888,8 @@ module Orb
         sig { returns(T.nilable(Integer)) }
         attr_accessor :billing_cycle_day
 
-        # The updated end date of this price interval. If not specified, the start date
-        # will not be updated.
+        # The updated end date of this price interval. If not specified, the end date will
+        # not be updated.
         sig do
           returns(
             T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
@@ -967,8 +967,8 @@ module Orb
           # billing cycle day will not be updated. Note that overlapping price intervals
           # must have the same billing cycle day.
           billing_cycle_day: nil,
-          # The updated end date of this price interval. If not specified, the start date
-          # will not be updated.
+          # The updated end date of this price interval. If not specified, the end date will
+          # not be updated.
           end_date: nil,
           # An additional filter to apply to usage queries. This filter must be expressed as
           # a boolean
@@ -1014,8 +1014,8 @@ module Orb
         def to_hash
         end
 
-        # The updated end date of this price interval. If not specified, the start date
-        # will not be updated.
+        # The updated end date of this price interval. If not specified, the end date will
+        # not be updated.
         module EndDate
           extend Orb::Internal::Type::Union
 
@@ -1105,8 +1105,8 @@ module Orb
         sig { returns(String) }
         attr_accessor :adjustment_interval_id
 
-        # The updated end date of this adjustment interval. If not specified, the start
-        # date will not be updated.
+        # The updated end date of this adjustment interval. If not specified, the end date
+        # will not be updated.
         sig do
           returns(
             T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
@@ -1141,8 +1141,8 @@ module Orb
         def self.new(
           # The id of the adjustment interval to edit.
           adjustment_interval_id:,
-          # The updated end date of this adjustment interval. If not specified, the start
-          # date will not be updated.
+          # The updated end date of this adjustment interval. If not specified, the end date
+          # will not be updated.
           end_date: nil,
           # The updated start date of this adjustment interval. If not specified, the start
           # date will not be updated.
@@ -1163,8 +1163,8 @@ module Orb
         def to_hash
         end
 
-        # The updated end date of this adjustment interval. If not specified, the start
-        # date will not be updated.
+        # The updated end date of this adjustment interval. If not specified, the end date
+        # will not be updated.
         module EndDate
           extend Orb::Internal::Type::Union
 

data/rbi/orb/resources/credit_notes.rbi

@@ -5,11 +5,38 @@ module Orb
     class CreditNotes
       # This endpoint is used to create a single
       # [`Credit Note`](/invoicing/credit-notes).
+      #
+      # The credit note service period configuration supports two explicit modes:
+      #
+      # 1. Global service periods: Specify start_date and end_date at the credit note
+      #    level. These dates will be applied to all line items uniformly.
+      #
+      # 2. Individual service periods: Specify start_date and end_date for each line
+      #    item. When using this mode, ALL line items must have individual periods
+      #    specified.
+      #
+      # 3. Default behavior: If no service periods are specified (neither global nor
+      #    individual), the original invoice line item service periods will be used.
+      #
+      # Note: Mixing global and individual service periods in the same request is not
+      # allowed to prevent confusion.
+      #
+      # Service period dates are normalized to the start of the day in the customer's
+      # timezone to ensure consistent handling across different timezones.
+      #
+      # Date Format: Use start_date and end_date with format "YYYY-MM-DD" (e.g.,
+      # "2023-09-22") to match other Orb APIs like /v1/invoice_line_items.
+      #
+      # Note: Both start_date and end_date are inclusive - the service period will cover
+      # both the start date and end date completely (from start of start_date to end of
+      # end_date).
       sig do
         params(
           line_items: T::Array[Orb::CreditNoteCreateParams::LineItem::OrHash],
           reason: Orb::CreditNoteCreateParams::Reason::OrSymbol,
+          end_date: T.nilable(Date),
           memo: T.nilable(String),
+          start_date: T.nilable(Date),
           request_options: Orb::RequestOptions::OrHash
         ).returns(Orb::CreditNote)
       end
@@ -17,8 +44,18 @@ module Orb
         line_items:,
         # An optional reason for the credit note.
         reason:,
+        # A date string to specify the global credit note service period end date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
+        end_date: nil,
         # An optional memo to attach to the credit note.
         memo: nil,
+        # A date string to specify the global credit note service period start date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
+        start_date: nil,
         request_options: {}
       )
       end

data/rbi/orb/resources/customers/costs.rbi

@@ -57,17 +57,17 @@ module Orb
         #
         # A customer that uses a few API calls a day but has a minimum commitment might
         # exhibit the following pattern for their subtotal and total in the first few days
-        # of the month. Here, we assume that each API call is $2.50, the customer's plan
-        # has a monthly minimum of $50 for this price, and that the subscription's billing
-        # period bounds are aligned to the first of the month:
+        # of the month. Here, we assume that each API call is \$2.50, the customer's plan
+        # has a monthly minimum of \$50 for this price, and that the subscription's
+        # billing period bounds are aligned to the first of the month:
         #
         # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) |
         # | --------------- | ------------- | ---------------- | -------- | ------------------------ |
-        # | 2023-02-01      | 2023-02-02    | 9                | $22.50   | $50.00                   |
-        # | 2023-02-01      | 2023-02-03    | 19               | $47.50   | $50.00                   |
-        # | 2023-02-01      | 2023-02-04    | 20               | $50.00   | $50.00                   |
-        # | 2023-02-01      | 2023-02-05    | 28               | $70.00   | $70.00                   |
-        # | 2023-02-01      | 2023-02-06    | 36               | $90.00   | $90.00                   |
+        # | 2023-02-01      | 2023-02-02    | 9                | \$22.50  | \$50.00                  |
+        # | 2023-02-01      | 2023-02-03    | 19               | \$47.50  | \$50.00                  |
+        # | 2023-02-01      | 2023-02-04    | 20               | \$50.00  | \$50.00                  |
+        # | 2023-02-01      | 2023-02-05    | 28               | \$70.00  | \$70.00                  |
+        # | 2023-02-01      | 2023-02-06    | 36               | \$90.00  | \$90.00                  |
         #
         # ### Periodic values
         #
@@ -202,17 +202,17 @@ module Orb
         #
         # A customer that uses a few API calls a day but has a minimum commitment might
         # exhibit the following pattern for their subtotal and total in the first few days
-        # of the month. Here, we assume that each API call is $2.50, the customer's plan
-        # has a monthly minimum of $50 for this price, and that the subscription's billing
-        # period bounds are aligned to the first of the month:
+        # of the month. Here, we assume that each API call is \$2.50, the customer's plan
+        # has a monthly minimum of \$50 for this price, and that the subscription's
+        # billing period bounds are aligned to the first of the month:
         #
         # | timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) |
         # | --------------- | ------------- | ---------------- | -------- | ------------------------ |
-        # | 2023-02-01      | 2023-02-02    | 9                | $22.50   | $50.00                   |
-        # | 2023-02-01      | 2023-02-03    | 19               | $47.50   | $50.00                   |
-        # | 2023-02-01      | 2023-02-04    | 20               | $50.00   | $50.00                   |
-        # | 2023-02-01      | 2023-02-05    | 28               | $70.00   | $70.00                   |
-        # | 2023-02-01      | 2023-02-06    | 36               | $90.00   | $90.00                   |
+        # | 2023-02-01      | 2023-02-02    | 9                | \$22.50  | \$50.00                  |
+        # | 2023-02-01      | 2023-02-03    | 19               | \$47.50  | \$50.00                  |
+        # | 2023-02-01      | 2023-02-04    | 20               | \$50.00  | \$50.00                  |
+        # | 2023-02-01      | 2023-02-05    | 28               | \$70.00  | \$70.00                  |
+        # | 2023-02-01      | 2023-02-06    | 36               | \$90.00  | \$90.00                  |
         #
         # ### Periodic values
         #

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

@@ -43,8 +43,8 @@ module Orb
           # deductions take place from a non-expiring credit block.
           #
           # If there are multiple blocks with the same expiration date, Orb will deduct from
-          # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost
-          # basis before paid credits with a $5.00 cost basis).
+          # the block with the _lower cost basis_ first (e.g. trial credits with a \$0 cost
+          # basis before paid credits with a \$5.00 cost basis).
           #
           # It's also possible for a single usage event's deduction to _span_ credit blocks.
           # In this case, Orb will deduct from the next block, ending at the credit block
@@ -528,8 +528,8 @@ module Orb
           # deductions take place from a non-expiring credit block.
           #
           # If there are multiple blocks with the same expiration date, Orb will deduct from
-          # the block with the _lower cost basis_ first (e.g. trial credits with a $0 cost
-          # basis before paid credits with a $5.00 cost basis).
+          # the block with the _lower cost basis_ first (e.g. trial credits with a \$0 cost
+          # basis before paid credits with a \$5.00 cost basis).
           #
           # It's also possible for a single usage event's deduction to _span_ credit blocks.
           # In this case, Orb will deduct from the next block, ending at the credit block