release: 4.50.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "4.49.0"
+  ".": "4.50.0"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 101
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-11f40c15fa889d9752019e8a35b82d2e7a3d42f2b42c850b469f120a5b2c47ba.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e480186cdd0e2cc631befa7e2c6ba5f2d7ae52052f0e79a748214f3ade8a98ee.yml

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 4.50.0 (2025-01-18)
+
+Full Changelog: [v4.49.0...v4.50.0](https://github.com/orbcorp/orb-node/compare/v4.49.0...v4.50.0)
+
+### Features
+
+* **api:** api update ([#471](https://github.com/orbcorp/orb-node/issues/471)) ([cf59d6c](https://github.com/orbcorp/orb-node/commit/cf59d6cee157745b4c0b5808f23ed2c7a8f056ee))
+
 ## 4.49.0 (2025-01-16)
 
 Full Changelog: [v4.48.0...v4.49.0](https://github.com/orbcorp/orb-node/compare/v4.48.0...v4.49.0)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "orb-billing",
-  "version": "4.49.0",
+  "version": "4.50.0",
   "description": "The official TypeScript library for the Orb API",
   "author": "Orb <team@withorb.com>",
   "types": "dist/index.d.ts",

src/resources/alerts.ts

@@ -35,7 +35,7 @@ export class Alerts extends APIResource {
    *
    * The list of alerts is ordered starting from the most recently created alert.
    * This endpoint follows Orb's
-   * [standardized pagination format](../reference/pagination).
+   * [standardized pagination format](/api-reference/pagination).
    */
   list(query?: AlertListParams, options?: Core.RequestOptions): Core.PagePromise<AlertsPage, Alert>;
   list(options?: Core.RequestOptions): Core.PagePromise<AlertsPage, Alert>;
@@ -54,8 +54,7 @@ export class Alerts extends APIResource {
    * are three types of alerts that can be scoped to customers:
    * `credit_balance_depleted`, `credit_balance_dropped`, and
    * `credit_balance_recovered`. Customers can have a maximum of one of each type of
-   * alert per
-   * [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+   * alert per [credit balance currency](/product-catalog/prepurchase).
    * `credit_balance_dropped` alerts require a list of thresholds to be provided
    * while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
    * require thresholds.
@@ -73,8 +72,7 @@ export class Alerts extends APIResource {
    * are three types of alerts that can be scoped to customers:
    * `credit_balance_depleted`, `credit_balance_dropped`, and
    * `credit_balance_recovered`. Customers can have a maximum of one of each type of
-   * alert per
-   * [credit balance currency](https://docs.withorb.com/guides/product-catalog/prepurchase).
+   * alert per [credit balance currency](/product-catalog/prepurchase).
    * `credit_balance_dropped` alerts require a list of thresholds to be provided
    * while `credit_balance_depleted` and `credit_balance_recovered` alerts do not
    * require thresholds.
@@ -164,9 +162,8 @@ export class Alerts extends APIResource {
 export class AlertsPage extends Page<Alert> {}
 
 /**
- * [Alerts within Orb](https://docs.withorb.com/guides/product-catalog/configuring-alerts)
- * monitor spending, usage, or credit balance and trigger webhooks when a threshold
- * is exceeded.
+ * [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.

src/resources/coupons/coupons.ts

@@ -66,40 +66,6 @@ export class CouponsPage extends Page<Coupon> {}
  * 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.
- *
- * ## How to use coupons
- *
- * Coupons can be created using the Orb dashboard or programmatically through the
- * API. Once a coupon is created, it can be managed and applied programmatically
- * via the API. To redeem a coupon, use the `redemption_code` property when
- * [creating a subscription](create-subscription.api.mdx) or when scheduling a
- * [plan change](schedule-plan-change.api.mdx).
- *
- * ## When to use coupons
- *
- * A common use case for coupons is through self-serve signup or upgrade flows in
- * your checkout experience or billing portal. Coupons can also be used as one-off
- * to incentivize use for custom agreements.
- *
- * Coupons are effective when launching new features and encouraging existing users
- * to upgrade to a higher tier. For example, you could create a coupon code
- * "UPGRADE20" that offers a 20% discount on the first month of the new plan. This
- * code can be applied during the upgrade process in your billing portal, making it
- * straightforward for users to benefit from the new features at a reduced cost.
- *
- * ## Coupon scoping
- *
- * When a coupon is applied on a subscription, it creates a discount adjustment
- * that applies to all of the prices on the subscription at the time of the coupon
- * application. Notably, coupons do not scope in new price additions to a
- * subscription automatically — if a new price is added to the subscription with a
- * subscription edit or plan version migration, the discount created with the
- * coupon will not apply to it automatically. If you'd like the coupon to apply to
- * newly added prices, you can
- * [edit the adjustment intervals](add-edit-price-intervals.api.mdx) to end the
- * discount interval created by the coupon at the time of the migration and add a
- * new one starting at the time of the migration that includes the newly added
- * prices you'd like the coupon to apply to.
  */
 export interface Coupon {
   /**

src/resources/coupons/subscriptions.ts

@@ -10,9 +10,9 @@ import { type PageParams } from '../../pagination';
 export class Subscriptions extends APIResource {
   /**
    * This endpoint returns a list of all subscriptions that have redeemed a given
-   * coupon as a [paginated](../reference/pagination) list, ordered starting from the
-   * most recently created subscription. For a full discussion of the subscription
-   * resource, see [Subscription](../guides/concepts#subscription).
+   * coupon as a [paginated](/api-reference/pagination) list, ordered starting from
+   * the most recently created subscription. For a full discussion of the
+   * subscription resource, see [Subscription](/core-concepts#subscription).
    */
   list(
     couponId: string,

src/resources/credit-notes.ts

@@ -8,7 +8,7 @@ import { Page, type PageParams } from '../pagination';
 export class CreditNotes extends APIResource {
   /**
    * This endpoint is used to create a single
-   * [`Credit Note`](../guides/invoicing/credit-notes).
+   * [`Credit Note`](/invoicing/credit-notes).
    */
   create(body: CreditNoteCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreditNote> {
     return this._client.post('/credit_notes', { body, ...options });
@@ -35,8 +35,8 @@ export class CreditNotes extends APIResource {
   }
 
   /**
-   * This endpoint is used to fetch a single
-   * [`Credit Note`](../guides/invoicing/credit-notes) given an identifier.
+   * This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
+   * given an identifier.
    */
   fetch(creditNoteId: string, options?: Core.RequestOptions): Core.APIPromise<CreditNote> {
     return this._client.get(`/credit_notes/${creditNoteId}`, options);
@@ -46,8 +46,8 @@ export class CreditNotes extends APIResource {
 export class CreditNotesPage extends Page<CreditNote> {}
 
 /**
- * The [Credit Note](/guides/invoicing/credit-notes) resource represents a credit
- * that has been applied to a particular invoice.
+ * The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+ * been applied to a particular invoice.
  */
 export interface CreditNote {
   /**