orb-billing 4.48.0 → 4.50.0

package/resources/subscriptions.js

@@ -17,7 +17,7 @@ class Subscriptions extends resource_1.APIResource {
      *
      * The default configuration for subscriptions in Orb is **In-advance billing** and
      * **Beginning of month alignment** (see
-     * [Subscription](../guides/concepts#subscription) for more details).
+     * [Subscription](/core-concepts##subscription) for more details).
      *
      * In order to change the alignment behavior, Orb also supports billing
      * subscriptions on the day of the month they are created. If
@@ -42,9 +42,10 @@ class Subscriptions extends resource_1.APIResource {
      * subscription being created. This is useful when a customer has prices that
      * differ from the default prices for a specific plan.
      *
-     * :::info This feature is only available for accounts that have migrated to
-     * Subscription Overrides Version 2. You can find your Subscription Overrides
-     * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
+     * <Note>
+     * This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
+     * Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
+     * </Note>
      *
      * ### Adding Prices
      *
@@ -52,17 +53,17 @@ class Subscriptions extends resource_1.APIResource {
      * the list must specify an existing add-on price with a `price_id` or
      * `external_price_id` field, or create a new add-on price by including an object
      * with the key `price`, identical to what would be used in the request body for
-     * the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the price should be added to.
      *
      * An object in the list can specify an optional `start_date` and optional
      * `end_date`. This is equivalent to creating a price interval with the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
-     * unspecified, the start or end date of the phase or subscription will be used.
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
+     * If unspecified, the start or end date of the phase or subscription will be used.
      *
      * An object in the list can specify an optional `minimum_amount`,
      * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -87,14 +88,15 @@ class Subscriptions extends resource_1.APIResource {
      * either referencing an existing add-on price with a `price_id` or
      * `external_price_id` field, or by creating a new add-on price by including an
      * object with the key `price`, identical to what would be used in the request body
-     * for the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * for the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * For fixed fees, an object in the list can supply a `fixed_price_quantity`
      * instead of a `price`, `price_id`, or `external_price_id` field. This will update
      * only the quantity for the price, similar to the
-     * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
+     * [Update price quantity](/api-reference/subscription/update-price-quantity)
+     * endpoint.
      *
      * The replacement price will have the same phase, if applicable, and the same
      * start and end dates as the price it replaces.
@@ -113,7 +115,7 @@ class Subscriptions extends resource_1.APIResource {
      * To add adjustments, provide a list of objects with the key `add_adjustments`. An
      * object in the list must include an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the adjustment should be added
@@ -136,17 +138,17 @@ class Subscriptions extends resource_1.APIResource {
      * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
      * to replace it with by including an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * The replacement adjustment will have the same phase, if applicable, and the same
      * start and end dates as the adjustment it replaces.
      *
      * ## Price overrides (DEPRECATED)
      *
-     * :::info Price overrides are being phased out in favor adding/removing/replacing
-     * prices. (See
-     * [Customize your customer's subscriptions](../reference/create-subscription#customize-your-customers-subscriptions))
-     * :::
+     * <Note>
+     * Price overrides are being phased out in favor adding/removing/replacing prices. (See
+     * [Customize your customer's subscriptions](/api-reference/subscription/create-subscription))
+     * </Note>
      *
      * Price overrides are used to update some or all prices in a plan for the specific
      * subscription being created. This is useful when a new customer has negotiated a
@@ -155,9 +157,9 @@ class Subscriptions extends resource_1.APIResource {
      * To override prices, provide a list of objects with the key `price_overrides`.
      * The price object in the list of overrides is expected to contain the existing
      * price id, the `model_type` and configuration. (See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations.) The numerical values can be updated, but the billable
-     * metric, cadence, type, and name of a price can not be overridden.
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations.) The numerical values can be updated, but
+     * the billable metric, cadence, type, and name of a price can not be overridden.
      *
      * ### Maximums and Minimums
      *
@@ -340,13 +342,13 @@ class Subscriptions extends resource_1.APIResource {
      * current period. If the cancellation is before the most recently issued invoice,
      * Orb will void the intervening invoice and generate a new one based on the new
      * dates for the subscription. See the section on
-     * [cancellation behaviors](../guides/product-catalog/creating-subscriptions.md#cancellation-behaviors).
+     * [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).
      */
     cancel(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/cancel`, { body, ...options });
     }
     /**
-     * This endpoint is used to fetch a [Subscription](../guides/concepts#subscription)
+     * This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
      * given an identifier.
      */
     fetch(subscriptionId, options) {
@@ -372,9 +374,9 @@ class Subscriptions extends resource_1.APIResource {
     }
     /**
      * This endpoint is used to add and edit subscription
-     * [price intervals](../reference/price-interval). By making modifications to a
-     * subscription’s price intervals, you can
-     * [flexibly and atomically control the billing behavior of a subscription](../guides/product-catalog/modifying-subscriptions).
+     * [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
+     * making modifications to a subscription’s price intervals, you can
+     * [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions).
      *
      * ## Adding price intervals
      *
@@ -492,9 +494,10 @@ class Subscriptions extends resource_1.APIResource {
      * subscription when you schedule the plan change. This is useful when a customer
      * has prices that differ from the default prices for a specific plan.
      *
-     * :::info This feature is only available for accounts that have migrated to
-     * Subscription Overrides Version 2. You can find your Subscription Overrides
-     * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
+     * <Note>
+     * This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
+     * Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
+     * </Note>
      *
      * ### Adding Prices
      *
@@ -502,17 +505,17 @@ class Subscriptions extends resource_1.APIResource {
      * the list must specify an existing add-on price with a `price_id` or
      * `external_price_id` field, or create a new add-on price by including an object
      * with the key `price`, identical to what would be used in the request body for
-     * the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the price should be added to.
      *
      * An object in the list can specify an optional `start_date` and optional
      * `end_date`. This is equivalent to creating a price interval with the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
-     * unspecified, the start or end date of the phase or subscription will be used.
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
+     * If unspecified, the start or end date of the phase or subscription will be used.
      *
      * An object in the list can specify an optional `minimum_amount`,
      * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -537,14 +540,15 @@ class Subscriptions extends resource_1.APIResource {
      * either referencing an existing add-on price with a `price_id` or
      * `external_price_id` field, or by creating a new add-on price by including an
      * object with the key `price`, identical to what would be used in the request body
-     * for the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * for the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * For fixed fees, an object in the list can supply a `fixed_price_quantity`
      * instead of a `price`, `price_id`, or `external_price_id` field. This will update
      * only the quantity for the price, similar to the
-     * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
+     * [Update price quantity](/api-reference/subscription/update-price-quantity)
+     * endpoint.
      *
      * The replacement price will have the same phase, if applicable, and the same
      * start and end dates as the price it replaces.
@@ -563,7 +567,7 @@ class Subscriptions extends resource_1.APIResource {
      * To add adjustments, provide a list of objects with the key `add_adjustments`. An
      * object in the list must include an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the adjustment should be added
@@ -586,17 +590,17 @@ class Subscriptions extends resource_1.APIResource {
      * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
      * to replace it with by including an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * The replacement adjustment will have the same phase, if applicable, and the same
      * start and end dates as the adjustment it replaces.
      *
      * ## Price overrides (DEPRECATED)
      *
-     * :::info Price overrides are being phased out in favor adding/removing/replacing
-     * prices. (See
-     * [Customize your customer's subscriptions](../reference/schedule-plan-change#customize-your-customers-subscriptions))
-     * :::
+     * <Note>
+     * Price overrides are being phased out in favor adding/removing/replacing prices. (See
+     * [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))
+     * </Note>
      *
      * Price overrides are used to update some or all prices in a plan for the specific
      * subscription being created. This is useful when a new customer has negotiated a
@@ -605,9 +609,9 @@ class Subscriptions extends resource_1.APIResource {
      * To override prices, provide a list of objects with the key `price_overrides`.
      * The price object in the list of overrides is expected to contain the existing
      * price id, the `model_type` and configuration. (See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations.) The numerical values can be updated, but the billable
-     * metric, cadence, type, and name of a price can not be overridden.
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations.) The numerical values can be updated, but
+     * the billable metric, cadence, type, and name of a price can not be overridden.
      *
      * ### Maximums, and minimums
      *
@@ -627,7 +631,7 @@ class Subscriptions extends resource_1.APIResource {
      * By default, Orb calculates the prorated difference in any fixed fees when making
      * a plan change, adjusting the customer balance as needed. For details on this
      * behavior, see
-     * [Modifying subscriptions](../guides/product-catalog/modifying-subscriptions.md#prorations-for-in-advance-fees).
+     * [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
      */
     schedulePlanChange(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/schedule_plan_change`, { body, ...options });

package/resources/subscriptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAM3C,iDAAsD;AAEtD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+PG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AA/gCD,sCA+gCC;AAED,MAAa,iBAAkB,SAAQ,iBAAkB;CAAG;AAA5D,8CAA4D;AAE5D,MAAa,sCAAuC,SAAQ,iBAAuC;CAAG;AAAtG,wFAAsG;AAi3tBtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}
+{"version":3,"file":"subscriptions.js","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAM3C,iDAAsD;AAEtD,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiQG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAnhCD,sCAmhCC;AAED,MAAa,iBAAkB,SAAQ,iBAAkB;CAAG;AAA5D,8CAA4D;AAE5D,MAAa,sCAAuC,SAAQ,iBAAuC;CAAG;AAAtG,wFAAsG;AAywoBtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}

package/resources/subscriptions.mjs

@@ -14,7 +14,7 @@ export class Subscriptions extends APIResource {
      *
      * The default configuration for subscriptions in Orb is **In-advance billing** and
      * **Beginning of month alignment** (see
-     * [Subscription](../guides/concepts#subscription) for more details).
+     * [Subscription](/core-concepts##subscription) for more details).
      *
      * In order to change the alignment behavior, Orb also supports billing
      * subscriptions on the day of the month they are created. If
@@ -39,9 +39,10 @@ export class Subscriptions extends APIResource {
      * subscription being created. This is useful when a customer has prices that
      * differ from the default prices for a specific plan.
      *
-     * :::info This feature is only available for accounts that have migrated to
-     * Subscription Overrides Version 2. You can find your Subscription Overrides
-     * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
+     * <Note>
+     * This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
+     * Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
+     * </Note>
      *
      * ### Adding Prices
      *
@@ -49,17 +50,17 @@ export class Subscriptions extends APIResource {
      * the list must specify an existing add-on price with a `price_id` or
      * `external_price_id` field, or create a new add-on price by including an object
      * with the key `price`, identical to what would be used in the request body for
-     * the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the price should be added to.
      *
      * An object in the list can specify an optional `start_date` and optional
      * `end_date`. This is equivalent to creating a price interval with the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
-     * unspecified, the start or end date of the phase or subscription will be used.
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
+     * If unspecified, the start or end date of the phase or subscription will be used.
      *
      * An object in the list can specify an optional `minimum_amount`,
      * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -84,14 +85,15 @@ export class Subscriptions extends APIResource {
      * either referencing an existing add-on price with a `price_id` or
      * `external_price_id` field, or by creating a new add-on price by including an
      * object with the key `price`, identical to what would be used in the request body
-     * for the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * for the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * For fixed fees, an object in the list can supply a `fixed_price_quantity`
      * instead of a `price`, `price_id`, or `external_price_id` field. This will update
      * only the quantity for the price, similar to the
-     * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
+     * [Update price quantity](/api-reference/subscription/update-price-quantity)
+     * endpoint.
      *
      * The replacement price will have the same phase, if applicable, and the same
      * start and end dates as the price it replaces.
@@ -110,7 +112,7 @@ export class Subscriptions extends APIResource {
      * To add adjustments, provide a list of objects with the key `add_adjustments`. An
      * object in the list must include an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the adjustment should be added
@@ -133,17 +135,17 @@ export class Subscriptions extends APIResource {
      * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
      * to replace it with by including an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * The replacement adjustment will have the same phase, if applicable, and the same
      * start and end dates as the adjustment it replaces.
      *
      * ## Price overrides (DEPRECATED)
      *
-     * :::info Price overrides are being phased out in favor adding/removing/replacing
-     * prices. (See
-     * [Customize your customer's subscriptions](../reference/create-subscription#customize-your-customers-subscriptions))
-     * :::
+     * <Note>
+     * Price overrides are being phased out in favor adding/removing/replacing prices. (See
+     * [Customize your customer's subscriptions](/api-reference/subscription/create-subscription))
+     * </Note>
      *
      * Price overrides are used to update some or all prices in a plan for the specific
      * subscription being created. This is useful when a new customer has negotiated a
@@ -152,9 +154,9 @@ export class Subscriptions extends APIResource {
      * To override prices, provide a list of objects with the key `price_overrides`.
      * The price object in the list of overrides is expected to contain the existing
      * price id, the `model_type` and configuration. (See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations.) The numerical values can be updated, but the billable
-     * metric, cadence, type, and name of a price can not be overridden.
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations.) The numerical values can be updated, but
+     * the billable metric, cadence, type, and name of a price can not be overridden.
      *
      * ### Maximums and Minimums
      *
@@ -337,13 +339,13 @@ export class Subscriptions extends APIResource {
      * current period. If the cancellation is before the most recently issued invoice,
      * Orb will void the intervening invoice and generate a new one based on the new
      * dates for the subscription. See the section on
-     * [cancellation behaviors](../guides/product-catalog/creating-subscriptions.md#cancellation-behaviors).
+     * [cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).
      */
     cancel(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/cancel`, { body, ...options });
     }
     /**
-     * This endpoint is used to fetch a [Subscription](../guides/concepts#subscription)
+     * This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
      * given an identifier.
      */
     fetch(subscriptionId, options) {
@@ -369,9 +371,9 @@ export class Subscriptions extends APIResource {
     }
     /**
      * This endpoint is used to add and edit subscription
-     * [price intervals](../reference/price-interval). By making modifications to a
-     * subscription’s price intervals, you can
-     * [flexibly and atomically control the billing behavior of a subscription](../guides/product-catalog/modifying-subscriptions).
+     * [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
+     * making modifications to a subscription’s price intervals, you can
+     * [flexibly and atomically control the billing behavior of a subscription](/product-catalog/modifying-subscriptions).
      *
      * ## Adding price intervals
      *
@@ -489,9 +491,10 @@ export class Subscriptions extends APIResource {
      * subscription when you schedule the plan change. This is useful when a customer
      * has prices that differ from the default prices for a specific plan.
      *
-     * :::info This feature is only available for accounts that have migrated to
-     * Subscription Overrides Version 2. You can find your Subscription Overrides
-     * Version at the bottom of your [Plans page](https://app.withorb.com/plans) :::
+     * <Note>
+     * This feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your
+     * Subscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)
+     * </Note>
      *
      * ### Adding Prices
      *
@@ -499,17 +502,17 @@ export class Subscriptions extends APIResource {
      * the list must specify an existing add-on price with a `price_id` or
      * `external_price_id` field, or create a new add-on price by including an object
      * with the key `price`, identical to what would be used in the request body for
-     * the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the price should be added to.
      *
      * An object in the list can specify an optional `start_date` and optional
      * `end_date`. This is equivalent to creating a price interval with the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals). If
-     * unspecified, the start or end date of the phase or subscription will be used.
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
+     * If unspecified, the start or end date of the phase or subscription will be used.
      *
      * An object in the list can specify an optional `minimum_amount`,
      * `maximum_amount`, or `discounts`. This will create adjustments which apply only
@@ -534,14 +537,15 @@ export class Subscriptions extends APIResource {
      * either referencing an existing add-on price with a `price_id` or
      * `external_price_id` field, or by creating a new add-on price by including an
      * object with the key `price`, identical to what would be used in the request body
-     * for the [create price endpoint](../reference/create-price). See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations possible in this object.
+     * for the [create price endpoint](/api-reference/price/create-price). See the
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations possible in this object.
      *
      * For fixed fees, an object in the list can supply a `fixed_price_quantity`
      * instead of a `price`, `price_id`, or `external_price_id` field. This will update
      * only the quantity for the price, similar to the
-     * [Update price quantity](../reference/update-fixed-fee-quantity) endpoint.
+     * [Update price quantity](/api-reference/subscription/update-price-quantity)
+     * endpoint.
      *
      * The replacement price will have the same phase, if applicable, and the same
      * start and end dates as the price it replaces.
@@ -560,7 +564,7 @@ export class Subscriptions extends APIResource {
      * To add adjustments, provide a list of objects with the key `add_adjustments`. An
      * object in the list must include an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * If the plan has phases, each object in the list must include a number with
      * `plan_phase_order` key to indicate which phase the adjustment should be added
@@ -583,17 +587,17 @@ export class Subscriptions extends APIResource {
      * replace with the `replaces_adjustment_id` key, and it must specify an adjustment
      * to replace it with by including an object with the key `adjustment`, identical
      * to the adjustment object in the
-     * [add/edit price intervals endpoint](../reference/add-edit-price-intervals).
+     * [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).
      *
      * The replacement adjustment will have the same phase, if applicable, and the same
      * start and end dates as the adjustment it replaces.
      *
      * ## Price overrides (DEPRECATED)
      *
-     * :::info Price overrides are being phased out in favor adding/removing/replacing
-     * prices. (See
-     * [Customize your customer's subscriptions](../reference/schedule-plan-change#customize-your-customers-subscriptions))
-     * :::
+     * <Note>
+     * Price overrides are being phased out in favor adding/removing/replacing prices. (See
+     * [Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))
+     * </Note>
      *
      * Price overrides are used to update some or all prices in a plan for the specific
      * subscription being created. This is useful when a new customer has negotiated a
@@ -602,9 +606,9 @@ export class Subscriptions extends APIResource {
      * To override prices, provide a list of objects with the key `price_overrides`.
      * The price object in the list of overrides is expected to contain the existing
      * price id, the `model_type` and configuration. (See the
-     * [Price resource](../reference/price) for the specification of different price
-     * model configurations.) The numerical values can be updated, but the billable
-     * metric, cadence, type, and name of a price can not be overridden.
+     * [Price resource](/product-catalog/price-configuration) for the specification of
+     * different price model configurations.) The numerical values can be updated, but
+     * the billable metric, cadence, type, and name of a price can not be overridden.
      *
      * ### Maximums, and minimums
      *
@@ -624,7 +628,7 @@ export class Subscriptions extends APIResource {
      * By default, Orb calculates the prorated difference in any fixed fees when making
      * a plan change, adjusting the customer balance as needed. For details on this
      * behavior, see
-     * [Modifying subscriptions](../guides/product-catalog/modifying-subscriptions.md#prorations-for-in-advance-fees).
+     * [Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).
      */
     schedulePlanChange(subscriptionId, body, options) {
         return this._client.post(`/subscriptions/${subscriptionId}/schedule_plan_change`, { body, ...options });

package/resources/subscriptions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAMpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+PG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,IAAkB;CAAG;AAE5D,MAAM,OAAO,sCAAuC,SAAQ,IAAuC;CAAG;AAi3tBtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}
+{"version":3,"file":"subscriptions.mjs","sourceRoot":"","sources":["../src/resources/subscriptions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAMpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiQG;IACH,MAAM,CACJ,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAkBD,IAAI,CACF,QAAsD,EAAE,EACxD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8DG;IACH,MAAM,CACJ,cAAsB,EACtB,IAA8B,EAC9B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAsB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAuBD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAiBD,aAAa,CACX,cAAsB,EACtB,QAA+D,EAAE,EACjE,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,kBAAkB,cAAc,WAAW,EAC3C,sCAAsC,EACtC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IA4MD,UAAU,CACR,cAAsB,EACtB,QAA4D,EAAE,EAC9D,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,cAAc,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,cAAc,CACZ,cAAsB,EACtB,IAAsC,EACtC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuLG;IACH,kBAAkB,CAChB,cAAsB,EACtB,IAA0C,EAC1C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,uBAAuB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,cAAsB,EACtB,IAAoC,EACpC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,0BAA0B,EAAE,OAAO,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;OAMG;IACH,iCAAiC,CAC/B,cAAsB,EACtB,IAAyD,EACzD,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,wCAAwC,EAAE;YACjG,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,4BAA4B,CAC1B,cAAsB,EACtB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,kCAAkC,EAAE,OAAO,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAAsB,CACpB,cAAsB,EACtB,IAA8C,EAC9C,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,4BAA4B,EAAE;YACrF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CACT,cAAsB,EACtB,IAAmC,EACnC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,cAAc,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;CACF;AAED,MAAM,OAAO,iBAAkB,SAAQ,IAAkB;CAAG;AAE5D,MAAM,OAAO,sCAAuC,SAAQ,IAAuC;CAAG;AAywoBtG,aAAa,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AACpD,aAAa,CAAC,sCAAsC,GAAG,sCAAsC,CAAC"}

package/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.

package/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 {
   /**