orb-billing 0.2.0 → 0.3.1

data/lib/orb/resources/alerts.rb

@@ -27,7 +27,9 @@ module Orb
       # @overload update(alert_configuration_id, thresholds:, request_options: {})
       #
       # @param alert_configuration_id [String]
-      # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>]
+      #
+      # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -44,6 +46,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::AlertListParams} for more details.
+      #
       # This endpoint returns a list of alerts within Orb.
       #
       # The request must specify one of `customer_id`, `external_customer_id`, or
@@ -59,14 +64,24 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
+      #
       # @param created_at_gte [Time, nil]
+      #
       # @param created_at_lt [Time, nil]
+      #
       # @param created_at_lte [Time, nil]
-      # @param cursor [String, nil]
-      # @param customer_id [String, nil]
-      # @param external_customer_id [String, nil]
-      # @param limit [Integer]
-      # @param subscription_id [String, nil]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param customer_id [String, nil] Fetch alerts scoped to this customer_id
+      #
+      # @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Alert>]
@@ -101,9 +116,13 @@ module Orb
       # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {})
       #
       # @param customer_id [String]
-      # @param currency [String]
-      # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type]
-      # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
+      #
+      # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -132,9 +151,13 @@ module Orb
       # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {})
       #
       # @param external_customer_id [String]
-      # @param currency [String]
-      # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type]
-      # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
+      #
+      # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
+      #
+      # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -166,9 +189,13 @@ module Orb
       # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {})
       #
       # @param subscription_id [String]
-      # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
-      # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
-      # @param metric_id [String, nil]
+      #
+      # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
+      #
+      # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
+      #
+      # @param metric_id [String, nil] The metric to track usage for.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -192,7 +219,9 @@ module Orb
       # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {})
       #
       # @param alert_configuration_id [String]
-      # @param subscription_id [String, nil]
+      #
+      # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]
@@ -216,7 +245,9 @@ module Orb
       # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {})
       #
       # @param alert_configuration_id [String]
-      # @param subscription_id [String, nil]
+      #
+      # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Alert]

data/lib/orb/resources/coupons/subscriptions.rb

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Coupons
       class Subscriptions
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Coupons::SubscriptionListParams} for more details.
+        #
         # This endpoint returns a list of all subscriptions that have redeemed a given
         # coupon as a [paginated](/api-reference/pagination) list, ordered starting from
         # the most recently created subscription. For a full discussion of the
@@ -12,8 +15,12 @@ module Orb
         # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {})
         #
         # @param coupon_id [String]
-        # @param cursor [String, nil]
-        # @param limit [Integer]
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Subscription>]

data/lib/orb/resources/coupons.rb

@@ -6,15 +6,24 @@ module Orb
       # @return [Orb::Resources::Coupons::Subscriptions]
       attr_reader :subscriptions
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CouponCreateParams} for more details.
+      #
       # This endpoint allows the creation of coupons, which can then be redeemed at
       # subscription creation or plan change.
       #
       # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
       #
-      # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
-      # @param redemption_code [String]
-      # @param duration_in_months [Integer, nil]
-      # @param max_redemptions [Integer, nil]
+      # @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
+      #
+      # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
+      #
+      # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
+      # ...
+      #
+      # @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Coupon]
@@ -31,6 +40,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CouponListParams} for more details.
+      #
       # This endpoint returns a list of all coupons for an account in a list format.
       #
       # The list of coupons is ordered starting from the most recently created coupon.
@@ -40,10 +52,16 @@ module Orb
       #
       # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
       #
-      # @param cursor [String, nil]
-      # @param limit [Integer]
-      # @param redemption_code [String, nil]
-      # @param show_archived [Boolean, nil]
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      # @param redemption_code [String, nil] Filter to coupons matching this redemption code.
+      #
+      # @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou
+      # ...
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::Coupon>]

data/lib/orb/resources/credit_notes.rb

@@ -9,8 +9,11 @@ module Orb
       # @overload create(line_items:, memo: nil, reason: nil, request_options: {})
       #
       # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
-      # @param memo [String, nil]
-      # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
+      #
+      # @param memo [String, nil] An optional memo to attach to the credit note.
+      #
+      # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::CreditNote]
@@ -27,6 +30,9 @@ module Orb
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::CreditNoteListParams} for more details.
+      #
       # Get a paginated list of CreditNotes. Users can also filter by customer_id,
       # subscription_id, or external_customer_id. The credit notes will be returned in
       # reverse chronological order by `creation_time`.
@@ -34,11 +40,18 @@ module Orb
       # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
       #
       # @param created_at_gt [Time, nil]
+      #
       # @param created_at_gte [Time, nil]
+      #
       # @param created_at_lt [Time, nil]
+      #
       # @param created_at_lte [Time, nil]
-      # @param cursor [String, nil]
-      # @param limit [Integer]
+      #
+      # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      # ...
+      #
+      # @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Internal::Page<Orb::Models::CreditNote>]

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

@@ -10,9 +10,13 @@ module Orb
         # @overload create(customer_id, amount:, type:, description: nil, request_options: {})
         #
         # @param customer_id [String]
+        #
         # @param amount [String]
+        #
         # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
-        # @param description [String, nil]
+        #
+        # @param description [String, nil] An optional description that can be specified around this entry.
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Customers::BalanceTransactionCreateResponse]
@@ -29,6 +33,9 @@ module Orb
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Customers::BalanceTransactionListParams} for more details.
+        #
         # ## The customer balance
         #
         # The customer balance is an amount in the customer's currency, which Orb
@@ -61,12 +68,20 @@ module Orb
         # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
         #
         # @param customer_id [String]
-        # @param cursor [String, nil]
-        # @param limit [Integer]
+        #
+        # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # ...
+        #
+        # @param limit [Integer] The number of items to fetch. Defaults to 20.
+        #
         # @param operation_time_gt [Time, nil]
+        #
         # @param operation_time_gte [Time, nil]
+        #
         # @param operation_time_lt [Time, nil]
+        #
         # @param operation_time_lte [Time, nil]
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Internal::Page<Orb::Models::Customers::BalanceTransactionListResponse>]

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

@@ -4,6 +4,9 @@ module Orb
   module Resources
     class Customers
       class Costs
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Customers::CostListParams} for more details.
+        #
         # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
         # Orb, calculated by applying pricing information to the underlying usage (see the
         # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
@@ -125,10 +128,16 @@ module Orb
         # @overload list(customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
         #
         # @param customer_id [String]
-        # @param currency [String, nil]
-        # @param timeframe_end [Time, nil]
-        # @param timeframe_start [Time, nil]
-        # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
+        #
+        # @param currency [String, nil] The currency or custom pricing unit to use.
+        #
+        # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
+        #
+        # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
+        #
+        # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
+        # ...
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Customers::CostListResponse]
@@ -145,6 +154,9 @@ module Orb
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Orb::Models::Customers::CostListByExternalIDParams} for more details.
+        #
         # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
         # Orb, calculated by applying pricing information to the underlying usage (see the
         # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
@@ -266,10 +278,16 @@ module Orb
         # @overload list_by_external_id(external_customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
         #
         # @param external_customer_id [String]
-        # @param currency [String, nil]
-        # @param timeframe_end [Time, nil]
-        # @param timeframe_start [Time, nil]
-        # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
+        #
+        # @param currency [String, nil] The currency or custom pricing unit to use.
+        #
+        # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
+        #
+        # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
+        #
+        # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
+        # ...
+        #
         # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Orb::Models::Customers::CostListByExternalIDResponse]

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

@@ -5,6 +5,9 @@ module Orb
     class Customers
       class Credits
         class Ledger
+          # Some parameter documentations has been truncated, see
+          # {Orb::Models::Customers::Credits::LedgerListParams} for more details.
+          #
           # The credits ledger provides _auditing_ functionality over Orb's credits system
           # with a list of actions that have taken place to modify a customer's credit
           # balance. This [paginated endpoint](/api-reference/pagination) lists these
@@ -90,19 +93,31 @@ module Orb
           # @overload list(customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
           #
           # @param customer_id [String]
+          #
           # @param created_at_gt [Time, nil]
+          #
           # @param created_at_gte [Time, nil]
+          #
           # @param created_at_lt [Time, nil]
+          #
           # @param created_at_lte [Time, nil]
-          # @param currency [String, nil]
-          # @param cursor [String, nil]
+          #
+          # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+          #
+          # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # ...
+          #
           # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil]
+          #
           # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil]
-          # @param limit [Integer]
+          #
+          # @param limit [Integer] The number of items to fetch. Defaults to 20.
+          #
           # @param minimum_amount [String, nil]
+          #
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry>]
+          # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListResponse::Increment, Orb::Models::Customers::Credits::LedgerListResponse::Decrement, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListResponse::Void, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListResponse::Amendment>]
           #
           # @see Orb::Models::Customers::Credits::LedgerListParams
           def list(customer_id, params = {})
@@ -122,6 +137,9 @@ 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.
@@ -236,21 +254,42 @@ module Orb
           # @overload create_entry(customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
           #
           # @param customer_id [String]
-          # @param amount [Float]
+          #
+          # @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 expiry_date [Time, nil]
-          # @param target_expiry_date [Date]
-          # @param block_id [String]
-          # @param currency [String, nil]
-          # @param description [String, nil]
-          # @param effective_date [Time, nil]
-          # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
-          # @param metadata [Hash{Symbol=>String, nil}, nil]
-          # @param per_unit_cost_basis [String, nil]
-          # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil]
+          #
+          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
+          #
+          # @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 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 request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry]
+          # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment]
           #
           # @see Orb::Models::Customers::Credits::LedgerCreateEntryParams
           def create_entry(customer_id, params)
@@ -264,6 +303,10 @@ module Orb
             )
           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.
@@ -378,21 +421,42 @@ module Orb
           # @overload create_entry_by_external_id(external_customer_id, amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
           #
           # @param external_customer_id [String]
-          # @param amount [Float]
+          #
+          # @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 expiry_date [Time, nil]
-          # @param target_expiry_date [Date]
-          # @param block_id [String]
-          # @param currency [String, nil]
-          # @param description [String, nil]
-          # @param effective_date [Time, nil]
-          # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
-          # @param metadata [Hash{Symbol=>String, nil}, nil]
-          # @param per_unit_cost_basis [String, nil]
-          # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
+          #
+          # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
+          #
+          # @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 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 request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry]
+          # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment]
           #
           # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams
           def create_entry_by_external_id(external_customer_id, params)
@@ -407,6 +471,10 @@ module Orb
             )
           end
 
+          # Some parameter documentations has been truncated, see
+          # {Orb::Models::Customers::Credits::LedgerListByExternalIDParams} for more
+          # details.
+          #
           # The credits ledger provides _auditing_ functionality over Orb's credits system
           # with a list of actions that have taken place to modify a customer's credit
           # balance. This [paginated endpoint](/api-reference/pagination) lists these
@@ -492,19 +560,31 @@ module Orb
           # @overload list_by_external_id(external_customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
           #
           # @param external_customer_id [String]
+          #
           # @param created_at_gt [Time, nil]
+          #
           # @param created_at_gte [Time, nil]
+          #
           # @param created_at_lt [Time, nil]
+          #
           # @param created_at_lte [Time, nil]
-          # @param currency [String, nil]
-          # @param cursor [String, nil]
+          #
+          # @param currency [String, nil] The ledger currency or custom pricing unit to use.
+          #
+          # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # ...
+          #
           # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
+          #
           # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
-          # @param limit [Integer]
+          #
+          # @param limit [Integer] The number of items to fetch. Defaults to 20.
+          #
           # @param minimum_amount [String, nil]
+          #
           # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry>]
+          # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment>]
           #
           # @see Orb::Models::Customers::Credits::LedgerListByExternalIDParams
           def list_by_external_id(external_customer_id, params = {})