chore(docs): add missing descriptions

Author: stainless-app[bot]

src/orb/_client.py

@@ -32,6 +32,13 @@
 
 
 class Alerts(SyncAPIResource):
+    """
+    [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.
+    """
+
     @cached_property
     def with_raw_response(self) -> AlertsWithRawResponse:
         """
@@ -507,6 +514,13 @@ def enable(
 
 
 class AsyncAlerts(AsyncAPIResource):
+    """
+    [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.
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncAlertsWithRawResponse:
         """

src/orb/resources/alerts.py

@@ -29,8 +29,19 @@
 
 
 class Beta(SyncAPIResource):
+    """
+    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).
+    """
+
     @cached_property
     def external_plan_id(self) -> ExternalPlanID:
+        """
+        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).
+        """
         return ExternalPlanID(self._client)
 
     @cached_property
@@ -215,8 +226,19 @@ def set_default_plan_version(
 
 
 class AsyncBeta(AsyncAPIResource):
+    """
+    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).
+    """
+
     @cached_property
     def external_plan_id(self) -> AsyncExternalPlanID:
+        """
+        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).
+        """
         return AsyncExternalPlanID(self._client)
 
     @cached_property
@@ -416,6 +438,11 @@ def __init__(self, beta: Beta) -> None:
 
     @cached_property
     def external_plan_id(self) -> ExternalPlanIDWithRawResponse:
+        """
+        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).
+        """
         return ExternalPlanIDWithRawResponse(self._beta.external_plan_id)
 
 
@@ -435,6 +462,11 @@ def __init__(self, beta: AsyncBeta) -> None:
 
     @cached_property
     def external_plan_id(self) -> AsyncExternalPlanIDWithRawResponse:
+        """
+        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).
+        """
         return AsyncExternalPlanIDWithRawResponse(self._beta.external_plan_id)
 
 
@@ -454,6 +486,11 @@ def __init__(self, beta: Beta) -> None:
 
     @cached_property
     def external_plan_id(self) -> ExternalPlanIDWithStreamingResponse:
+        """
+        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).
+        """
         return ExternalPlanIDWithStreamingResponse(self._beta.external_plan_id)
 
 
@@ -473,4 +510,9 @@ def __init__(self, beta: AsyncBeta) -> None:
 
     @cached_property
     def external_plan_id(self) -> AsyncExternalPlanIDWithStreamingResponse:
+        """
+        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).
+        """
         return AsyncExternalPlanIDWithStreamingResponse(self._beta.external_plan_id)

src/orb/resources/beta/beta.py

@@ -21,6 +21,12 @@
 
 
 class ExternalPlanID(SyncAPIResource):
+    """
+    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).
+    """
+
     @cached_property
     def with_raw_response(self) -> ExternalPlanIDWithRawResponse:
         """
@@ -206,6 +212,12 @@ def set_default_plan_version(
 
 
 class AsyncExternalPlanID(AsyncAPIResource):
+    """
+    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).
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncExternalPlanIDWithRawResponse:
         """

src/orb/resources/beta/external_plan_id.py

@@ -29,8 +29,15 @@
 
 
 class Coupons(SyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def subscriptions(self) -> Subscriptions:
+        """
+        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.
+        """
         return Subscriptions(self._client)
 
     @cached_property
@@ -254,8 +261,15 @@ def fetch(
 
 
 class AsyncCoupons(AsyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def subscriptions(self) -> AsyncSubscriptions:
+        """
+        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.
+        """
         return AsyncSubscriptions(self._client)
 
     @cached_property
@@ -497,6 +511,9 @@ def __init__(self, coupons: Coupons) -> None:
 
     @cached_property
     def subscriptions(self) -> SubscriptionsWithRawResponse:
+        """
+        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.
+        """
         return SubscriptionsWithRawResponse(self._coupons.subscriptions)
 
 
@@ -519,6 +536,9 @@ def __init__(self, coupons: AsyncCoupons) -> None:
 
     @cached_property
     def subscriptions(self) -> AsyncSubscriptionsWithRawResponse:
+        """
+        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.
+        """
         return AsyncSubscriptionsWithRawResponse(self._coupons.subscriptions)
 
 
@@ -541,6 +561,9 @@ def __init__(self, coupons: Coupons) -> None:
 
     @cached_property
     def subscriptions(self) -> SubscriptionsWithStreamingResponse:
+        """
+        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.
+        """
         return SubscriptionsWithStreamingResponse(self._coupons.subscriptions)
 
 
@@ -563,4 +586,7 @@ def __init__(self, coupons: AsyncCoupons) -> None:
 
     @cached_property
     def subscriptions(self) -> AsyncSubscriptionsWithStreamingResponse:
+        """
+        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.
+        """
         return AsyncSubscriptionsWithStreamingResponse(self._coupons.subscriptions)

src/orb/resources/coupons/coupons.py

@@ -21,6 +21,10 @@
 
 
 class Subscriptions(SyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def with_raw_response(self) -> SubscriptionsWithRawResponse:
         """
@@ -96,6 +100,10 @@ def list(
 
 
 class AsyncSubscriptions(AsyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncSubscriptionsWithRawResponse:
         """

src/orb/resources/coupons/subscriptions.py

@@ -17,6 +17,10 @@
 
 
 class CreditBlocks(SyncAPIResource):
+    """
+    The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+    """
+
     @cached_property
     def with_raw_response(self) -> CreditBlocksWithRawResponse:
         """
@@ -172,6 +176,10 @@ def list_invoices(
 
 
 class AsyncCreditBlocks(AsyncAPIResource):
+    """
+    The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncCreditBlocksWithRawResponse:
         """

src/orb/resources/credit_blocks.py

@@ -23,6 +23,11 @@
 
 
 class CreditNotes(SyncAPIResource):
+    """
+    The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
+    particular invoice.
+    """
+
     @cached_property
     def with_raw_response(self) -> CreditNotesWithRawResponse:
         """
@@ -229,6 +234,11 @@ def fetch(
 
 
 class AsyncCreditNotes(AsyncAPIResource):
+    """
+    The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a
+    particular invoice.
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncCreditNotesWithRawResponse:
         """

src/orb/resources/credit_notes.py

@@ -24,6 +24,23 @@
 
 
 class BalanceTransactions(SyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def with_raw_response(self) -> BalanceTransactionsWithRawResponse:
         """
@@ -178,6 +195,23 @@ def list(
 
 
 class AsyncBalanceTransactions(AsyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncBalanceTransactionsWithRawResponse:
         """

src/orb/resources/customers/balance_transactions.py

@@ -23,6 +23,23 @@
 
 
 class Costs(SyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def with_raw_response(self) -> CostsWithRawResponse:
         """
@@ -398,6 +415,23 @@ def list_by_external_id(
 
 
 class AsyncCosts(AsyncAPIResource):
+    """
+    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.
+    """
+
     @cached_property
     def with_raw_response(self) -> AsyncCostsWithRawResponse:
         """