orb-billing 4.49.0 → 4.50.0

package/src/resources/plans/plans.ts

@@ -30,11 +30,11 @@ export class Plans extends APIResource {
   }
 
   /**
-   * This endpoint returns a list of all [plans](../guides/concepts##plan-and-price)
-   * for an account in a list format. The list of plans is ordered starting from the
-   * most recently created plan. The response also includes
-   * [`pagination_metadata`](../reference/pagination), which lets the caller retrieve
-   * the next page of results if they exist.
+   * This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for
+   * an account in a list format. The list of plans is ordered starting from the most
+   * recently created plan. The response also includes
+   * [`pagination_metadata`](/api-reference/pagination), which lets the caller
+   * retrieve the next page of results if they exist.
    */
   list(query?: PlanListParams, options?: Core.RequestOptions): Core.PagePromise<PlansPage, Plan>;
   list(options?: Core.RequestOptions): Core.PagePromise<PlansPage, Plan>;
@@ -49,18 +49,18 @@ export class Plans extends APIResource {
   }
 
   /**
-   * This endpoint is used to fetch [plan](../guides/concepts##plan-and-price)
-   * details given a plan identifier. It returns information about the prices
-   * included in the plan and their configuration, as well as the product that the
-   * plan is attached to.
+   * This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
+   * given a plan identifier. It returns information about the prices included in the
+   * plan and their configuration, as well as the product that the plan is attached
+   * to.
    *
    * ## Serialized prices
    *
    * Orb supports a few different pricing models out of the box. Each of these models
-   * is serialized differently in a given [Price](../guides/concepts#plan-and-price)
+   * is serialized differently in a given [Price](/core-concepts#plan-and-price)
    * object. The `model_type` field determines the key for the configuration object
    * that is present. A detailed explanation of price types can be found in the
-   * [Price schema](../guides/concepts#plan-and-price).
+   * [Price schema](/core-concepts#plan-and-price).
    *
    * ## Phases
    *
@@ -75,9 +75,9 @@ export class Plans extends APIResource {
 export class PlansPage extends Page<Plan> {}
 
 /**
- * The [Plan](../guides/core-concepts.mdx#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
+ * 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).
  */
 export interface Plan {
@@ -497,7 +497,6 @@ export interface PlanCreateParams {
     | PlanCreateParams.NewPlanMatrixWithDisplayNamePrice
     | PlanCreateParams.NewPlanBulkWithProrationPrice
     | PlanCreateParams.NewPlanGroupedTieredPackagePrice
-    | PlanCreateParams.NewPlanMaxGroupTieredPrice
   >;
 
   /**
@@ -3072,119 +3071,6 @@ export namespace PlanCreateParams {
       duration_unit: 'day' | 'month';
     }
   }
-
-  export interface NewPlanMaxGroupTieredPrice {
-    /**
-     * The cadence to bill for this price on.
-     */
-    cadence: 'annual' | 'semi_annual' | 'monthly' | 'quarterly' | 'one_time' | 'custom';
-
-    /**
-     * The id of the item the plan will be associated with.
-     */
-    item_id: string;
-
-    max_group_tiered_config: Record<string, unknown>;
-
-    model_type: 'max_group_tiered';
-
-    /**
-     * The name of the price.
-     */
-    name: string;
-
-    /**
-     * The id of the billable metric for the price. Only needed if the price is
-     * usage-based.
-     */
-    billable_metric_id?: string | null;
-
-    /**
-     * If the Price represents a fixed cost, the price will be billed in-advance if
-     * this is true, and in-arrears if this is false.
-     */
-    billed_in_advance?: boolean | null;
-
-    /**
-     * For custom cadence: specifies the duration of the billing period in days or
-     * months.
-     */
-    billing_cycle_configuration?: NewPlanMaxGroupTieredPrice.BillingCycleConfiguration | null;
-
-    /**
-     * The per unit conversion rate of the price currency to the invoicing currency.
-     */
-    conversion_rate?: number | null;
-
-    /**
-     * An ISO 4217 currency string, or custom pricing unit identifier, in which this
-     * price is billed.
-     */
-    currency?: string | null;
-
-    /**
-     * An alias for the price.
-     */
-    external_price_id?: string | null;
-
-    /**
-     * If the Price represents a fixed cost, this represents the quantity of units
-     * applied.
-     */
-    fixed_price_quantity?: number | null;
-
-    /**
-     * The property used to group this price on an invoice
-     */
-    invoice_grouping_key?: string | null;
-
-    /**
-     * Within each billing cycle, specifies the cadence at which invoices are produced.
-     * If unspecified, a single invoice is produced per billing cycle.
-     */
-    invoicing_cycle_configuration?: NewPlanMaxGroupTieredPrice.InvoicingCycleConfiguration | null;
-
-    /**
-     * User-specified key/value pairs for the resource. Individual keys can be removed
-     * by setting the value to `null`, and the entire metadata mapping can be cleared
-     * by setting `metadata` to `null`.
-     */
-    metadata?: Record<string, string | null> | null;
-  }
-
-  export namespace NewPlanMaxGroupTieredPrice {
-    /**
-     * For custom cadence: specifies the duration of the billing period in days or
-     * months.
-     */
-    export interface BillingCycleConfiguration {
-      /**
-       * The duration of the billing period.
-       */
-      duration: number;
-
-      /**
-       * The unit of billing period duration.
-       */
-      duration_unit: 'day' | 'month';
-    }
-
-    /**
-     * Within each billing cycle, specifies the cadence at which invoices are produced.
-     * If unspecified, a single invoice is produced per billing cycle.
-     */
-    export interface InvoicingCycleConfiguration {
-      /**
-       * The duration of the billing period.
-       */
-      duration: number;
-
-      /**
-       * The unit of billing period duration.
-       */
-      duration_unit: 'day' | 'month';
-    }
-  }
 }
 
 export interface PlanUpdateParams {

package/src/resources/prices/external-price-id.ts

@@ -20,8 +20,8 @@ export class ExternalPriceID extends APIResource {
 
   /**
    * This endpoint returns a price given an external price id. See the
-   * [price creation API](../reference/create-price) for more information about
-   * external price aliases.
+   * [price creation API](/api-reference/price/create-price) for more information
+   * about external price aliases.
    */
   fetch(externalPriceId: string, options?: Core.RequestOptions): Core.APIPromise<PricesAPI.Price> {
     return this._client.get(`/prices/external_price_id/${externalPriceId}`, options);