orb-billing 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7f25205b033d46508378764f840f594c62acb9f46a6bb989f0ea20d177bf2b
-  data.tar.gz: 598f87e26fab3f0b3e9edeb2e2667429c88895c632e3e7c54e6f52dfdf76d6b4
+  metadata.gz: ee6b80e95c43c4a91835db318552bc9cf30795f853bb35d18a7a47f4b2bc4b98
+  data.tar.gz: c32cd239fd0486f158503b5228a38bd78fa7f75feca50955436e71205bdca207
 SHA512:
-  metadata.gz: '087918f6d861957f73c7d09be955a1f6096d97771b862266aa161f0884c18f7630facb1a94dea52d2106ec54bd17c9a87e2abca5a5f75a07ccdb9132574cd932'
-  data.tar.gz: c4f7448384c68735ec92d6a72e8bd667b535b8116db52c3a00fa83a0439317114e3812ad3ebe77be02f1ab56579ccd5033fecca764851a04b40a66e5877d45c0
+  metadata.gz: e7d87f338f886d159c571a2ce196fd2ab85f9f1a6e43c24f17f16f809f7de3c0e8784e7ff72cab0415b50f55e8f13529d2409742836d3381e5626ee86034a322
+  data.tar.gz: 0fbd5eb4c79d4b8e5f98b10cb310dbaf1c90ff4e5b1ec6d9a31867156d536b3c0a20dc1505027e7f668e0a177cfca1048225c86022b92f723c14d91482605a8d

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.5.0 (2025-07-16)
+
+Full Changelog: [v1.4.0...v1.5.0](https://github.com/orbcorp/orb-ruby/compare/v1.4.0...v1.5.0)
+
+### Features
+
+* **api:** api update ([6babc11](https://github.com/orbcorp/orb-ruby/commit/6babc11fcfb50389ab5139351ef28d14a5a08cab))
+
+
+### Chores
+
+* **internal:** version bump ([acea921](https://github.com/orbcorp/orb-ruby/commit/acea9216388dc9412559385cd17ab64787780568))
+
 ## 1.4.0 (2025-07-08)
 
 Full Changelog: [v1.3.0...v1.4.0](https://github.com/orbcorp/orb-ruby/compare/v1.3.0...v1.4.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.4.0"
+gem "orb-billing", "~> 1.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/credit_note.rb

@@ -181,7 +181,19 @@ module Orb
         #   @return [Array<Orb::Models::CreditNote::LineItem::Discount>, nil]
         optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote::LineItem::Discount] }
 
-        # @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil)
+        # @!attribute end_time_exclusive
+        #   The end time of the service period for this credit note line item.
+        #
+        #   @return [Time, nil]
+        optional :end_time_exclusive, Time, nil?: true
+
+        # @!attribute start_time_inclusive
+        #   The start time of the service period for this credit note line item.
+        #
+        #   @return [Time, nil]
+        optional :start_time_inclusive, Time, nil?: true
+
+        # @!method initialize(id:, amount:, item_id:, name:, quantity:, subtotal:, tax_amounts:, discounts: nil, end_time_exclusive: nil, start_time_inclusive: nil)
         #   @param id [String] The Orb id of this resource.
         #
         #   @param amount [String] The amount of the line item, including any line item minimums and discounts.
@@ -197,6 +209,10 @@ module Orb
         #   @param tax_amounts [Array<Orb::Models::TaxAmount>] Any tax amounts applied onto the line item.
         #
         #   @param discounts [Array<Orb::Models::CreditNote::LineItem::Discount>] Any line item discounts from the invoice's line item.
+        #
+        #   @param end_time_exclusive [Time, nil] The end time of the service period for this credit note line item.
+        #
+        #   @param start_time_inclusive [Time, nil] The start time of the service period for this credit note line item.
 
         class Discount < Orb::Internal::Type::BaseModel
           # @!attribute id

data/lib/orb/models/credit_note_create_params.rb

@@ -18,19 +18,44 @@ module Orb
       #   @return [Symbol, Orb::Models::CreditNoteCreateParams::Reason]
       required :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }
 
+      # @!attribute end_date
+      #   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.
+      #
+      #   @return [Date, nil]
+      optional :end_date, Date, nil?: true
+
       # @!attribute memo
       #   An optional memo to attach to the credit note.
       #
       #   @return [String, nil]
       optional :memo, String, nil?: true
 
-      # @!method initialize(line_items:, reason:, memo: nil, request_options: {})
+      # @!attribute start_date
+      #   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.
+      #
+      #   @return [Date, nil]
+      optional :start_date, Date, nil?: true
+
+      # @!method initialize(line_items:, reason:, end_date: nil, memo: nil, start_date: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CreditNoteCreateParams} for more details.
+      #
       #   @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
       #
       #   @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
       #
+      #   @param end_date [Date, nil] A date string to specify the global credit note service period end date in the c
+      #
       #   @param memo [String, nil] An optional memo to attach to the credit note.
       #
+      #   @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class LineItem < Orb::Internal::Type::BaseModel
@@ -46,10 +71,36 @@ module Orb
         #   @return [String]
         required :invoice_line_item_id, String
 
-        # @!method initialize(amount:, invoice_line_item_id:)
+        # @!attribute end_date
+        #   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.
+        #
+        #   @return [Date, nil]
+        optional :end_date, Date, nil?: true
+
+        # @!attribute start_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.
+        #
+        #   @return [Date, nil]
+        optional :start_date, Date, nil?: true
+
+        # @!method initialize(amount:, invoice_line_item_id:, end_date: nil, start_date: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::CreditNoteCreateParams::LineItem} for more details.
+        #
         #   @param amount [String] The total amount in the invoice's currency to credit this line item.
         #
         #   @param invoice_line_item_id [String] The ID of the line item to credit.
+        #
+        #   @param end_date [Date, nil] A date string to specify this line item's credit note service period end date in
+        #
+        #   @param start_date [Date, nil] A date string to specify this line item's credit note service period start date
       end
 
       # An optional reason for the credit note.

data/lib/orb/models/events/backfill_create_params.rb

@@ -10,7 +10,7 @@ module Orb
 
         # @!attribute timeframe_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.
         #
         #   @return [Time]
@@ -18,7 +18,7 @@ module Orb
 
         # @!attribute timeframe_start
         #   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.
         #
         #   @return [Time]

data/lib/orb/models/mutated_subscription.rb

@@ -98,7 +98,8 @@ module Orb
       # @!attribute discount_intervals
       #   @deprecated
       #
-      #   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`.
       #
       #   @return [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>]
       required :discount_intervals,
@@ -124,7 +125,8 @@ module Orb
       # @!attribute maximum_intervals
       #   @deprecated
       #
-      #   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`.
       #
       #   @return [Array<Orb::Models::MaximumInterval>]
       required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MaximumInterval] }
@@ -141,7 +143,8 @@ module Orb
       # @!attribute minimum_intervals
       #   @deprecated
       #
-      #   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`.
       #
       #   @return [Array<Orb::Models::MinimumInterval>]
       required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MinimumInterval] }
@@ -237,7 +240,7 @@ module Orb
       #
       #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
       #
-      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
+      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date. This fiel
       #
       #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
       #
@@ -245,11 +248,11 @@ module Orb
       #
       #   @param invoicing_threshold [String, nil]
       #
-      #   @param maximum_intervals [Array<Orb::Models::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
+      #   @param maximum_intervals [Array<Orb::Models::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date. This field
       #
       #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
       #
-      #   @param minimum_intervals [Array<Orb::Models::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
+      #   @param minimum_intervals [Array<Orb::Models::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date. This field
       #
       #   @param name [String] The name of the subscription.
       #

data/lib/orb/models/price_evaluate_multiple_params.rb

@@ -52,6 +52,12 @@ module Orb
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class PriceEvaluation < Orb::Internal::Type::BaseModel
+        # @!attribute external_price_id
+        #   The external ID of a price to evaluate that exists in your Orb account.
+        #
+        #   @return [String, nil]
+        optional :external_price_id, String, nil?: true
+
         # @!attribute filter
         #   A boolean
         #   [computed property](/extensibility/advanced-metrics#computed-properties) used to
@@ -81,10 +87,12 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(filter: nil, grouping_keys: nil, price: nil, price_id: nil)
+        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation} for more details.
         #
+        #   @param external_price_id [String, nil] The external ID of a price to evaluate that exists in your Orb account.
+        #
         #   @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
         #
         #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr

data/lib/orb/models/price_evaluate_multiple_response.rb

@@ -25,6 +25,12 @@ module Orb
         #   @return [Array<Orb::Models::EvaluatePriceGroup>]
         required :price_groups, -> { Orb::Internal::Type::ArrayOf[Orb::EvaluatePriceGroup] }
 
+        # @!attribute external_price_id
+        #   The external ID of the price
+        #
+        #   @return [String, nil]
+        optional :external_price_id, String, nil?: true
+
         # @!attribute inline_price_index
         #   The index of the inline price
         #
@@ -37,11 +43,13 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(currency:, price_groups:, inline_price_index: nil, price_id: nil)
+        # @!method initialize(currency:, price_groups:, external_price_id: nil, inline_price_index: nil, price_id: nil)
         #   @param currency [String] The currency of the price
         #
         #   @param price_groups [Array<Orb::Models::EvaluatePriceGroup>] The computed price groups associated with input price.
         #
+        #   @param external_price_id [String, nil] The external ID of the price
+        #
         #   @param inline_price_index [Integer, nil] The index of the inline price
         #
         #   @param price_id [String, nil] The ID of the price

data/lib/orb/models/price_evaluate_preview_events_params.rb

@@ -110,6 +110,12 @@ module Orb
       end
 
       class PriceEvaluation < Orb::Internal::Type::BaseModel
+        # @!attribute external_price_id
+        #   The external ID of a price to evaluate that exists in your Orb account.
+        #
+        #   @return [String, nil]
+        optional :external_price_id, String, nil?: true
+
         # @!attribute filter
         #   A boolean
         #   [computed property](/extensibility/advanced-metrics#computed-properties) used to
@@ -143,11 +149,13 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(filter: nil, grouping_keys: nil, price: nil, price_id: nil)
+        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation} for more
         #   details.
         #
+        #   @param external_price_id [String, nil] The external ID of a price to evaluate that exists in your Orb account.
+        #
         #   @param filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
         #
         #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr

data/lib/orb/models/price_evaluate_preview_events_response.rb

@@ -25,6 +25,12 @@ module Orb
         #   @return [Array<Orb::Models::EvaluatePriceGroup>]
         required :price_groups, -> { Orb::Internal::Type::ArrayOf[Orb::EvaluatePriceGroup] }
 
+        # @!attribute external_price_id
+        #   The external ID of the price
+        #
+        #   @return [String, nil]
+        optional :external_price_id, String, nil?: true
+
         # @!attribute inline_price_index
         #   The index of the inline price
         #
@@ -37,11 +43,13 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(currency:, price_groups:, inline_price_index: nil, price_id: nil)
+        # @!method initialize(currency:, price_groups:, external_price_id: nil, inline_price_index: nil, price_id: nil)
         #   @param currency [String] The currency of the price
         #
         #   @param price_groups [Array<Orb::Models::EvaluatePriceGroup>] The computed price groups associated with input price.
         #
+        #   @param external_price_id [String, nil] The external ID of the price
+        #
         #   @param inline_price_index [Integer, nil] The index of the inline price
         #
         #   @param price_id [String, nil] The ID of the price

data/lib/orb/models/subscription.rb

@@ -99,7 +99,8 @@ module Orb
       # @!attribute discount_intervals
       #   @deprecated
       #
-      #   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`.
       #
       #   @return [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>]
       required :discount_intervals,
@@ -125,7 +126,8 @@ module Orb
       # @!attribute maximum_intervals
       #   @deprecated
       #
-      #   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`.
       #
       #   @return [Array<Orb::Models::MaximumInterval>]
       required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MaximumInterval] }
@@ -142,7 +144,8 @@ module Orb
       # @!attribute minimum_intervals
       #   @deprecated
       #
-      #   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`.
       #
       #   @return [Array<Orb::Models::MinimumInterval>]
       required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MinimumInterval] }
@@ -250,7 +253,7 @@ module Orb
       #
       #   @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
       #
-      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
+      #   @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date. This fiel
       #
       #   @param end_date [Time, nil] The date Orb stops billing for this subscription.
       #
@@ -258,11 +261,11 @@ module Orb
       #
       #   @param invoicing_threshold [String, nil]
       #
-      #   @param maximum_intervals [Array<Orb::Models::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
+      #   @param maximum_intervals [Array<Orb::Models::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date. This field
       #
       #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
       #
-      #   @param minimum_intervals [Array<Orb::Models::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
+      #   @param minimum_intervals [Array<Orb::Models::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date. This field
       #
       #   @param name [String] The name of the subscription.
       #

data/lib/orb/models/subscription_price_intervals_params.rb

@@ -491,8 +491,8 @@ module Orb
         optional :billing_cycle_day, Integer, nil?: true
 
         # @!attribute end_date
-        #   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.
         #
         #   @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
         optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Edit::EndDate }, nil?: true
@@ -544,7 +544,7 @@ module Orb
         #
         #   @param billing_cycle_day [Integer, nil] The updated billing cycle day for this price interval. If not specified, the bil
         #
-        #   @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the start date wi
+        #   @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the end date will
         #
         #   @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as
         #
@@ -554,8 +554,8 @@ module Orb
         #
         #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
 
-        # 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.
         #
         # @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#end_date
         module EndDate
@@ -612,8 +612,8 @@ module Orb
         required :adjustment_interval_id, String
 
         # @!attribute end_date
-        #   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.
         #
         #   @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
         optional :end_date,
@@ -634,12 +634,12 @@ module Orb
         #
         #   @param adjustment_interval_id [String] The id of the adjustment interval to edit.
         #
-        #   @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the start da
+        #   @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the end date
         #
         #   @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this adjustment interval. If not specified, the start
 
-        # 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.
         #
         # @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#end_date
         module EndDate

data/lib/orb/resources/credit_notes.rb

@@ -3,17 +3,49 @@
 module Orb
   module Resources
     class CreditNotes
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CreditNoteCreateParams} for more details.
+      #
       # This endpoint is used to create a single
       # [`Credit Note`](/invoicing/credit-notes).
       #
-      # @overload create(line_items:, reason:, memo: nil, request_options: {})
+      # 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).
+      #
+      # @overload create(line_items:, reason:, end_date: nil, memo: nil, start_date: nil, request_options: {})
       #
       # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
       #
       # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
       #
+      # @param end_date [Date, nil] A date string to specify the global credit note service period end date in the c
+      #
       # @param memo [String, nil] An optional memo to attach to the credit note.
       #
+      # @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::CreditNote]

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

@@ -60,17 +60,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
         #
@@ -209,17 +209,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/lib/orb/resources/customers/credits/ledger.rb

@@ -46,8 +46,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
@@ -495,8 +495,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

data/lib/orb/resources/invoices.rb

@@ -283,7 +283,7 @@ module Orb
       #
       # If the associated invoice has used the customer balance to change the amount
       # due, the customer balance operation will be reverted. For example, if the
-      # invoice used $10 of customer balance, that amount will be added back to the
+      # invoice used \$10 of customer balance, that amount will be added back to the
       # customer balance upon voiding.
       #
       # If the invoice was used to purchase a credit block, but the invoice is not yet

data/lib/orb/resources/subscriptions.rb

@@ -261,7 +261,7 @@ module Orb
       # is hit. To enable threshold billing, pass in an `invoicing_threshold`, which is
       # specified in the subscription's invoicing currency, when creating a
       # subscription. E.g. pass in `10.00` to issue an invoice when usage amounts hit
-      # $10.00 for a subscription that invoices in USD.
+      # \$10.00 for a subscription that invoices in USD.
       #
       # @overload create(add_adjustments: nil, add_prices: nil, align_billing_with_subscription_start_date: nil, auto_collection: nil, aws_region: nil, billing_cycle_anchor_configuration: nil, coupon_redemption_code: nil, credits_overage_rate: nil, currency: nil, customer_id: nil, default_invoice_memo: nil, end_date: nil, external_customer_id: nil, external_marketplace: nil, external_marketplace_reporting_id: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, metadata: nil, name: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, start_date: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {})
       #

data/lib/orb/version.rb

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