orb-billing 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b601ed5d994e78179694f51ebc0ba0b5311d69b34f79b2e7892c58041578856f
-  data.tar.gz: a9b90fc941c06f7d73fd7ef1f4d14da454f565141f810477578fe12734c49149
+  metadata.gz: ee6b80e95c43c4a91835db318552bc9cf30795f853bb35d18a7a47f4b2bc4b98
+  data.tar.gz: c32cd239fd0486f158503b5228a38bd78fa7f75feca50955436e71205bdca207
 SHA512:
-  metadata.gz: c17d93b30ccf78c9470d9afcf4b17c1e50e28eea2fb0e185ef9cd6096fbfffcb46f87f851e4df7e7917e3d15bc46f88f9809dadd980e1ac75a330c3000b4109a
-  data.tar.gz: 14c41428f656ba2549fc47c7f0d726abaa5650d659f06360e21a17116ce4a408b2a93b16c823182e8e323ac165b3b281e08971cf8f570fc51fed2feed3552afd
+  metadata.gz: e7d87f338f886d159c571a2ce196fd2ab85f9f1a6e43c24f17f16f809f7de3c0e8784e7ff72cab0415b50f55e8f13529d2409742836d3381e5626ee86034a322
+  data.tar.gz: 0fbd5eb4c79d4b8e5f98b10cb310dbaf1c90ff4e5b1ec6d9a31867156d536b3c0a20dc1505027e7f668e0a177cfca1048225c86022b92f723c14d91482605a8d

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # 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)
+
+### Features
+
+* **api:** api update ([91c8454](https://github.com/orbcorp/orb-ruby/commit/91c8454800efbd06d7a4c4c3e6ded006c838dc57))
+
+
+### Chores
+
+* **internal:** version bump ([be85139](https://github.com/orbcorp/orb-ruby/commit/be85139284c0f58aec01dd53cad4c11e4644171c))
+
 ## 1.3.0 (2025-07-04)
 
 Full Changelog: [v1.2.2...v1.3.0](https://github.com/orbcorp/orb-ruby/compare/v1.2.2...v1.3.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.3.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/customers/credits/ledger_create_entry_by_external_id_params.rb

@@ -156,6 +156,18 @@ module Orb
             #   @return [Integer]
             required :net_terms, Integer
 
+            # @!attribute invoice_date
+            #   An ISO 8601 format date that denotes when this invoice should be dated in the
+            #   customer's timezone. If not provided, the invoice date will default to the
+            #   credit block's effective date.
+            #
+            #   @return [Date, Time, nil]
+            optional :invoice_date,
+                     union: -> {
+                       Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate
+                     },
+                     nil?: true
+
             # @!attribute memo
             #   An optional memo to display on the invoice.
             #
@@ -169,7 +181,7 @@ module Orb
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            # @!method initialize(auto_collection:, net_terms:, invoice_date: nil, memo: nil, require_successful_payment: nil)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
             #   for more details.
@@ -183,9 +195,27 @@ module Orb
             #
             #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
             #
+            #   @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
+            #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
             #   @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
+
+            # An ISO 8601 format date that denotes when this invoice should be dated in the
+            # customer's timezone. If not provided, the invoice date will default to the
+            # credit block's effective date.
+            #
+            # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings#invoice_date
+            module InvoiceDate
+              extend Orb::Internal::Type::Union
+
+              variant Date
+
+              variant Time
+
+              # @!method self.variants
+              #   @return [Array(Date, Time)]
+            end
           end
 
           # Can only be specified when `entry_type=void`. The reason for the void.

data/lib/orb/models/customers/credits/ledger_create_entry_params.rb

@@ -152,6 +152,18 @@ module Orb
             #   @return [Integer]
             required :net_terms, Integer
 
+            # @!attribute invoice_date
+            #   An ISO 8601 format date that denotes when this invoice should be dated in the
+            #   customer's timezone. If not provided, the invoice date will default to the
+            #   credit block's effective date.
+            #
+            #   @return [Date, Time, nil]
+            optional :invoice_date,
+                     union: -> {
+                       Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate
+                     },
+                     nil?: true
+
             # @!attribute memo
             #   An optional memo to display on the invoice.
             #
@@ -165,7 +177,7 @@ module Orb
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            # @!method initialize(auto_collection:, net_terms:, invoice_date: nil, memo: nil, require_successful_payment: nil)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for
             #   more details.
@@ -179,9 +191,27 @@ module Orb
             #
             #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
             #
+            #   @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
+            #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
             #   @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
+
+            # An ISO 8601 format date that denotes when this invoice should be dated in the
+            # customer's timezone. If not provided, the invoice date will default to the
+            # credit block's effective date.
+            #
+            # @see Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings#invoice_date
+            module InvoiceDate
+              extend Orb::Internal::Type::Union
+
+              variant Date
+
+              variant Time
+
+              # @!method self.variants
+              #   @return [Array(Date, Time)]
+            end
           end
 
           # Can only be specified when `entry_type=void`. The reason for the void.

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]