orb-billing 1.12.0 → 1.13.0

data/rbi/orb/models/price_evaluate_multiple_params.rbi

@@ -113,6 +113,11 @@ module Orb
         sig { params(grouping_keys: T::Array[String]).void }
         attr_writer :grouping_keys
 
+        # Optional overrides for parameterized billable metric parameters. If the metric
+        # has parameter definitions and no overrides are provided, defaults will be used.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # New floating price request body params.
         sig do
           returns(
@@ -164,6 +169,7 @@ module Orb
             external_price_id: T.nilable(String),
             filter: T.nilable(String),
             grouping_keys: T::Array[String],
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             price:
               T.nilable(
                 T.any(
@@ -214,6 +220,9 @@ module Orb
           # [computed properties](/extensibility/advanced-metrics#computed-properties)) used
           # to group the underlying billable metric
           grouping_keys: nil,
+          # Optional overrides for parameterized billable metric parameters. If the metric
+          # has parameter definitions and no overrides are provided, defaults will be used.
+          metric_parameter_overrides: nil,
           # New floating price request body params.
           price: nil,
           # The ID of a price to evaluate that exists in your Orb account.
@@ -227,6 +236,8 @@ module Orb
               external_price_id: T.nilable(String),
               filter: T.nilable(String),
               grouping_keys: T::Array[String],
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               price:
                 T.nilable(
                   T.any(

data/rbi/orb/models/price_evaluate_params.rbi

@@ -40,6 +40,11 @@ module Orb
       sig { params(grouping_keys: T::Array[String]).void }
       attr_writer :grouping_keys
 
+      # Optional overrides for parameterized billable metric parameters. If the metric
+      # has parameter definitions and no overrides are provided, defaults will be used.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metric_parameter_overrides
+
       sig do
         params(
           timeframe_end: Time,
@@ -48,6 +53,7 @@ module Orb
           external_customer_id: T.nilable(String),
           filter: T.nilable(String),
           grouping_keys: T::Array[String],
+          metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
           request_options: Orb::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -68,6 +74,9 @@ module Orb
         # [computed properties](/extensibility/advanced-metrics#computed-properties)) used
         # to group the underlying billable metric
         grouping_keys: nil,
+        # Optional overrides for parameterized billable metric parameters. If the metric
+        # has parameter definitions and no overrides are provided, defaults will be used.
+        metric_parameter_overrides: nil,
         request_options: {}
       )
       end
@@ -81,6 +90,7 @@ module Orb
             external_customer_id: T.nilable(String),
             filter: T.nilable(String),
             grouping_keys: T::Array[String],
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Orb::RequestOptions
           }
         )

data/rbi/orb/models/price_evaluate_preview_events_params.rbi

@@ -214,6 +214,11 @@ module Orb
         sig { params(grouping_keys: T::Array[String]).void }
         attr_writer :grouping_keys
 
+        # Optional overrides for parameterized billable metric parameters. If the metric
+        # has parameter definitions and no overrides are provided, defaults will be used.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # New floating price request body params.
         sig do
           returns(
@@ -265,6 +270,7 @@ module Orb
             external_price_id: T.nilable(String),
             filter: T.nilable(String),
             grouping_keys: T::Array[String],
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             price:
               T.nilable(
                 T.any(
@@ -315,6 +321,9 @@ module Orb
           # [computed properties](/extensibility/advanced-metrics#computed-properties)) used
           # to group the underlying billable metric
           grouping_keys: nil,
+          # Optional overrides for parameterized billable metric parameters. If the metric
+          # has parameter definitions and no overrides are provided, defaults will be used.
+          metric_parameter_overrides: nil,
           # New floating price request body params.
           price: nil,
           # The ID of a price to evaluate that exists in your Orb account.
@@ -328,6 +337,8 @@ module Orb
               external_price_id: T.nilable(String),
               filter: T.nilable(String),
               grouping_keys: T::Array[String],
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               price:
                 T.nilable(
                   T.any(

data/rbi/orb/models/price_interval.rbi

@@ -68,6 +68,11 @@ module Orb
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :usage_customer_ids
 
+      # Override values for parameterized billable metric variables. Keys are parameter
+      # names, values are the override values.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :metric_parameter_overrides
+
       # The Price Interval resource represents a period of time for which a price will
       # bill on a subscription. A subscription’s price intervals define its billing
       # behavior.
@@ -117,7 +122,8 @@ module Orb
               Orb::Price::EventOutput::OrHash
             ),
           start_date: Time,
-          usage_customer_ids: T.nilable(T::Array[String])
+          usage_customer_ids: T.nilable(T::Array[String]),
+          metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything])
         ).returns(T.attached_class)
       end
       def self.new(
@@ -160,7 +166,10 @@ module Orb
         start_date:,
         # A list of customer IDs whose usage events will be aggregated and billed under
         # this price interval.
-        usage_customer_ids:
+        usage_customer_ids:,
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values.
+        metric_parameter_overrides: nil
       )
       end
 
@@ -178,7 +187,8 @@ module Orb
               T.nilable(T::Array[Orb::FixedFeeQuantityTransition]),
             price: Orb::Price::Variants,
             start_date: Time,
-            usage_customer_ids: T.nilable(T::Array[String])
+            usage_customer_ids: T.nilable(T::Array[String]),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything])
           }
         )
       end

data/rbi/orb/models/subscription_create_params.rbi

@@ -569,6 +569,11 @@ module Orb
         sig { returns(T.nilable(String)) }
         attr_accessor :maximum_amount
 
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         # this price.
         sig { returns(T.nilable(String)) }
@@ -637,6 +642,7 @@ module Orb
             end_date: T.nilable(Time),
             external_price_id: T.nilable(String),
             maximum_amount: T.nilable(String),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             minimum_amount: T.nilable(String),
             plan_phase_order: T.nilable(Integer),
             price:
@@ -694,6 +700,9 @@ module Orb
           # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
           # this price.
           maximum_amount: nil,
+          # Override values for parameterized billable metric variables. Keys are parameter
+          # names, values are the override values.
+          metric_parameter_overrides: nil,
           # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
           # this price.
           minimum_amount: nil,
@@ -718,6 +727,8 @@ module Orb
               end_date: T.nilable(Time),
               external_price_id: T.nilable(String),
               maximum_amount: T.nilable(String),
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               minimum_amount: T.nilable(String),
               plan_phase_order: T.nilable(Integer),
               price:
@@ -3435,6 +3446,11 @@ module Orb
         sig { returns(T.nilable(String)) }
         attr_accessor :maximum_amount
 
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         # the replacement price.
         sig { returns(T.nilable(String)) }
@@ -3494,6 +3510,7 @@ module Orb
             external_price_id: T.nilable(String),
             fixed_price_quantity: T.nilable(Float),
             maximum_amount: T.nilable(String),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             minimum_amount: T.nilable(String),
             price:
               T.nilable(
@@ -3549,6 +3566,9 @@ module Orb
           # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
           # the replacement price.
           maximum_amount: nil,
+          # Override values for parameterized billable metric variables. Keys are parameter
+          # names, values are the override values.
+          metric_parameter_overrides: nil,
           # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
           # the replacement price.
           minimum_amount: nil,
@@ -3568,6 +3588,8 @@ module Orb
               external_price_id: T.nilable(String),
               fixed_price_quantity: T.nilable(Float),
               maximum_amount: T.nilable(String),
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               minimum_amount: T.nilable(String),
               price:
                 T.nilable(

data/rbi/orb/models/subscription_price_intervals_params.rbi

@@ -229,6 +229,11 @@ module Orb
         sig { returns(T.nilable(Float)) }
         attr_accessor :maximum_amount
 
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values (number or string).
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # The minimum amount that will be billed for this price interval for a given
         # billing period.
         sig { returns(T.nilable(Float)) }
@@ -315,6 +320,7 @@ module Orb
                 ]
               ),
             maximum_amount: T.nilable(Float),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             minimum_amount: T.nilable(Float),
             price:
               T.nilable(
@@ -383,6 +389,9 @@ module Orb
           # The maximum amount that will be billed for this price interval for a given
           # billing period.
           maximum_amount: nil,
+          # Override values for parameterized billable metric variables. Keys are parameter
+          # names, values are the override values (number or string).
+          metric_parameter_overrides: nil,
           # The minimum amount that will be billed for this price interval for a given
           # billing period.
           minimum_amount: nil,
@@ -427,6 +436,8 @@ module Orb
                   ]
                 ),
               maximum_amount: T.nilable(Float),
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               minimum_amount: T.nilable(Float),
               price:
                 T.nilable(
@@ -2884,6 +2895,11 @@ module Orb
         end
         attr_accessor :fixed_fee_quantity_transitions
 
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values (number or string).
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # The updated start date of this price interval. If not specified, the start date
         # will not be updated.
         sig do
@@ -2923,6 +2939,7 @@ module Orb
                   Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition::OrHash
                 ]
               ),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
             usage_customer_ids: T.nilable(T::Array[String])
           ).returns(T.attached_class)
@@ -2950,6 +2967,9 @@ module Orb
           # that this list will overwrite all existing fixed fee quantity transitions on the
           # price interval.
           fixed_fee_quantity_transitions: nil,
+          # Override values for parameterized billable metric variables. Keys are parameter
+          # names, values are the override values (number or string).
+          metric_parameter_overrides: nil,
           # The updated start date of this price interval. If not specified, the start date
           # will not be updated.
           start_date: nil,
@@ -2978,6 +2998,8 @@ module Orb
                     Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition
                   ]
                 ),
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
               usage_customer_ids: T.nilable(T::Array[String])
             }

data/rbi/orb/models/subscription_schedule_plan_change_params.rbi

@@ -620,6 +620,11 @@ module Orb
         sig { returns(T.nilable(String)) }
         attr_accessor :maximum_amount
 
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         # this price.
         sig { returns(T.nilable(String)) }
@@ -688,6 +693,7 @@ module Orb
             end_date: T.nilable(Time),
             external_price_id: T.nilable(String),
             maximum_amount: T.nilable(String),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             minimum_amount: T.nilable(String),
             plan_phase_order: T.nilable(Integer),
             price:
@@ -745,6 +751,9 @@ module Orb
           # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
           # this price.
           maximum_amount: nil,
+          # Override values for parameterized billable metric variables. Keys are parameter
+          # names, values are the override values.
+          metric_parameter_overrides: nil,
           # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
           # this price.
           minimum_amount: nil,
@@ -769,6 +778,8 @@ module Orb
               end_date: T.nilable(Time),
               external_price_id: T.nilable(String),
               maximum_amount: T.nilable(String),
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               minimum_amount: T.nilable(String),
               plan_phase_order: T.nilable(Integer),
               price:
@@ -3494,6 +3505,11 @@ module Orb
         sig { returns(T.nilable(String)) }
         attr_accessor :maximum_amount
 
+        # Override values for parameterized billable metric variables. Keys are parameter
+        # names, values are the override values.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_accessor :metric_parameter_overrides
+
         # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         # the replacement price.
         sig { returns(T.nilable(String)) }
@@ -3553,6 +3569,7 @@ module Orb
             external_price_id: T.nilable(String),
             fixed_price_quantity: T.nilable(Float),
             maximum_amount: T.nilable(String),
+            metric_parameter_overrides: T.nilable(T::Hash[Symbol, T.anything]),
             minimum_amount: T.nilable(String),
             price:
               T.nilable(
@@ -3608,6 +3625,9 @@ module Orb
           # [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
           # the replacement price.
           maximum_amount: nil,
+          # Override values for parameterized billable metric variables. Keys are parameter
+          # names, values are the override values.
+          metric_parameter_overrides: nil,
           # [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
           # the replacement price.
           minimum_amount: nil,
@@ -3627,6 +3647,8 @@ module Orb
               external_price_id: T.nilable(String),
               fixed_price_quantity: T.nilable(Float),
               maximum_amount: T.nilable(String),
+              metric_parameter_overrides:
+                T.nilable(T::Hash[Symbol, T.anything]),
               minimum_amount: T.nilable(String),
               price:
                 T.nilable(

data/rbi/orb/resources/alerts.rbi

@@ -2,6 +2,11 @@
 
 module Orb
   module Resources
+    # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+    # usage, or credit balance and trigger webhooks when a threshold is exceeded.
+    #
+    # Alerts created through the API can be scoped to either customers or
+    # subscriptions.
     class Alerts
       # This endpoint retrieves an alert by its ID.
       sig do

data/rbi/orb/resources/beta/external_plan_id.rbi

@@ -3,6 +3,10 @@
 module Orb
   module Resources
     class Beta
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
       class ExternalPlanID
         # This endpoint allows the creation of a new plan version for an existing plan.
         sig do

data/rbi/orb/resources/beta.rbi

@@ -2,7 +2,15 @@
 
 module Orb
   module Resources
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     class Beta
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
       sig { returns(Orb::Resources::Beta::ExternalPlanID) }
       attr_reader :external_plan_id
 

data/rbi/orb/resources/coupons/subscriptions.rbi

@@ -3,6 +3,11 @@
 module Orb
   module Resources
     class Coupons
+      # A coupon represents a reusable discount configuration that can be applied either
+      # as a fixed or percentage amount to an invoice or subscription. Coupons are
+      # activated using a redemption code, which applies the discount to a subscription
+      # or invoice. The duration of a coupon determines how long it remains available
+      # for use by end users.
       class Subscriptions
         # This endpoint returns a list of all subscriptions that have redeemed a given
         # coupon as a [paginated](/api-reference/pagination) list, ordered starting from

data/rbi/orb/resources/coupons.rbi

@@ -2,7 +2,17 @@
 
 module Orb
   module Resources
+    # A coupon represents a reusable discount configuration that can be applied either
+    # as a fixed or percentage amount to an invoice or subscription. Coupons are
+    # activated using a redemption code, which applies the discount to a subscription
+    # or invoice. The duration of a coupon determines how long it remains available
+    # for use by end users.
     class Coupons
+      # A coupon represents a reusable discount configuration that can be applied either
+      # as a fixed or percentage amount to an invoice or subscription. Coupons are
+      # activated using a redemption code, which applies the discount to a subscription
+      # or invoice. The duration of a coupon determines how long it remains available
+      # for use by end users.
       sig { returns(Orb::Resources::Coupons::Subscriptions) }
       attr_reader :subscriptions
 

data/rbi/orb/resources/credit_blocks.rbi

@@ -2,6 +2,8 @@
 
 module Orb
   module Resources
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
     class CreditBlocks
       # This endpoint returns a credit block identified by its block_id.
       sig do

data/rbi/orb/resources/credit_notes.rbi

@@ -2,6 +2,8 @@
 
 module Orb
   module Resources
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     class CreditNotes
       # This endpoint is used to create a single
       # [`Credit Note`](/invoicing/credit-notes).

data/rbi/orb/resources/customers/balance_transactions.rbi

@@ -3,6 +3,24 @@
 module Orb
   module Resources
     class Customers
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
       class BalanceTransactions
         # Creates an immutable balance transaction that updates the customer's balance and
         # returns back the newly created transaction.

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

@@ -3,6 +3,24 @@
 module Orb
   module Resources
     class Customers
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
       class Costs
         # 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

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

@@ -4,6 +4,8 @@ module Orb
   module Resources
     class Customers
       class Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         class Ledger
           # 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
@@ -180,8 +182,12 @@ 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. Additionally, Orb also enforces invoice generation when a
-          # non-zero `per_unit_cost_basis` value is provided.
+          # credit units added.
+          #
+          # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
+          #   and `invoice_settings` must be included
+          # - if `invoice_settings` is passed, one of either `custom_due_date` or
+          #   `net_terms` is required to determine the due date
           #
           # ## Deducting Credits
           #
@@ -369,8 +375,12 @@ 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. Additionally, Orb also enforces invoice generation when a
-          # non-zero `per_unit_cost_basis` value is provided.
+          # credit units added.
+          #
+          # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
+          #   and `invoice_settings` must be included
+          # - if `invoice_settings` is passed, one of either `custom_due_date` or
+          #   `net_terms` is required to determine the due date
           #
           # ## Deducting Credits
           #

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

@@ -4,6 +4,8 @@ module Orb
   module Resources
     class Customers
       class Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         class TopUps
           # This endpoint allows you to create a new top-up for a specified customer's
           # balance. While this top-up is active, the customer's balance will added in

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

@@ -3,10 +3,16 @@
 module Orb
   module Resources
     class Customers
+      # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+      # credits within Orb.
       class Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         sig { returns(Orb::Resources::Customers::Credits::Ledger) }
         attr_reader :ledger
 
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         sig { returns(Orb::Resources::Customers::Credits::TopUps) }
         attr_reader :top_ups