orb-billing 4.49.0 → 4.51.0

package/src/resources/invoices.ts

@@ -31,13 +31,13 @@ export class Invoices extends APIResource {
   }
 
   /**
-   * This endpoint returns a list of all [`Invoice`](../guides/concepts#invoice)s for
-   * an account in a list format.
+   * This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an
+   * account in a list format.
    *
    * The list of invoices is ordered starting from the most recently issued invoice
    * date. The response also includes
-   * [`pagination_metadata`](../reference/pagination), which lets the caller retrieve
-   * the next page of results if they exist.
+   * [`pagination_metadata`](/api-reference/pagination), which lets the caller
+   * retrieve the next page of results if they exist.
    *
    * By default, this only returns invoices that are `issued`, `paid`, or `synced`.
    *
@@ -58,8 +58,8 @@ export class Invoices extends APIResource {
   }
 
   /**
-   * This endpoint is used to fetch an [`Invoice`](../guides/concepts#invoice) given
-   * an identifier.
+   * This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an
+   * identifier.
    */
   fetch(invoiceId: string, options?: Core.RequestOptions): Core.APIPromise<Invoice> {
     return this._client.get(`/invoices/${invoiceId}`, options);
@@ -67,7 +67,7 @@ export class Invoices extends APIResource {
 
   /**
    * This endpoint can be used to fetch the upcoming
-   * [invoice](../guides/concepts#invoice) for the current billing period given a
+   * [invoice](/core-concepts#invoice) for the current billing period given a
    * subscription.
    */
   fetchUpcoming(
@@ -139,7 +139,7 @@ export class Invoices extends APIResource {
 export class InvoicesPage extends Page<Invoice> {}
 
 /**
- * An [`Invoice`](../guides/concepts#invoice) is a fundamental billing entity,
+ * An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
  * representing the request for payment for a single subscription. This includes a
  * set of line items, which correspond to prices in the subscription's plan and can
  * represent fixed recurring fees or usage-based fees. They are generated at the
@@ -287,7 +287,7 @@ export interface Invoice {
   customer_tax_id: Invoice.CustomerTaxID | null;
 
   /**
-   * @deprecated: This field is deprecated in favor of `discounts`. If a `discounts`
+   * @deprecated This field is deprecated in favor of `discounts`. If a `discounts`
    * list is provided, the first discount in the list will be returned. If the list
    * is empty, `None` will be returned.
    */
@@ -886,229 +886,8 @@ export namespace Invoice {
      * is serialized differently in a given Price object. The model_type field
      * determines the key for the configuration object that is present.
      *
-     * ## Unit pricing
-     *
-     * With unit pricing, each unit costs a fixed amount.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "unit",
-     *     "unit_config": {
-     *         "unit_amount": "0.50"
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Tiered pricing
-     *
-     * In tiered pricing, the cost of a given unit depends on the tier range that it
-     * falls into, where each tier range is defined by an upper and lower bound. For
-     * example, the first ten units may cost $0.50 each and all units thereafter may
-     * cost $0.10 each.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "tiered",
-     *     "tiered_config": {
-     *         "tiers": [
-     *             {
-     *                 "first_unit": 1,
-     *                 "last_unit": 10,
-     *                 "unit_amount": "0.50"
-     *             },
-     *             {
-     *                 "first_unit": 11,
-     *                 "last_unit": null,
-     *                 "unit_amount": "0.10"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * ```
-     *
-     * ## Bulk pricing
-     *
-     * Bulk pricing applies when the number of units determine the cost of all units.
-     * For example, if you've bought less than 10 units, they may each be $0.50 for a
-     * total of $5.00. Once you've bought more than 10 units, all units may now be
-     * priced at $0.40 (i.e. 101 units total would be $40.40).
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "bulk",
-     *     "bulk_config": {
-     *         "tiers": [
-     *             {
-     *                 "maximum_units": 10,
-     *                 "unit_amount": "0.50"
-     *             },
-     *             {
-     *                 "maximum_units": 1000,
-     *                 "unit_amount": "0.40"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Package pricing
-     *
-     * Package pricing defines the size or granularity of a unit for billing purposes.
-     * For example, if the package size is set to 5, then 4 units will be billed as 5
-     * and 6 units will be billed at 10.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "package",
-     *     "package_config": {
-     *         "package_amount": "0.80",
-     *         "package_size": 10
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## BPS pricing
-     *
-     * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
-     * percent (the number of basis points to charge), as well as a cap per event to
-     * assess. For example, this would allow you to assess a fee of 0.25% on every
-     * payment you process, with a maximum charge of $25 per payment.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "bps",
-     *     "bps_config": {
-     *        "bps": 125,
-     *        "per_unit_maximum": "11.00"
-     *     }
-     *     ...
-     *  }
-     * ```
-     *
-     * ## Bulk BPS pricing
-     *
-     * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
-     * total quantity across all events. Similar to bulk pricing, the BPS parameters of
-     * a given event depends on the tier range that the billing period falls into. Each
-     * tier range is defined by an upper bound. For example, after $1.5M of payment
-     * volume is reached, each individual payment may have a lower cap or a smaller
-     * take-rate.
-     *
-     * ```json
-     *     ...
-     *     "model_type": "bulk_bps",
-     *     "bulk_bps_config": {
-     *         "tiers": [
-     *            {
-     *                 "maximum_amount": "1000000.00",
-     *                 "bps": 125,
-     *                 "per_unit_maximum": "19.00"
-     *            },
-     *           {
-     *                 "maximum_amount": null,
-     *                 "bps": 115,
-     *                 "per_unit_maximum": "4.00"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Tiered BPS pricing
-     *
-     * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
-     * event's applicable parameter is a function of its marginal addition to the
-     * period total. Similar to tiered pricing, the BPS parameters of a given event
-     * depends on the tier range that it falls into, where each tier range is defined
-     * by an upper and lower bound. For example, the first few payments may have a 0.8
-     * BPS take-rate and all payments after a specific volume may incur a take-rate of
-     * 0.5 BPS each.
-     *
-     * ```json
-     *     ...
-     *     "model_type": "tiered_bps",
-     *     "tiered_bps_config": {
-     *         "tiers": [
-     *            {
-     *                 "minimum_amount": "0",
-     *                 "maximum_amount": "1000000.00",
-     *                 "bps": 125,
-     *                 "per_unit_maximum": "19.00"
-     *            },
-     *           {
-     *                 "minimum_amount": "1000000.00",
-     *                 "maximum_amount": null,
-     *                 "bps": 115,
-     *                 "per_unit_maximum": "4.00"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Matrix pricing
-     *
-     * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
-     * `dimensions` defines the two event property values evaluated in this pricing
-     * model. In a one-dimensional matrix, the second value is `null`. Every
-     * configuration has a list of `matrix_values` which give the unit prices for
-     * specified property values. In a one-dimensional matrix, the matrix values will
-     * have `dimension_values` where the second value of the pair is null. If an event
-     * does not match any of the dimension values in the matrix, it will resort to the
-     * `default_unit_amount`.
-     *
-     * ```json
-     * {
-     *     "model_type": "matrix"
-     *     "matrix_config": {
-     *         "default_unit_amount": "3.00",
-     *         "dimensions": [
-     *             "cluster_name",
-     *             "region"
-     *         ],
-     *         "matrix_values": [
-     *             {
-     *                 "dimension_values": [
-     *                     "alpha",
-     *                     "west"
-     *                 ],
-     *                 "unit_amount": "2.00"
-     *             },
-     *             ...
-     *         ]
-     *     }
-     * }
-     * ```
-     *
-     * ## Fixed fees
-     *
-     * Fixed fees are prices that are applied independent of usage quantities, and
-     * follow unit pricing. They also have an additional parameter
-     * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
-     * the quantity of units applied.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "id": "price_id",
-     *     "model_type": "unit",
-     *     "unit_config": {
-     *        "unit_amount": "2.00"
-     *     },
-     *     "fixed_price_quantity": 3.0
-     *     ...
-     * }
-     * ```
+     * For more on the types of prices, see
+     * [the core concepts documentation](/core-concepts#plan-and-price)
      */
     price: PricesAPI.Price | null;
 
@@ -1498,7 +1277,7 @@ export interface InvoiceFetchUpcomingResponse {
   customer_tax_id: InvoiceFetchUpcomingResponse.CustomerTaxID | null;
 
   /**
-   * @deprecated: This field is deprecated in favor of `discounts`. If a `discounts`
+   * @deprecated This field is deprecated in favor of `discounts`. If a `discounts`
    * list is provided, the first discount in the list will be returned. If the list
    * is empty, `None` will be returned.
    */
@@ -2097,229 +1876,8 @@ export namespace InvoiceFetchUpcomingResponse {
      * is serialized differently in a given Price object. The model_type field
      * determines the key for the configuration object that is present.
      *
-     * ## Unit pricing
-     *
-     * With unit pricing, each unit costs a fixed amount.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "unit",
-     *     "unit_config": {
-     *         "unit_amount": "0.50"
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Tiered pricing
-     *
-     * In tiered pricing, the cost of a given unit depends on the tier range that it
-     * falls into, where each tier range is defined by an upper and lower bound. For
-     * example, the first ten units may cost $0.50 each and all units thereafter may
-     * cost $0.10 each.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "tiered",
-     *     "tiered_config": {
-     *         "tiers": [
-     *             {
-     *                 "first_unit": 1,
-     *                 "last_unit": 10,
-     *                 "unit_amount": "0.50"
-     *             },
-     *             {
-     *                 "first_unit": 11,
-     *                 "last_unit": null,
-     *                 "unit_amount": "0.10"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * ```
-     *
-     * ## Bulk pricing
-     *
-     * Bulk pricing applies when the number of units determine the cost of all units.
-     * For example, if you've bought less than 10 units, they may each be $0.50 for a
-     * total of $5.00. Once you've bought more than 10 units, all units may now be
-     * priced at $0.40 (i.e. 101 units total would be $40.40).
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "bulk",
-     *     "bulk_config": {
-     *         "tiers": [
-     *             {
-     *                 "maximum_units": 10,
-     *                 "unit_amount": "0.50"
-     *             },
-     *             {
-     *                 "maximum_units": 1000,
-     *                 "unit_amount": "0.40"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Package pricing
-     *
-     * Package pricing defines the size or granularity of a unit for billing purposes.
-     * For example, if the package size is set to 5, then 4 units will be billed as 5
-     * and 6 units will be billed at 10.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "package",
-     *     "package_config": {
-     *         "package_amount": "0.80",
-     *         "package_size": 10
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## BPS pricing
-     *
-     * BPS pricing specifies a per-event (e.g. per-payment) rate in one hundredth of a
-     * percent (the number of basis points to charge), as well as a cap per event to
-     * assess. For example, this would allow you to assess a fee of 0.25% on every
-     * payment you process, with a maximum charge of $25 per payment.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "model_type": "bps",
-     *     "bps_config": {
-     *        "bps": 125,
-     *        "per_unit_maximum": "11.00"
-     *     }
-     *     ...
-     *  }
-     * ```
-     *
-     * ## Bulk BPS pricing
-     *
-     * Bulk BPS pricing specifies BPS parameters in a tiered manner, dependent on the
-     * total quantity across all events. Similar to bulk pricing, the BPS parameters of
-     * a given event depends on the tier range that the billing period falls into. Each
-     * tier range is defined by an upper bound. For example, after $1.5M of payment
-     * volume is reached, each individual payment may have a lower cap or a smaller
-     * take-rate.
-     *
-     * ```json
-     *     ...
-     *     "model_type": "bulk_bps",
-     *     "bulk_bps_config": {
-     *         "tiers": [
-     *            {
-     *                 "maximum_amount": "1000000.00",
-     *                 "bps": 125,
-     *                 "per_unit_maximum": "19.00"
-     *            },
-     *           {
-     *                 "maximum_amount": null,
-     *                 "bps": 115,
-     *                 "per_unit_maximum": "4.00"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Tiered BPS pricing
-     *
-     * Tiered BPS pricing specifies BPS parameters in a graduated manner, where an
-     * event's applicable parameter is a function of its marginal addition to the
-     * period total. Similar to tiered pricing, the BPS parameters of a given event
-     * depends on the tier range that it falls into, where each tier range is defined
-     * by an upper and lower bound. For example, the first few payments may have a 0.8
-     * BPS take-rate and all payments after a specific volume may incur a take-rate of
-     * 0.5 BPS each.
-     *
-     * ```json
-     *     ...
-     *     "model_type": "tiered_bps",
-     *     "tiered_bps_config": {
-     *         "tiers": [
-     *            {
-     *                 "minimum_amount": "0",
-     *                 "maximum_amount": "1000000.00",
-     *                 "bps": 125,
-     *                 "per_unit_maximum": "19.00"
-     *            },
-     *           {
-     *                 "minimum_amount": "1000000.00",
-     *                 "maximum_amount": null,
-     *                 "bps": 115,
-     *                 "per_unit_maximum": "4.00"
-     *             }
-     *         ]
-     *     }
-     *     ...
-     * }
-     * ```
-     *
-     * ## Matrix pricing
-     *
-     * Matrix pricing defines a set of unit prices in a one or two-dimensional matrix.
-     * `dimensions` defines the two event property values evaluated in this pricing
-     * model. In a one-dimensional matrix, the second value is `null`. Every
-     * configuration has a list of `matrix_values` which give the unit prices for
-     * specified property values. In a one-dimensional matrix, the matrix values will
-     * have `dimension_values` where the second value of the pair is null. If an event
-     * does not match any of the dimension values in the matrix, it will resort to the
-     * `default_unit_amount`.
-     *
-     * ```json
-     * {
-     *     "model_type": "matrix"
-     *     "matrix_config": {
-     *         "default_unit_amount": "3.00",
-     *         "dimensions": [
-     *             "cluster_name",
-     *             "region"
-     *         ],
-     *         "matrix_values": [
-     *             {
-     *                 "dimension_values": [
-     *                     "alpha",
-     *                     "west"
-     *                 ],
-     *                 "unit_amount": "2.00"
-     *             },
-     *             ...
-     *         ]
-     *     }
-     * }
-     * ```
-     *
-     * ## Fixed fees
-     *
-     * Fixed fees are prices that are applied independent of usage quantities, and
-     * follow unit pricing. They also have an additional parameter
-     * `fixed_price_quantity`. If the Price represents a fixed cost, this represents
-     * the quantity of units applied.
-     *
-     * ```json
-     * {
-     *     ...
-     *     "id": "price_id",
-     *     "model_type": "unit",
-     *     "unit_config": {
-     *        "unit_amount": "2.00"
-     *     },
-     *     "fixed_price_quantity": 3.0
-     *     ...
-     * }
-     * ```
+     * For more on the types of prices, see
+     * [the core concepts documentation](/core-concepts#plan-and-price)
      */
     price: PricesAPI.Price | null;
 

package/src/resources/items.ts

@@ -7,7 +7,7 @@ import { Page, type PageParams } from '../pagination';
 
 export class Items extends APIResource {
   /**
-   * This endpoint is used to create an [Item](../guides/concepts#item).
+   * This endpoint is used to create an [Item](/core-concepts#item).
    */
   create(body: ItemCreateParams, options?: Core.RequestOptions): Core.APIPromise<Item> {
     return this._client.post('/items', { body, ...options });

package/src/resources/metrics.ts

@@ -8,9 +8,8 @@ import { Page, type PageParams } from '../pagination';
 
 export class Metrics extends APIResource {
   /**
-   * This endpoint is used to create a [metric](../guides/concepts##metric) using a
-   * SQL string. See
-   * [SQL support](../guides/extensibility/advanced-metrics#sql-support) for a
+   * This endpoint is used to create a [metric](/core-concepts###metric) using a SQL
+   * string. See [SQL support](/extensibility/advanced-metrics#sql-support) for a
    * description of constructing SQL queries with examples.
    */
   create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<BillableMetric> {
@@ -31,9 +30,9 @@ export class Metrics extends APIResource {
   }
 
   /**
-   * This endpoint is used to fetch [metric](../guides/concepts#metric) details given
-   * a metric identifier. It returns information about the metrics including its
-   * name, description, and item.
+   * This endpoint is used to fetch [metric](/core-concepts##metric) details given a
+   * metric identifier. It returns information about the metrics including its name,
+   * description, and item.
    */
   list(
     query?: MetricListParams,
@@ -51,7 +50,7 @@ export class Metrics extends APIResource {
   }
 
   /**
-   * This endpoint is used to list [metrics](../guides/concepts##metric). It returns
+   * This endpoint is used to list [metrics](/core-concepts#metric). It returns
    * information about the metrics including its name, description, and item.
    */
   fetch(metricId: string, options?: Core.RequestOptions): Core.APIPromise<BillableMetric> {

package/src/resources/plans/external-plan-id.ts

@@ -20,10 +20,10 @@ export class ExternalPlanID extends APIResource {
   }
 
   /**
-   * This endpoint is used to fetch [plan](../guides/concepts##plan-and-price)
-   * details given an external_plan_id 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 an external_plan_id 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.
    *
    * If multiple plans are found to contain the specified external_plan_id, the
    * active plans will take priority over archived ones, and among those, the
@@ -32,10 +32,10 @@ export class ExternalPlanID extends APIResource {
    * ## 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). "
    */
   fetch(externalPlanId: string, options?: Core.RequestOptions): Core.APIPromise<PlansAPI.Plan> {
     return this._client.get(`/plans/external_plan_id/${externalPlanId}`, options);

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 {
@@ -106,7 +106,7 @@ export interface Plan {
   created_at: string;
 
   /**
-   * @deprecated: An ISO 4217 currency string or custom pricing unit (`credits`) for
+   * @deprecated An ISO 4217 currency string or custom pricing unit (`credits`) for
    * this plan's prices.
    */
   currency: string;

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);