orb-billing 1.13.0 → 1.15.0

data/lib/orb/models/subscription_trigger_phase_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute allow_invoice_credit_or_void
       #   If false, this request will fail if it would void an issued invoice or create a
       #   credit note. Consider using this as a safety mechanism if you do not expect
@@ -22,10 +27,12 @@ module Orb
       #   @return [Date, nil]
       optional :effective_date, Date, nil?: true
 
-      # @!method initialize(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {})
+      # @!method initialize(subscription_id:, allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionTriggerPhaseParams} for more details.
       #
+      #   @param subscription_id [String]
+      #
       #   @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
       #
       #   @param effective_date [Date, nil] The date on which the phase change should take effect. If not provided, defaults

data/lib/orb/models/subscription_unschedule_cancellation_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb

@@ -7,13 +7,20 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute price_id
       #   Price for which the updates should be cleared. Must be a fixed fee.
       #
       #   @return [String]
       required :price_id, String
 
-      # @!method initialize(price_id:, request_options: {})
+      # @!method initialize(subscription_id:, price_id:, request_options: {})
+      #   @param subscription_id [String]
+      #
       #   @param price_id [String] Price for which the updates should be cleared. Must be a fixed fee.
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
+      # @!method initialize(subscription_id:, request_options: {})
+      #   @param subscription_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute price_id
       #   Price for which the quantity should be updated. Must be a fixed fee.
       #
@@ -42,10 +47,12 @@ module Orb
       #   @return [Date, nil]
       optional :effective_date, Date, nil?: true
 
-      # @!method initialize(price_id:, quantity:, allow_invoice_credit_or_void: nil, change_option: nil, effective_date: nil, request_options: {})
+      # @!method initialize(subscription_id:, price_id:, quantity:, allow_invoice_credit_or_void: nil, change_option: nil, effective_date: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionUpdateFixedFeeQuantityParams} for more details.
       #
+      #   @param subscription_id [String]
+      #
       #   @param price_id [String] Price for which the quantity should be updated. Must be a fixed fee.
       #
       #   @param quantity [Float]

data/lib/orb/models/subscription_update_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute auto_collection
       #   Determines whether issued invoices for this subscription will automatically be
       #   charged with the saved payment method on the due date. This property defaults to
@@ -15,6 +20,15 @@ module Orb
       #   @return [Boolean, nil]
       optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
 
+      # @!attribute auto_issuance
+      #   Used to determine if invoices for this subscription will be automatically
+      #   issued. If true, invoices will be automatically issued. If false, invoices will
+      #   require manual approval. If `null` is specified, this defaults to the behavior
+      #   configured for this customer.
+      #
+      #   @return [Boolean, nil]
+      optional :auto_issuance, Orb::Internal::Type::Boolean, nil?: true
+
       # @!attribute default_invoice_memo
       #   Determines the default memo on this subscription's invoices. Note that if this
       #   is not provided, it is determined by the plan configuration.
@@ -47,12 +61,16 @@ module Orb
       #   @return [Integer, nil]
       optional :net_terms, Integer, nil?: true
 
-      # @!method initialize(auto_collection: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {})
+      # @!method initialize(subscription_id:, auto_collection: nil, auto_issuance: nil, default_invoice_memo: nil, invoicing_threshold: nil, metadata: nil, net_terms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionUpdateParams} for more details.
       #
+      #   @param subscription_id [String]
+      #
       #   @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
       #
+      #   @param auto_issuance [Boolean, nil] Used to determine if invoices for this subscription will be automatically issued
+      #
       #   @param default_invoice_memo [String, nil] Determines the default memo on this subscription's invoices. Note that if this i
       #
       #   @param invoicing_threshold [String, nil] When this subscription's accrued usage reaches this threshold, an invoice will b

data/lib/orb/models/subscription_update_trial_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute subscription_id
+      #
+      #   @return [String]
+      required :subscription_id, String
+
       # @!attribute trial_end_date
       #   The new date that the trial should end, or the literal string `immediate` to end
       #   the trial immediately.
@@ -21,10 +26,12 @@ module Orb
       #   @return [Boolean, nil]
       optional :shift, Orb::Internal::Type::Boolean
 
-      # @!method initialize(trial_end_date:, shift: nil, request_options: {})
+      # @!method initialize(subscription_id:, trial_end_date:, shift: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionUpdateTrialParams} for more details.
       #
+      #   @param subscription_id [String]
+      #
       #   @param trial_end_date [Time, Symbol, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate] The new date that the trial should end, or the literal string `immediate` to end
       #
       #   @param shift [Boolean] If true, shifts subsequent price and adjustment intervals (preserving their dura

data/lib/orb/models.rb

@@ -97,6 +97,8 @@ module Orb
 
   ChangedSubscriptionResources = Orb::Models::ChangedSubscriptionResources
 
+  ConversionRateConfig = Orb::Models::ConversionRateConfig
+
   ConversionRateTier = Orb::Models::ConversionRateTier
 
   ConversionRateTieredConfig = Orb::Models::ConversionRateTieredConfig

data/lib/orb/resources/alerts.rb

@@ -27,14 +27,21 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::AlertUpdateParams} for more details.
+      #
       # This endpoint updates the thresholds of an alert.
       #
-      # @overload update(alert_configuration_id, thresholds:, request_options: {})
+      # @overload update(alert_configuration_id, thresholds:, price_filters: nil, threshold_overrides: nil, request_options: {})
       #
       # @param alert_configuration_id [String]
       #
       # @param thresholds [Array<Orb::Models::Threshold>] The thresholds that define the values at which the alert will be triggered.
       #
+      # @param price_filters [Array<Orb::Models::AlertUpdateParams::PriceFilter>, nil] Replaces the price filters on a grouped cost alert; an empty list clears them. O
+      #
+      # @param threshold_overrides [Array<Orb::Models::AlertUpdateParams::ThresholdOverride>, nil] Replaces the per-group threshold overrides on a grouped cost alert; an empty lis
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -179,6 +186,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::AlertCreateForSubscriptionParams} for more details.
+      #
       # This endpoint is used to create alerts at the subscription level.
       #
       # Subscription level alerts can be one of two types: `usage_exceeded` or
@@ -191,7 +201,7 @@ module Orb
       # per metric that is a part of the subscription. Alerts are triggered based on
       # usage or cost conditions met during the current billing cycle.
       #
-      # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {})
+      # @overload create_for_subscription(subscription_id, thresholds:, type:, currency: nil, grouping_keys: nil, metric_id: nil, price_filters: nil, threshold_overrides: nil, request_options: {})
       #
       # @param subscription_id [String]
       #
@@ -199,8 +209,16 @@ module Orb
       #
       # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
       #
+      # @param currency [String, nil] The case sensitive currency or custom pricing unit to use for grouped cost alert
+      #
+      # @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only applicable for cost_exceeded ale
+      #
       # @param metric_id [String, nil] The metric to track usage for.
       #
+      # @param price_filters [Array<Orb::Models::AlertCreateForSubscriptionParams::PriceFilter>, nil] Filters to scope which prices are included in grouped cost alert evaluation. Sup
+      #
+      # @param threshold_overrides [Array<Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]

data/lib/orb/resources/coupons.rb

@@ -49,8 +49,7 @@ module Orb
       #
       # The list of coupons is ordered starting from the most recently created coupon.
       # The response also includes `pagination_metadata`, which lets the caller retrieve
-      # the next page of results if they exist. More information about pagination can be
-      # found in the Pagination-metadata schema.
+      # the next page of results if they exist.
       #
       # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
       #

data/lib/orb/resources/credit_blocks.rb

@@ -59,14 +59,17 @@ module Orb
 
       # This endpoint returns the credit block and its associated purchasing invoices.
       #
-      # If a credit block was purchased (as opposed to being manually added or allocated
-      # from a subscription), this endpoint returns the invoices that were created to
-      # charge the customer for the credit block. For credit blocks with payment
-      # schedules spanning multiple periods (e.g., monthly payments over 12 months),
-      # multiple invoices will be returned.
-      #
-      # If the credit block was not purchased (e.g., manual increment, allocation), an
-      # empty invoices list is returned.
+      # If a credit block was purchased (as opposed to being manually added), this
+      # endpoint returns the invoices that were created to charge the customer for the
+      # credit block. For credit blocks with payment schedules spanning multiple periods
+      # (e.g., monthly payments over 12 months), multiple invoices will be returned.
+      #
+      # For credit blocks created by subscription allocation prices, this endpoint
+      # returns the subscription invoice containing the allocation line item that
+      # created the block.
+      #
+      # If the credit block was not purchased (e.g., manual increment), an empty
+      # invoices list is returned.
       #
       # **Note: This endpoint is currently experimental and its interface may change in
       # future releases. Please contact support before building production integrations

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

@@ -137,9 +137,6 @@ module Orb
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {Orb::Models::Customers::Credits::LedgerCreateEntryParams} for more details.
-          #
           # This endpoint allows you to create a new ledger entry for a specified customer's
           # balance. This can be used to increment balance, deduct credits, and change the
           # expiry date of existing credits.
@@ -180,8 +177,9 @@ module Orb
           # }
           # ```
           #
-          # Note that by default, Orb will always first increment any _negative_ balance in
-          # existing blocks before adding the remaining amount to the desired credit block.
+          # Note that an `increment` entry always creates a new credit block (defined by the
+          # optional `effective_date` and `expiry_date`); it never modifies an existing
+          # block.
           #
           # ### Invoicing for credits
           #
@@ -190,7 +188,9 @@ module Orb
           # also generate a one-off invoice for the customer for the credits pre-purchase.
           # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
           # on the invoice are calculated by multiplying the cost basis with the number of
-          # credit units added.
+          # credit units added. If you invoice or handle payment of credits outside of Orb
+          # (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
+          # `true` to prevent duplicate invoicing effects.
           #
           # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
           #   and `invoice_settings` must be included
@@ -200,11 +200,17 @@ module Orb
           # ## Deducting Credits
           #
           # Orb allows you to deduct credits from a customer by creating an entry of type
-          # `decrement`. Orb matches the algorithm for automatic deductions for determining
-          # which credit blocks to decrement from. In the case that the deduction leads to
-          # multiple ledger entries, the response from this endpoint will be the final
-          # deduction. Orb also optionally allows specifying a description to assist with
-          # auditing.
+          # `decrement`. A `decrement` entry records credits as usage and immediately
+          # recognizes revenue at the block's `per_unit_cost_basis`.
+          #
+          # For most credit removals, use `void` (no revenue impact) or `expiration_change`
+          # (revenue recognized on expiration) instead. Only use `decrement` when credits
+          # were genuinely consumed outside of normal event ingestion.
+          #
+          # Orb matches the algorithm for automatic deductions for determining which credit
+          # blocks to decrement from. In the case that the deduction leads to multiple
+          # ledger entries, the response from this endpoint will be the final deduction. Orb
+          # also optionally allows specifying a description to assist with auditing.
           #
           # The following snippet illustrates a sample request body to decrement credits.
           #
@@ -256,36 +262,10 @@ module Orb
           # that was originally decremented from, and `amount` indicates how many credits to
           # return to the customer, up to the block's initial balance.
           #
-          # @overload create_entry(customer_id, amount:, entry_type:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, expiry_date: nil, filters: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
+          # @overload create_entry(customer_id, body:, request_options: {})
           #
           # @param customer_id [String]
-          #
-          # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
-          #
-          # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
-          #
-          # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
-          #
-          # @param block_id [String] The ID of the block to reverse a decrement from.
-          #
-          # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
-          #
-          # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
-          #
-          # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
-          #
-          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
-          #
-          # @param filters [Array<Orb::Models::Customers::Credits::LedgerCreateEntryParams::Filter>, nil] Optional filter to specify which items this credit block applies to. If not spec
-          #
-          # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
-          #
-          # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
-          #
-          # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
-          #
-          # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
-          #
+          # @param body [Orb::Models::Customers::Credits::LedgerCreateEntryParams::Body::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryParams::Body::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryParams::Body::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryParams::Body::Void, Orb::Models::Customers::Credits::LedgerCreateEntryParams::Body::Amendment]
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Orb::Models::Customers::Credits::IncrementLedgerEntry, Orb::Models::Customers::Credits::DecrementLedgerEntry, Orb::Models::Customers::Credits::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::VoidLedgerEntry, Orb::Models::Customers::Credits::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::AmendmentLedgerEntry]
@@ -296,16 +276,12 @@ module Orb
             @client.request(
               method: :post,
               path: ["customers/%1$s/credits/ledger_entry", customer_id],
-              body: parsed,
+              body: parsed[:body],
               model: Orb::Models::Customers::Credits::LedgerCreateEntryResponse,
               options: options
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams} for more
-          # details.
-          #
           # This endpoint allows you to create a new ledger entry for a specified customer's
           # balance. This can be used to increment balance, deduct credits, and change the
           # expiry date of existing credits.
@@ -346,8 +322,9 @@ module Orb
           # }
           # ```
           #
-          # Note that by default, Orb will always first increment any _negative_ balance in
-          # existing blocks before adding the remaining amount to the desired credit block.
+          # Note that an `increment` entry always creates a new credit block (defined by the
+          # optional `effective_date` and `expiry_date`); it never modifies an existing
+          # block.
           #
           # ### Invoicing for credits
           #
@@ -356,7 +333,9 @@ module Orb
           # also generate a one-off invoice for the customer for the credits pre-purchase.
           # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
           # on the invoice are calculated by multiplying the cost basis with the number of
-          # credit units added.
+          # credit units added. If you invoice or handle payment of credits outside of Orb
+          # (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
+          # `true` to prevent duplicate invoicing effects.
           #
           # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
           #   and `invoice_settings` must be included
@@ -366,11 +345,17 @@ module Orb
           # ## Deducting Credits
           #
           # Orb allows you to deduct credits from a customer by creating an entry of type
-          # `decrement`. Orb matches the algorithm for automatic deductions for determining
-          # which credit blocks to decrement from. In the case that the deduction leads to
-          # multiple ledger entries, the response from this endpoint will be the final
-          # deduction. Orb also optionally allows specifying a description to assist with
-          # auditing.
+          # `decrement`. A `decrement` entry records credits as usage and immediately
+          # recognizes revenue at the block's `per_unit_cost_basis`.
+          #
+          # For most credit removals, use `void` (no revenue impact) or `expiration_change`
+          # (revenue recognized on expiration) instead. Only use `decrement` when credits
+          # were genuinely consumed outside of normal event ingestion.
+          #
+          # Orb matches the algorithm for automatic deductions for determining which credit
+          # blocks to decrement from. In the case that the deduction leads to multiple
+          # ledger entries, the response from this endpoint will be the final deduction. Orb
+          # also optionally allows specifying a description to assist with auditing.
           #
           # The following snippet illustrates a sample request body to decrement credits.
           #
@@ -422,36 +407,10 @@ module Orb
           # that was originally decremented from, and `amount` indicates how many credits to
           # return to the customer, up to the block's initial balance.
           #
-          # @overload create_entry_by_external_id(external_customer_id, amount:, entry_type:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, expiry_date: nil, filters: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
+          # @overload create_entry_by_external_id(external_customer_id, body:, request_options: {})
           #
           # @param external_customer_id [String]
-          #
-          # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
-          #
-          # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
-          #
-          # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
-          #
-          # @param block_id [String] The ID of the block to reverse a decrement from.
-          #
-          # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
-          #
-          # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
-          #
-          # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
-          #
-          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
-          #
-          # @param filters [Array<Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Filter>, nil] Optional filter to specify which items this credit block applies to. If not spec
-          #
-          # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
-          #
-          # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
-          #
-          # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
-          #
-          # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
-          #
+          # @param body [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Void, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Amendment]
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Orb::Models::Customers::Credits::IncrementLedgerEntry, Orb::Models::Customers::Credits::DecrementLedgerEntry, Orb::Models::Customers::Credits::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::VoidLedgerEntry, Orb::Models::Customers::Credits::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::AmendmentLedgerEntry]
@@ -462,7 +421,7 @@ module Orb
             @client.request(
               method: :post,
               path: ["customers/external_customer_id/%1$s/credits/ledger_entry", external_customer_id],
-              body: parsed,
+              body: parsed[:body],
               model: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse,
               options: options
             )

data/lib/orb/resources/customers.rb

@@ -147,11 +147,12 @@ module Orb
       #
       # This endpoint can be used to update the `payment_provider`,
       # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
-      # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
-      # `additional_emails` of an existing customer. Other fields on a customer are
-      # currently immutable.
+      # `auto_collection`, `metadata`, `shipping_address`, `billing_address`,
+      # `additional_emails`, and `currency` of an existing customer. `currency` can only
+      # be set if it has not already been set on the customer. Other fields on a
+      # customer are currently immutable.
       #
-      # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
+      # @overload update(customer_id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #
       # @param customer_id [String]
       #
@@ -165,7 +166,9 @@ module Orb
       #
       # @param billing_address [Orb::Models::AddressInput, nil]
       #
-      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
+      #
+      # @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
       #
       # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
       #
@@ -392,7 +395,7 @@ module Orb
       # resource and semantics of this endpoint exactly mirror
       # [Update Customer](update-customer).
       #
-      # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
+      # @overload update_by_external_id(id, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, auto_issuance: nil, billing_address: nil, currency: nil, default_payment_method_id: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_configuration: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
       #
       # @param id [String]
       #
@@ -406,7 +409,9 @@ module Orb
       #
       # @param billing_address [Orb::Models::AddressInput, nil]
       #
-      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
+      # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. This c
+      #
+      # @param default_payment_method_id [String, nil] The Orb ID of the payment method to set as this customer's default. Pass `null`
       #
       # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
       #

data/lib/orb/resources/events/backfills.rb

@@ -15,8 +15,8 @@ module Orb
         # 3 steps:
         #
         # 1. Create the backfill, specifying its parameters.
-        # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter
-        #    `backfill_id`).
+        # 2. [Ingest](/api-reference/event/ingest-events) usage events, referencing the
+        #    backfill (query parameter `backfill_id`).
         # 3. [Close](close-backfill) the backfill, propagating the update in past usage
         #    throughout Orb.
         #
@@ -91,8 +91,7 @@ module Orb
         # The list of backfills is ordered starting from the most recently created
         # backfill. The response also includes
         # [`pagination_metadata`](/api-reference/pagination), which lets the caller
-        # retrieve the next page of results if they exist. More information about
-        # pagination can be found in the [Pagination-metadata schema](pagination).
+        # retrieve the next page of results if they exist.
         #
         # @overload list(cursor: nil, limit: nil, request_options: {})
         #

data/lib/orb/resources/events.rb

@@ -273,8 +273,8 @@ module Orb
       # billed for in the corresponding billing period.
       #
       # In general, Orb does not expect events with future dated timestamps. In cases
-      # where the timestamp is at least 24 hours ahead of the current time, the event
-      # will not be accepted as a valid event, and will throw validation errors.
+      # where the timestamp is 5 minutes ahead of the current time, the event will not
+      # be accepted as a valid event, and will throw validation errors.
       #
       # ## Event validation
       #
@@ -289,9 +289,9 @@ module Orb
       # - If the `external_customer_id` is specified, the customer in Orb does not need
       #   to exist. Events will be attributed to any future customers with the
       #   `external_customer_id` on subscription creation.
-      # - `timestamp` must conform to ISO 8601 and represent a timestamp at most 1 hour
-      #   in the future. This timestamp should be sent in UTC timezone (no timezone
-      #   offset).
+      # - `timestamp` must conform to ISO 8601 and represent a timestamp at most 5
+      #   minutes in the future. This timestamp should be sent in UTC timezone (no
+      #   timezone offset).
       #
       # ## Idempotency and retry semantics
       #
@@ -328,34 +328,7 @@ module Orb
       # request payload size, but please give us a heads up if you’re changing either of
       # these factors by an order of magnitude from initial setup.
       #
-      # ## Testing in debug mode
-      #
-      # The ingestion API supports a debug mode, which returns additional verbose output
-      # to indicate which event idempotency keys were newly ingested or duplicates from
-      # previous requests. To enable this mode, mark `debug=true` as a query parameter.
-      #
-      # If `debug=true` is not specified, the response will only contain
-      # `validation_failed`. Orb will still honor the idempotency guarantees set
-      # [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
-      # cases.
-      #
-      # We strongly recommend that you only use debug mode as part of testing your
-      # initial Orb integration. Once you're ready to switch to production, disable
-      # debug mode to take advantage of improved performance and maximal throughput.
-      #
-      # #### Example: ingestion response with `debug=true`
-      #
-      # ```json
-      # {
-      #   "debug": {
-      #     "duplicate": [],
-      #     "ingested": ["B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim"]
-      #   },
-      #   "validation_failed": []
-      # }
-      # ```
-      #
-      # #### Example: ingestion response with `debug=false`
+      # #### Example: ingestion response
       #
       # ```json
       # {
@@ -369,7 +342,7 @@ module Orb
       #
       # @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie
       #
-      # @param debug [Boolean] Query param: Flag to enable additional debug information in the endpoint respons
+      # @param debug [Boolean] Query param: Pending Deprecation: Flag to enable additional debug information in
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #